Skip to content

CLI Commands Reference

Session

agentweave init --project "Name"
agentweave activate                        # reconcile agentweave.yml with runtime state
agentweave status                          # show full session status with watchdog state
agentweave summary                         # quick overview for relay decisions
agentweave session register --agent <name> --session <id>   # register pilot agent session

Summary Output

The summary command provides a quick status overview before delegation: - Tasks by status (waiting, in progress, ready for review) - Unread messages per agent - Action items (who to notify, what to review)

Delegation

agentweave quick --to kimi "Task description"       # quick task delegation
agentweave delegate --to kimi "Task description"    # alias for 'quick'
agentweave relay --agent kimi                       # generate relay prompt
agentweave relay --agent minimax --run              # auto-run for claude_proxy agents
agentweave inbox --agent claude                     # check agent inbox

Messages

agentweave msg send --to kimi --subject "Update" --message "Task is done"
agentweave msg read <message_id>           # mark message as read

Agent Runner

Claude Proxy Agents (Minimax, GLM, etc.)

agentweave agent configure minimax                      # use built-in defaults
agentweave agent configure glm                          # use built-in defaults
agentweave agent configure mymodel \                    # custom OpenAI-compatible provider
  --runner claude_proxy \
  --base-url https://api.example.com/v1 \
  --api-key-var MY_MODEL_API_KEY
agentweave agent set-session minimax <session-id>       # register Claude resume ID manually
agentweave agent set-model claude <model-name>          # set model for a runner
agentweave agent set-model codex <model-name>
agentweave agent set-model kimi <model-name>

agentweave switch minimax        # output eval-able export commands
agentweave run --agent minimax   # set env vars + launch Claude with relay prompt

Pilot Mode

agentweave agent configure kimi --pilot                 # enable pilot mode
agentweave agent configure kimi --no-pilot              # disable pilot mode
agentweave session register --agent kimi --session <id> # register session ID

Pilot mode disables auto-triggering, giving you manual control over agent sessions. See Pilot Mode Guide for details.

Tasks

agentweave task create --title "Feature X" --assignee kimi --priority high
agentweave task list
agentweave task show <task_id>
agentweave task update <task_id> --status in_progress
agentweave task update <task_id> --status completed
agentweave task update <task_id> --status approved
agentweave task update <task_id> --status revision_needed --note "Fix X"

Transport

agentweave transport setup --type http --url ... --api-key ... --project-id ...
agentweave transport setup --type git --cluster yourname
agentweave transport status
agentweave transport pull
agentweave transport disable
agentweave hub-heartbeat         # publish agent status to Hub (HTTP transport only)

Hub

agentweave hub start             # start the local Hub container
agentweave hub start --port 8001 # start on a custom port
agentweave hub stop              # stop the local Hub container
agentweave hub status            # show Hub container/API status

Context Management

agentweave sync-context          # regenerate agent files from .agentweave/ai_context.md
agentweave update-template       # generate prompt to update template with new best practices

Yolo Mode

agentweave yolo --agent claude --enable    # allow agent to act without confirmations
agentweave yolo --agent claude --disable   # re-enable confirmation prompts

Human Interaction (Hub only)

agentweave reply --id <question_id> "Your answer"

Watchdog

agentweave start       # start background watchdog
agentweave stop        # stop background watchdog

Logs

agentweave log         # view structured event log
agentweave log -f      # watch log in real-time

Roles

agentweave roles list                          # show all agents and their roles
agentweave roles add <agent> <role_id>         # add a role to an agent
agentweave roles remove <agent> <role_id>      # remove a role from an agent
agentweave roles set <agent> <role1,role2,...> # set multiple roles (replaces existing)
agentweave roles available                     # list available role types

Available roles:

Human-title (developer) roles: tech_lead, architect, backend_dev, frontend_dev, fullstack_dev, qa_engineer, devops_engineer, security_engineer, data_engineer, ml_engineer, technical_writer, code_reviewer, project_manager

AI-native (function-first) roles: coordinator, model_router, explorer, implementer, verifier, guardian, context_keeper

AI-Native Roles

