https://github.com/kompassdev/kompass
Navigate your way - manual steering, steered autonomy, or autonomously. Kompass keeps AI coding agents on course with token-efficient, composable workflows.
https://github.com/kompassdev/kompass
agent-navigation ai automation autonomous-coding code-review coding-agent developer-tools github kompass steered-autonomy token-efficiency workflow
Last synced: 12 days ago
JSON representation
Navigate your way - manual steering, steered autonomy, or autonomously. Kompass keeps AI coding agents on course with token-efficient, composable workflows.
- Host: GitHub
- URL: https://github.com/kompassdev/kompass
- Owner: kompassdev
- License: mit
- Created: 2026-03-09T16:33:19.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2026-03-28T14:58:40.000Z (16 days ago)
- Last Synced: 2026-03-28T16:57:50.171Z (16 days ago)
- Topics: agent-navigation, ai, automation, autonomous-coding, code-review, coding-agent, developer-tools, github, kompass, steered-autonomy, token-efficiency, workflow
- Language: TypeScript
- Homepage: https://kompassdev.ai/
- Size: 9.98 MB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Agents: AGENTS.md
Awesome Lists containing this project
README
> Kompass is under active development, so workflows, package APIs, and adapter support may keep evolving as the toolkit expands.
Navigate your way - manual steering, steered autonomy, or autonomously.
Kompass keeps AI coding agents on course with token-efficient, composable workflows.
## Docs
- Main docs: https://kompassdev.ai/docs/
- Getting started: https://kompassdev.ai/docs/getting-started/
- OpenCode adapter: https://kompassdev.ai/docs/adapters/opencode/
- Config reference: https://kompassdev.ai/docs/config/overview/
- Command, agent, tool, and component reference: https://kompassdev.ai/docs/reference/commands/, https://kompassdev.ai/docs/reference/agents/, https://kompassdev.ai/docs/reference/tools/, https://kompassdev.ai/docs/reference/components/
## Bundled Surface
- Commands cover direct work (`/ask`, `/commit`, `/merge`), orchestration (`/dev`, `/ship`, `/todo`), ticket planning/sync, and PR review/shipping flows.
- Agents are intentionally narrow: `worker` is generic, `planner` is no-edit planning, `navigator` owns multi-step orchestration, and `reviewer` is a no-edit review specialist.
- Structured tools keep workflows grounded in repo and GitHub state: `changes_load`, `session_command` (resolve a slash command and queue it into the current session), `pr_load`, `pr_sync`, `ticket_load`, `ticket_sync`.
- Reusable command-template components live in `packages/core/components/` and are documented in the components reference.
## Installation
For OpenCode, add the adapter package to your config:
```json
{
"plugin": ["@kompassdev/opencode"]
}
```
Project config is optional. To start from the published base config:
```bash
curl -fsSL https://raw.githubusercontent.com/kompassdev/kompass/main/kompass.jsonc -o .opencode/kompass.jsonc
```
Kompass loads the bundled base config, then optional home-directory overrides, then optional project overrides. In each location it uses the first file that exists from:
- `.opencode/kompass.jsonc`
- `.opencode/kompass.json`
- `kompass.jsonc`
- `kompass.json`
The recommended project override path is `.opencode/kompass.jsonc`.
## Workspace
This repository is the Kompass development workspace.
- `packages/core`: shared workflows, prompts, components, config loading, and tool definitions
- `packages/opencode`: the OpenCode adapter package, published as `@kompassdev/opencode`
- `packages/web`: docs site and web content
- `packages/opencode/.opencode/`: generated OpenCode output for review
When changing Kompass itself, keep runtime definitions, bundled config, schema, docs, and generated output in sync in the same change.