Package Exports
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (agentxchain) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
agentxchain
CLI for governed multi-agent software delivery.
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
- CLI reference
- Export schema reference
- Adapter reference
- Protocol spec (v6)
- Protocol reference
- Why governed multi-agent delivery matters
Install
npm install -g agentxchainOr run without installing:
npx agentxchain init --governed --dir my-agentxchain-project -yTesting
The CLI currently uses two runners on purpose: a 36-file Vitest coexistence slice for fast feedback and node --test for the full suite.
npm run test:vitest
npm run test:node
npm testnpm run test:vitest: the current 36-file Vitest slicenpm run test:node: full integration, subprocess, and E2E suitenpm test: both runners in sequence; this is the CI requirement today
Duplicate execution remains intentional for the current 36-file slice until a later slice explicitly changes the redundancy model. For watch mode, run npx vitest.
Quick Start
Governed workflow
npx agentxchain init --governed --dir my-agentxchain-project -y
cd my-agentxchain-project
git init
git add -A
git commit -m "initial governed scaffold"
agentxchain status
agentxchain step --role pmThe default governed dev runtime is claude --print with stdin prompt delivery. If your local coding agent uses a different launch contract, set it during scaffold creation:
npx 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:
npx 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 support
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:
npx agentxchain init --governed --template api-service --dir repos/backend -y
npx agentxchain init --governed --template web-app --dir repos/frontend -y
agentxchain multi init
agentxchain multi step --repo backend --role pmSee the multi-repo quickstart for the full cold-start walkthrough.
Migrate a legacy project
agentxchain migrate
agentxchain status
agentxchain stepCommand Sets
Governed
| Command | What it does |
|---|---|
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 protocol |
Run the shipped protocol conformance suite against a target implementation |
dashboard |
Open the local governance dashboard in your browser for repo-local runs or multi-repo coordinator initiatives, including pending gate approvals |
| `plugin install | list |
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 |
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 verify protocol --tier 3 --target .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/Runtime support today
manual: implementedlocal_cli: implementedapi_proxy: implemented for synchronous review-only turns and stages a provider-backed result duringstep
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
- agentxchain.dev
- Quickstart
- CLI reference
- Adapter reference
- Protocol spec (v6)
- GitHub
- Legacy Protocol v3 spec
License
MIT