✨ Why the SUMR CLI?

Store shared setup beside the code it affects. Developers and AI tools use the same versioned files and repeatable commands.

Use it to:

• create and migrate a project's sumr.yaml configuration;
• generate and validate API contract artifacts with Kontract;
• sync Playbook Documents into supported AI Channels;
• track plans, evidence, reviews, and next actions with Mission.

🚀 Install

The CLI requires Bun 1.1 or later.

bun add -g @sumrco/cli

Confirm the installation and check local requirements:

sumr --help
sumr doctor

⚡ Quick start

Run these commands from your project directory:

# Create sumr.yaml for this project
sumr init

# Check local requirements
sumr doctor

# Explore every command and module
sumr --help

Sign in with sumr login only when a workflow needs SUMR account access.

To inspect a command before it changes files, add --help:

sumr playbook sync --help
sumr kontract generate --help
sumr mission start --help

🧭 Commands

| Command | Purpose | | --- | --- | | sumr login | Sign in to SUMR. | | sumr logout | Sign out of SUMR. | | sumr whoami | Show the currently signed-in user. | | sumr account | Manage the account used by SUMR API requests. | | sumr init | Create a sumr.yaml config for the current project. | | sumr migrate | Apply pending sumr.yaml migrations. | | sumr doctor | Check runtime and tool requirements. | | sumr kontract | Generate and validate API contract artifacts. | | sumr playbook | Sync Playbook Documents into AI tools. | | sumr mission | Track AI-assisted work state and next actions. |

Run sumr <command> --help for usage, options, and examples.

🧩 Modules

Kontract

Generate multiple contract artifacts from API and async API specifications configured in sumr.yaml.

# Generate configured artifacts
sumr kontract generate

# Validate configured specifications
sumr kontract validate

# Activate Kontract guidance for this workspace
sumr kontract init

Playbook

Turn Playbook Documents into instructions and resources for supported AI Channels: Claude, Codex, Cursor, GitHub Copilot, Gemini, and OpenCode.

# Configure Playbook for this project
sumr playbook config

# Validate Documents without writing generated files
sumr playbook validate

# Sync configured AI Channels
sumr playbook sync

Mission

Keep AI-assisted work inspectable with local plans, execution state, evidence, reviews, and explicit next actions.

# Configure Mission for this repository
sumr mission init

# Start or resume work from an issue
sumr mission start <issue-key>

# Show current state and the next action
sumr mission status <issue-key>

Mission records work locally. External writes require explicit commands and gates. Run sumr mission --help to inspect the complete workflow.

📝 Project config

SUMR tools share a versioned sumr.yaml at the project root. Start with:

sumr init

Each module then adds or reads only the configuration it owns. Commit sumr.yaml when your team should share the same setup.

🤖 AI tool resources

The npm package includes public Playbook resources for the shipped modules. Playbook uses these resources when generating guidance for configured AI Channels, so the installed CLI and its AI instructions stay aligned.

ESLint integrations

Install the CLI in a project as a development dependency to use SUMR-owned ESLint integrations. Kontract exposes its composable plugin without choosing the application's parser or ESLint configuration:

import { kontractPlugin } from '@sumrco/cli/eslint';

See the packaged Kontract resources for flat-config wiring and rule options.

Help and links

• Run sumr --help or sumr <command> --help for command documentation.
• Report bugs and request features in the SUMR CLI repository.
• View releases on npm.