Getting Started

Quick start

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

Add it to your OpenCode config:

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

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

Kompass applies the first matching override in this order:

The preferred location is .opencode/kompass.jsonc.

To start from the published base config:

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

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

For session debugging inside OpenCode:

opencode session list
opencode export <sessionID>

bundled Kompass skills are registered automatically when the plugin loads
shared workflow logic stays in the Kompass package rather than your project repo
project overrides are layered on top of the bundled base config