Skip to content
Kompass Kompass Docs

Getting Started

Prerequisites

  • GitHub CLI (gh) must be installed and authenticated. Kompass uses gh for all GitHub operations (PRs, issues, reviews). Install from cli.github.com and run gh auth login.

Quick start

Kompass currently ships an OpenCode adapter package: @kompassdev/opencode.

Add it to your OpenCode config:

{
  "plugin": ["@kompassdev/opencode"]
}

Optional project config

If you want to customize commands, agents, tools, or defaults for a project, add one project override file.

Kompass applies the first matching override in this order:

  1. .opencode/kompass.jsonc
  2. .opencode/kompass.json
  3. kompass.jsonc
  4. kompass.json

The preferred location is .opencode/kompass.jsonc.

To start from the published base config:

Terminal window
curl -fsSL https://raw.githubusercontent.com/kompassdev/kompass/main/kompass.jsonc -o .opencode/kompass.jsonc

What the override can control

  • shared validation guidance
  • enabled commands and custom templates
  • agent enablement and prompt overrides
  • tool enablement and tool-name remapping
  • component path overrides
  • default base branch and adapter settings

Start using workflows

Once the plugin is installed, you can use commands such as:

  • /ask
  • /dev
  • /review
  • /skill/create
  • /skill/optimize
  • /ticket/plan
  • /pr/create
  • /ship

Debug OpenCode sessions

For session debugging inside OpenCode:

Terminal window
opencode session list
opencode export <sessionID>

What happens automatically

  • shared workflow logic stays in the Kompass package rather than your project repo
  • project overrides are layered on top of the bundled base config

Current adapter support

  • OpenCode: supported now
  • Claude Code: planned, not shipped yet

Next steps