Quickstart

This guide walks you through installing Weave and creating your first configuration. You will install the CLI, initialize a project, and verify your setup.

Prerequisites

Install Bun

If you do not have Bun installed, get it from bun.sh:

curl -fsSL https://bun.sh/install | bash

Verify the installation:

bun --version

Expected output:

1.1.42

Install the Weave CLI

Install the Weave CLI globally:

bun add --global @weaveio/weave-cli@latest

Expected output:

bun add v1.1.42

 installed @weaveio/weave-cli@0.5.0

 1 package installed [2.34s]

Verify the CLI is available:

weave --version

Expected output:

0.5.0

Initialize your project

Create a local Weave configuration:

weave init --scope local --yes

Expected output:

Weave init

  Scope:        local
  Install dir:  /home/user/project/.weave
  Config file:  /home/user/project/.weave/config.weave
  Prompts dir:  /home/user/project/.weave/prompts

✓ Created .weave/config.weave
✓ Created .weave/prompts/

Configuration created successfully.

This creates two items in your project:

.weave/config.weave: Your configuration file
.weave/prompts/: Directory for custom prompt files

Verify your configuration

Run the validator to confirm your configuration is valid:

weave validate

Expected output:

✓ Configuration is valid

  Agents:      8
  Categories:  0
  Workflows:   0
  Disabled:    0
  Log level:   info

Inspect available agents

List the default agents:

weave prompt list

Expected output:

Available agents:

  loom
  pattern
  tapestry
  shuttle
  thread
  spindle
  weft
  warp

Inspect an agent prompt

View the composed prompt for an agent:

weave prompt inspect loom

Expected output:

Agent: loom

# Loom - Primary Coordinator

You are Loom, the primary coordinator agent. You receive user requests
and route them to the appropriate specialist agent based on the nature
of the work.

## Your responsibilities

- Understand the user's intent
- Identify the type of work required
- Route to the appropriate specialist
- Coordinate multi-agent workflows when needed

## Available specialists

- Pattern: Creates structured execution plans
- Tapestry: Drives plan completion by delegating tasks
- Shuttle: Implements bounded work within a domain
- Thread: Gathers evidence from the codebase
- Spindle: Researches external docs and APIs
- Weft: Reviews changes for quality and standards
- Warp: Audits code for security vulnerabilities

...

Next steps

Now that you have a working Weave configuration, choose your harness:

Install for OpenCode - Full workflow support with runtime plugin
Install for Pi - Full workflow support with shipped extension
Install for Claude Code - File materialization without durable workflow runtime

Each harness has different capabilities and installation steps. See the harness-specific guides for detailed instructions.

What you learned

How to install Bun and the Weave CLI
How to initialize a local Weave configuration
How to validate your configuration
How to list and inspect agents
Where to go next for harness-specific setup