Editor guide

Run SUMR in your editor.

Install SUMR in VS Code or Cursor when you want Playbook AI resources, Mission delivery context, and Kontract contract checks beside the code.

Open Marketplace Install the CLI

Control center

Keep product context, contracts, and AI assistants aligned.

The editor plugin is the local workspace surface for SUMR. It keeps routine actions close while the detailed CLI pages remain the source for command behavior, flags, and review evidence.

Playbook

Sync AI resources

Refresh generated guidance for Codex, Cursor, and other AI Channels from the source docs your team reviews.

Open sync docs →

Mission

Check delivery context

Read the current Mission state before editing, reviewing contracts, or handing work to an AI assistant.

Open status docs →

Kontract

Keep contracts visible

Inspect OpenAPI and AsyncAPI schemas, then run validation or generation without leaving the editor.

Open Kontract docs →

Install and connect

Start from the Marketplace, then let the CLI do the work.

SUMR does not replace the command line. The panel invokes trusted local workflows through the configured CLI path, so the same Playbook, Mission, and Kontract rules apply in terminal, CI, VS Code, and Cursor.

Install SUMR

Use Marketplace item sumr.sumr-vscode in VS Code or Cursor, then open a repo that contains SUMR configuration.

Open Marketplace →2

Confirm the CLI

The editor runs local workflows through the SUMR CLI. Keep the default _sumr command, or set sumr.cliPath to the command your machine uses.

Install the CLI →3

Open the panel

Run SUMR: Open Panel, then use the sidebar for Playbook, Mission, Kontract, Team, Settings, and Doctor workflows.

Check runtime →

Workflows

Use the panel for fast actions, not hidden behavior.

Project status

Shows whether sumr.yaml is present, when Playbook last synced, and which AI Channels are active.

Playbook sync

Runs full sync, channel-specific sync, and clean actions from the panel or Command Palette.

Mission status

Opens delivery context so implementation stays tied to the current approved Mission state.

Kontract workflows

Runs schema validation and generation for API contracts, event contracts, OpenAPI, and AsyncAPI.

Schema visualizer

Reads the active schema and presents map, index, and card views with paths, channels, operations, components, and warnings.

Team login

Uses native editor authentication and editor secret storage. Tokens are not sent to the webview.

Doctor checks

Runs setup diagnostics before deeper investigation, especially when CLI commands fail early.

CLI bridge

Uses sumr.cliPath for trusted local commands and opens workflow runs in the editor terminal.

Command Palette

Search by the SUMR task.

The Marketplace item exposes product-scoped commands, so keyboard-first users can run the same panel actions directly from VS Code or Cursor.

SUMR: Open Panel

Open the SUMR panel.

SUMR: Playbook: Sync

Sync Playbook resources for the workspace.

SUMR: Playbook: Sync by Channel

Sync one configured AI Channel.

SUMR: Mission: Status

Open the current Mission delivery context.

SUMR: Kontract: Validate

Validate configured schema sources.

SUMR: Kontract: Generate

Generate configured contract outputs.

SUMR: Doctor

Run workspace diagnostics.

SUMR: Team: Login

Start the native editor authentication flow.

SUMR: Team: Current Account

Refresh the current Team session.

Settings

Configure only what your machine needs.

Most teams only adjust sumr.cliPath. Keep automatic sync disabled until your repo has a trusted Playbook setup.

sumr.cliPath_sumr

Command or path the editor uses to run the SUMR CLI.

sumr.authStageAuto

sumr.autoSyncOnOpenfalse

Run Playbook sync automatically when a trusted workspace opens.

sumr.showStatusBartrue

Show the SUMR quick-action status bar item.

sumr.enableRegionHighlighttrue

Highlight //#region and //#endregion blocks with a subtle editor tint.

Discovery

Built for contract-first AI workflows.

Use SUMR when your team needs editor-native support for product engineering, contracts, and AI assistant workflows that already run through the SUMR CLI.

OpenAPI
AsyncAPI
API contracts
event contracts
AI agents
agent workflows
Playbook
Mission
Kontract
SUMR CLI