kyro-ai
v3.3.0
Published
Portable sprint workflow kit for AI coding agents, with markdown artifacts, adapter guides, and formal debt tracking
Maintainers
Readme
What Kyro AI Does
Kyro AI installs a project-local workflow harness that helps AI coding agents analyze, plan, execute, review, and close software work through repeatable sprint cycles.
It is designed for teams that switch between agents and do not want every agent to relearn the workflow from a giant prompt.
Kyro gives agents:
- a managed core with orchestrator, command, skill, and template instructions
- command-like skills such as
kyro-forge,kyro-status, andkyro-wrap-up - workspace state that tracks installed adapters and future scopes
- human-readable artifacts for roadmaps, phase documents, debt, retros, and re-entry context
- doctor/sync/uninstall commands so setup can be validated instead of guessed
Quick Start
Install Kyro AI into the current project:
npx kyro-ai install --agent opencode,codex --scope workspace --yes
npx kyro-ai doctorUse one agent only if needed:
npx kyro-ai install --agent opencode --scope workspace --yes
npx kyro-ai install --agent codex --scope workspace --yesAfter install, open your agent and invoke the installed Kyro command skill:
kyro-forge auth-refactorOther installed command skills:
kyro-status
kyro-wrap-upIf the host exposes slash commands, the equivalent public command namespace is:
/kyro:forge
/kyro:status
/kyro:wrap-upInstalled Layout
Kyro separates global runtime from project state. Runtime files live in your user-level agents directory; project files keep only state and artifacts.
Global runtime:
~/.agents/
├── kyro/
│ ├── versions/
│ │ └── {version}/
│ │ ├── core/
│ │ │ ├── agents/
│ │ │ ├── config.json
│ │ │ └── WORKFLOW.yaml
│ │ ├── commands/
│ │ ├── skills/
│ │ │ ├── sprint-forge/
│ │ │ └── qa-review/
│ │ ├── KYRO.md
│ │ └── manifest.json
│ └── current -> versions/{version}
└── skills/
├── kyro-forge/SKILL.md
├── kyro-status/SKILL.md
└── kyro-wrap-up/SKILL.mdProject state and artifacts:
<project>/
└── .agents/
└── kyro/
├── kyro.json
└── scopes/
└── {scope}/
├── state.json
├── ROADMAP.md
└── phases/Important invariant: kyro install creates the root project state at .agents/kyro/kyro.json. It does not create .agents/kyro/scopes/{scope}/state.json; scoped state belongs to future scope/forge creation.
Who Invokes Whom
User
↓
kyro / kyro-ai CLI
↓
installs managed core + adapter projections
↓
agent opens the project
↓
agent discovers AGENTS.md and/or ~/.agents/skills
↓
user invokes kyro-forge / kyro-status / kyro-wrap-up
↓
projected skill reads ~/.agents/kyro/current/commands/*.md
↓
orchestrator reads ~/.agents/kyro/current/core/agents/orchestrator.md
↓
sprint-forge skill assets guide the workflow
↓
artifacts are written under <project>/.agents/kyro/scopes/{scope}/The user should not have to explain the workflow in natural language. If an agent cannot discover the installed command skills, that agent needs a better adapter.
CLI Reference
Kyro AI exposes two equivalent bins:
kyro
kyro-aiCommands:
| Command | Purpose |
| ---------------- | ------------------------------------------------------------------ |
| kyro | Open the basic interactive configuration TUI |
| kyro install | Install managed core and selected agent adapters |
| kyro doctor | Validate package health, workspace state, core files, and adapters |
| kyro sync | Refresh managed assets without rewriting unmanaged files |
| kyro uninstall | Remove managed workspace assets |
Common usage:
kyro install --agent opencode,codex --scope workspace --yes
kyro doctor --tokens --artifacts
kyro sync --agent codex --dry-run
kyro uninstall --dry-runSupported install adapters today:
| Adapter | Status | What it installs |
| ---------- | --------------------------------- | --------------------------------------------------------------------- |
| opencode | Implemented | ~/.agents/skills/kyro-* command skill projections |
| codex | Implemented | ~/.agents/skills/kyro-* plus a managed Kyro block in root AGENTS.md |
| claude | Planned for CLI workspace install | Claude plugin remains first-class through .claude-plugin/ |
| cursor | Planned | Not installed by the CLI yet |
There is intentionally no generic adapter. Cross-agent instructions belong in root AGENTS.md; install adapters should target concrete agent capabilities.
Artifact Integrity
Kyro treats the repo as the system of record. Validate and repair the knowledge contract with:
kyro doctor --artifacts
kyro repair --kyro-scope <scope> --yes
kyro scope inspect <scope>repair only rebuilds JSON routing/summaries from existing Markdown evidence; it does not rewrite user-authored Markdown.
Core Workflow
Kyro has three stable workflow intents:
| Intent | Skill / command | What it does |
| ------- | -------------------------------- | --------------------------------------------------------------- |
| Forge | kyro-forge / /kyro:forge | Analyze, plan, execute, review, and close a sprint cycle |
| Status | kyro-status / /kyro:status | Report project progress, roadmap health, and technical debt |
| Wrap-up | kyro-wrap-up / /kyro:wrap-up | Close a session, update handoff context, and preserve learnings |
Forge is routed progressively:
read kyro.json/state.json/index.json
→ choose INIT, plan, execute, review, close, or recover
→ load only the selected mode/helper/template
→ update Markdown evidence plus JSON summariesKyro is intentionally sprint-by-sprint and summary-first. It should not pre-load every roadmap, sprint, helper, and template just to decide the next action.
Architecture
The source package is organized around portable markdown instructions plus a small deterministic CLI:
kyro-ai/
├── src/cli/ # installer, doctor, sync, uninstall, adapters
├── agents/ # orchestrator instruction
├── commands/ # forge, status, wrap-up command definitions
├── skills/
│ ├── sprint-forge/ # main workflow skill and assets
│ └── qa-review/ # senior QA review skill
├── docs/ # architecture, CLI, adapter, and command docs
├── rules/ # reusable operating rules
├── templates/ # context templates
├── .claude-plugin/ # Claude plugin adapter packaging
├── WORKFLOW.yaml
└── config.jsonRuntime contract:
| Layer | Responsibility | | --------------- | ----------------------------------------------------------------------------- | | CLI | Install, sync, uninstall, validate, and project managed files | | Adapter | Translate Kyro into each agent's native/compatible instruction surface | | Projected skill | Give the agent a short command entrypoint without duplicating lifecycle prose | | Orchestrator | Coordinate phases, gates, review, debugging, and handoff | | Sprint Forge skill | Define workflow modes, helpers, templates, and discipline rules | | Artifacts | Persist roadmap, phases, debt, retros, and re-entry context in markdown |
Claude Plugin Support
Claude remains first-class.
The Claude plugin adapter lives in .claude-plugin/ and is shipped with the package. The CLI workspace installer does not replace the Claude plugin; it complements it for agents that need workspace-local command skills and AGENTS.md instructions.
Claude plugin install:
/plugin marketplace add SynapSync/kyro-ai
/plugin install kyro-ai@kyro-aiLocal plugin development:
git clone https://github.com/SynapSync/kyro-ai.git
cd kyro-ai
npm install
npm run build
claude --plugin-dir /path/to/kyro-aiDevelopment
Requirements:
- Node.js 18+
- npm
Useful commands:
npm ci
npm run check
npm run build
npm pack --dry-runnpm run check runs:
- TypeScript typecheck
- package/plugin/workflow version validation
- relative markdown link validation
Release tags publish to npm through GitHub Actions when the tag matches package.json.version:
git tag v3.2.2
git push origin v3.2.2The release workflow expects the repository secret NPM_TOKEN.
Documentation
| Guide | Description |
| ------------------------------------------------ | -------------------------------------------------------- |
| CLI | Installer, doctor, sync, uninstall, and adapter commands |
| Commands Reference | /kyro:* command semantics |
| Architecture | System architecture and data flow |
| Agent Adapters | Adapter setup and host-specific notes |
| Harness Migration | Direction for the multi-agent runtime |
| Getting Started | Introductory workflow guide |
| Rules Guide | Persistent learning rules |
| Context Management | Re-entry prompts and continuity strategy |
| Programmatic Usage | Using Kyro instructions from custom LLM apps |
Philosophy
- Commands over prose — users should invoke workflows, not explain them repeatedly.
- Markdown remains the collaboration layer — humans and agents can inspect the same artifacts.
- The CLI owns deterministic checks — package health should not depend on prompt discipline.
- Adapters are concrete — each supported agent gets the files it actually knows how to use.
- One sprint at a time — each cycle adapts from evidence, retro, and technical debt.
- Claude stays first-class — multi-agent support does not mean retiring the Claude plugin.