The AI-native roles name an agent by the cognitive function it performs rather than a human job title. They reflect where multi-agent frameworks and research have converged, and they fill gaps the human-title roles don't cover. Both vocabularies are fully supported and can be combined on the same agent.

Role Responsibility
coordinator Orchestrate: decompose the goal, delegate independent workstreams in parallel, aggregate results.
model_router Route each task to the best agent/model by difficulty × capability × cost × latency; prefer a cheap-first cascade; respect human model pins.
explorer Reconnaissance and grounding — investigate code/docs/web and return condensed, cited findings.
implementer Turn a well-specified task into working, tested code (stack-agnostic).
verifier Evidence-gated evaluation against tests and specs — never opinion-driven, never open-ended "reflect and revise".
guardian AI-specific safety review: slopsquatting/hallucinated packages, prompt injection, over-broad scopes, hardcoded secrets.
context_keeper Curate shared/context.md, summarize/compact, and fight context rot over long sessions.

When to prefer AI-native roles: when you want roles that map to what an agent does (orchestrate, route, explore, implement, verify, guard, remember) rather than to a job description — especially for model_router (choose the right model per task) and context_keeper (long-session memory curation), which have no human-title equivalent.

When to prefer human-title roles: when stack- or domain-specific guidance is what matters (e.g. frontend_dev, data_engineer).

You can layer both — for example, an implementer that is also a frontend_dev gets the functional contract and the stack-specific guide.

Multi-Role Examples

# Add backend_dev role to claude (claude already has tech_lead)
agentweave roles add claude backend_dev

# Set multiple roles at once (replaces any existing roles)
agentweave roles set kimi backend_dev,frontend_dev

# Assign AI-native roles
agentweave roles add claude coordinator
agentweave roles set gpt model_router

# Combine an AI-native functional role with a human-title domain add-on
agentweave roles set kimi implementer,frontend_dev

# Remove a specific role
agentweave roles remove claude backend_dev

When an agent has multiple roles, they receive all corresponding role guides at session start.

Jobs (Scheduled Tasks)

# Create a scheduled job
agentweave jobs create \
  --name "Daily Report" \
  --agent claude \
  --message "Generate daily summary" \
  --cron "0 9 * * 1-5" \
  --session-mode new

# Manage jobs
agentweave jobs list                    # list all jobs
agentweave jobs list --agent kimi       # filter by agent
agentweave jobs get <job_id>            # show details and run history
agentweave jobs pause <job_id>          # disable a job
agentweave jobs resume <job_id>         # re-enable a job
agentweave jobs run <job_id>            # run immediately (manual trigger)
agentweave jobs delete <job_id>         # delete a job (--force to skip confirm)

See AI Jobs Guide for detailed usage and examples.

Session Management

# Save a context checkpoint before compacting or handoffs
agentweave checkpoint --agent claude --reason pre_handoff --note "Mid-implementation"

Creates a checkpoint file at .agentweave/shared/checkpoints/<agent>-<timestamp>.md with: - Active tasks at time of checkpoint - Files modified this session - Decisions made with rationale - Next steps for resuming - Blockers and open questions

Diagnostics

agentweave doctor          # check runtime readiness (session, transport, watchdog, agents, Hub)

The doctor command runs structured health checks and reports: - Session state (initialized, principal agent, mode) - Transport configuration (type, URL, connectivity) - Watchdog health (running, PID file) - Agent context files (presence and freshness) - Hub connectivity (API reachability if HTTP transport is active)

Each check reports ok, warn, or error with a short description. Use this before running agentweave activate or when debugging connectivity issues.

Activate

agentweave activate      # idempotent: transport + agents + MCP + watchdog + jobs + context

The activate command is the single entry point for applying your agentweave.yml configuration. It:

  1. Configures HTTP transport (auto-fetches API key from Hub if needed)
  2. Syncs agents from agentweave.yml to session.json
  3. Registers the MCP server
  4. Starts the background watchdog
  5. Syncs scheduled jobs (if defined)
  6. Regenerates agent context files

See Migration Guide and agentweave.yml Reference for details.

MCP

agentweave mcp setup   # register MCP server with all session agents