agentxchain
v2.155.73
Published
CLI for AgentXchain — governed multi-agent software delivery
Maintainers
Readme
agentxchain
CLI for governed multi-agent software delivery.
AgentXchain coordinates multiple AI agents — PM, developer, QA, architect, and any custom roles — to work together on a codebase with built-in governance: structured turns, mandatory challenge between agents, phase gates, human approvals, and an append-only audit trail. Think of it as the operating system for AI software teams.
The canonical mode is governed delivery: orchestrator-owned state, structured turn results, phase gates, mandatory challenge, and explicit human approvals where required.
Legacy IDE-window coordination is still shipped as a compatibility mode for teams that want lock-based handoff in Cursor, VS Code, or Claude Code.
Docs
- Quickstart
- Getting Started
- CLI reference
- Lights-Out Scheduling
- Templates
- Automation Patterns
- Export schema reference
- Adapter reference
- Protocol v7
- Protocol reference
- Build your own runner
- Why governed multi-agent delivery matters
Try It Now
See governance before you scaffold a real repo:
npx --yes -p agentxchain@latest -c "agentxchain demo"Requires Node.js 18.17+ or 20.5+ and git. The demo creates a temporary governed repo, runs a full PM -> Dev -> QA lifecycle through the real runner interface, shows gates/decisions/objections, and removes the temp workspace when finished. No API keys, config edits, or manual turn authoring required.
Install
npm install -g agentxchain
agentxchain --versionOr via Homebrew (macOS/Linux):
brew tap shivamtiwari93/tap
brew install agentxchainFor a zero-install one-off command, use the package-bound form:
npx --yes -p agentxchain@latest -c "agentxchain demo"Testing
The CLI test suite runs under Vitest. Test files import Vitest directly, and npm test is the single CI contract.
npm test
npm run test:watchnpm test: full Vitest suite, including integration, subprocess, E2E, and beta scenario coveragenpm run test:watch: Vitest watch mode for local TDD
Quick Start
Governed workflow
Run agentxchain init --governed for the guided scaffold. Use the explicit non-interactive form below for scripts, CI, or copy-paste onboarding:
agentxchain init --governed --goal "Build an API change planner for release teams" --dir my-agentxchain-project -y
cd my-agentxchain-project
git init
agentxchain template validate
agentxchain doctor
git add -A
git commit -m "initial governed scaffold"
agentxchain status
agentxchain step --role pmIf you skipped --goal during scaffold, run agentxchain config --set project.goal "Build an API change planner for release teams" before the first governed turn instead of re-running init in place.
The default governed dev runtime is claude --print --dangerously-skip-permissions --bare with stdin prompt delivery. The non-interactive governed path needs write access and env-based auth, so do not pretend plain claude --print is sufficient for unattended implementation turns. If your local coding agent uses a different launch contract, set it during scaffold creation:
agentxchain init --governed --dir my-agentxchain-project --dev-command ./scripts/dev-agent.sh --dev-prompt-transport dispatch_bundle_only -yIf you want template-specific planning artifacts from day one:
agentxchain init --governed --template api-service --dir my-agentxchain-project -yBuilt-in governed templates:
generic: baseline governed scaffoldapi-service: API contract, operational readiness, error budgetcli-tool: command surface, platform support, distribution checklistlibrary: public API, compatibility policy, release and adoption checklistweb-app: user flows, UI acceptance, browser supportfull-local-cli: human-gated automation pattern with PM, Dev, QA, and Director all on authoritativelocal_clienterprise-app: enterprise planning artifacts plus blueprint-backedarchitectandsecurity_reviewerphases
Inspect the shipped template surfaces instead of inferring them from docs:
agentxchain template list
agentxchain template list --phase-templatestemplate list enumerates governed project templates. template list --phase-templates enumerates the reusable workflow-kit phase-template bundles you can reference from workflow_kit.phases.<phase>.template.
step writes a turn-scoped bundle under .agentxchain/dispatch/turns/<turn_id>/ and expects a staged result at .agentxchain/staging/<turn_id>/turn-result.json. Typical continuation:
agentxchain validate --mode turn
agentxchain accept-turn
agentxchain approve-transition
agentxchain step --role dev
agentxchain step --role qa
agentxchain approve-completionDefault governed scaffolding configures QA as api_proxy with ANTHROPIC_API_KEY. For a provider-free walkthrough, switch the QA runtime to manual before the QA step. If you override the dev runtime, either include {prompt} for argv delivery or set --dev-prompt-transport explicitly.
Multi-repo coordination
For initiatives spanning multiple governed repos, use the coordinator to add cross-repo sequencing and shared gates:
agentxchain init --governed --template api-service --dir repos/backend -y
agentxchain init --governed --template web-app --dir repos/frontend -y
agentxchain multi init
agentxchain multi step --jsonIf the coordinator enters blocked, fix the cause and run agentxchain multi resume before continuing with multi step or multi approve-gate. See the multi-repo quickstart for the full cold-start walkthrough.
Migrate a legacy project
agentxchain migrate
agentxchain status
agentxchain stepCommand Sets
Governed lifecycle and execution
| Command | What it does |
|---|---|
| demo | Run a temporary PM -> Dev -> QA governed lifecycle demo with real gates, decisions, and objections |
| init --governed [--dir <path>] [--template <id>] | Create a governed project, optionally in-place or in an explicit target directory, with project-shape-specific planning artifacts |
| migrate | Convert a legacy v3 project to governed format |
| status | Show current run, template, phase, turn, and approval state |
| resume | Initialize or continue a governed run and assign the next turn |
| step | Run one governed turn end to end or resume an active turn |
| accept-turn | Accept the staged governed turn result |
| reject-turn | Reject the staged result, retry, or reassign |
| approve-transition | Approve a pending human-gated phase transition |
| approve-completion | Approve a pending human-gated run completion |
| validate | Validate governed kickoff wiring, a staged turn, or both |
| template validate | Prove the template registry, workflow-kit scaffold contract, and planning artifact completeness (--json exposes a workflow_kit block) |
| verify turn | Replay a staged turn's declared machine-evidence commands to confirm reproducibility before acceptance |
| replay turn | Replay an accepted turn's machine-evidence commands from history for audit and drift detection |
| conformance check | Preferred front door for the shipped protocol conformance suite |
| verify protocol | Compatibility alias for the shipped protocol conformance suite |
| dashboard | Open the live local governance dashboard in your browser for the current repo/workspace or multi-repo coordinator initiative, including pending gate approvals |
| run [--auto-approve] [--max-turns N] [--dry-run] | Drive a governed run from start to completion — dispatches turns, handles gates, manages rejection/retry |
Governed proof and inspection
| Command | What it does |
|---|---|
| audit [--format json] | Live governance audit report for the current repo/workspace with cost summary, decision history, and artifact inventory |
| diff <left> <right> | Compare two governed runs side by side (phase, decisions, artifacts, timing) |
| report | Generate a governance report from a verified export artifact (--input <path> or stdin) |
| replay export <export-file> | Open an existing verified export artifact in the read-only dashboard for offline post-mortem inspection |
| events [--type <type>] [--limit N] | Inspect the lifecycle event stream (turns, phases, gates, governance events) |
| history [--limit N] [--role <role>] | Query accepted-turn history from append-only JSONL |
| role list\|show | List all configured roles or inspect a single role's charter, runtime, and phase assignment |
| turn show | Inspect the active turn in detail (assignment, artifacts, timing, verification) |
| phase list\|show | List configured phases or inspect a single phase's gate requirements and state |
| gate list\|show [--evaluate] | List configured gates or evaluate a gate's current pass/fail state |
| doctor [--json] | Governed project health check: config, roles, runtimes, state, schedules, plugins, workflow-kit, connector handoff |
| connector check [--json] | Live health probes for all configured connectors (api_proxy, remote_agent, MCP stdio/streamable_http) |
Partial coordinator artifacts are first-class here too: audit and report keep repo rows plus repo_ok_count / repo_error_count export-health totals when a child export fails, and they do not fabricate child drill-down for the failed repo.
Governed automation, plugins, and continuity
| Command | What it does |
|---|---|
| multi init\|status\|step\|resume\|approve-gate\|resync | Run the multi-repo coordinator lifecycle, including blocked-state recovery via multi resume |
| intake record\|triage\|approve\|plan\|start\|scan\|resolve | Continuous-delivery intake: turn delivery signals into governed work items |
| intake handoff | Bridge a planned intake intent to a coordinator workstream for multi-repo execution |
| watch --event-file\|--event-dir\|--listen\|--results\|--result | Normalize external events into governed intake, poll event-file directories, receive signed HTTP webhooks, and inspect durable watch result records |
| schedule list\|run-due\|daemon\|status | Run repo-local lights-out scheduling: inspect schedules, execute due runs, poll in a local daemon loop, continue explicitly unblocked schedule-owned runs, or check daemon heartbeat |
| plugin install\|list\|remove | Install, inspect, or remove governed hook plugins under .agentxchain/plugins/ |
| plugin list-available | List bundled built-in plugins installable by short name |
| export [--output <path>] | Export the portable raw governed/coordinator artifact for continuity or offline review |
| restore --input <path> | Restore run state from a prior export on a same-repo, same-commit checkout |
| restart | Rebuild lost session context from .agentxchain/session.json |
dashboard and audit read the live current repo/workspace. report --input and replay export read an existing verified export artifact instead: report renders a derived summary, while replay export opens the read-only dashboard. Partial coordinator artifacts remain first-class here too: report and replay export keep repo rows plus repo_ok_count / repo_error_count export-health totals when a child export fails, and they do not fabricate child drill-down for the failed repo.
Shared utilities
| Command | What it does |
|---|---|
| config | View or edit project configuration |
| update | Update the CLI from npm |
Legacy v3 compatibility
| Command | What it does |
|---|---|
| init | Create a legacy project folder |
| start | Launch legacy agents in IDE sessions |
| kickoff | Guided PM-first legacy setup flow |
| watch | Referee loop for legacy lock-based handoff |
| supervise | Run watch plus optional macOS auto-nudge |
| claim / release | Human override of legacy lock ownership |
| rebind | Rebuild Cursor bindings |
| generate | Regenerate VS Code agent files; use generate planning to restore scaffold-owned governed planning docs |
| branch | Manage Cursor branch override for launches |
| doctor | Check local environment and setup |
| stop | Stop watch daemon and local sessions |
Governed Flow
agentxchain stepinitializes or resumes the run if needed.- It assigns the next role for the current phase.
- It writes
.agentxchain/dispatch/turns/<turn_id>/. - The assigned role writes
.agentxchain/staging/<turn_id>/turn-result.json. - The orchestrator validates and either accepts, rejects, advances phase, pauses for approval, or completes the run.
Protocol Conformance
AgentXchain ships a conformance kit under .agentxchain-conformance/. Use it to prove a runner or fork still implements the governed workflow contract:
agentxchain conformance check --tier 3 --target .agentxchain verify protocol remains available as a compatibility alias.
Useful flags:
--tier 1|2|3: maximum conformance tier to verify--surface <name>: isolate one surface such asstate_machine,dispatch_manifest, orcoordinator--format json: emit a machine-readable report for CI--target <path>: point at the root containing.agentxchain-conformance/capabilities.json
Important governed files:
agentxchain.json
.agentxchain/state.json
.agentxchain/history.jsonl
.agentxchain/decision-ledger.jsonl
.agentxchain/dispatch/turns/<turn_id>/
.agentxchain/staging/<turn_id>/turn-result.json
TALK.md
.planning/
The first-party governed workflow kit includes `.planning/SYSTEM_SPEC.md` alongside `PM_SIGNOFF.md`, `ROADMAP.md`, `acceptance-matrix.md`, and `ship-verdict.md`. `template validate --json` exposes this under the `workflow_kit` block.Runtime support today
manual: implementedlocal_cli: implementedmcp: implemented for stdio and streamable HTTP tool-contract dispatchapi_proxy: implemented for synchronousreview_onlyandproposedwrite-authority turns; stages a provider-backed result duringstepremote_agent: implemented for governed HTTP request/response dispatch against long-running remote agents
Legacy IDE Mode
Legacy mode is still useful if you specifically want one IDE session per agent and lock-file coordination.
agentxchain start # Cursor (default)
agentxchain start --ide vscode
agentxchain start --ide claude-code
agentxchain kickoff
agentxchain supervise --autonudgeIn this mode, agents hand off through lock.json, state.json, triggers, and TALK.md. For new projects, prefer governed mode unless IDE-window choreography is the goal.
macOS Auto-Nudge
supervise --autonudge is legacy-only and macOS-only.
agentxchain supervise --autonudge
agentxchain supervise --autonudge --sendRequires:
osascriptjq- Accessibility permissions for Terminal and Cursor
Links
License
MIT
