Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 29 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Kompass keeps AI coding agents on course with token-efficient, composable workfl

- Commands cover direct work (`/ask`, `/commit`, `/merge`, `/skill/create`, `/skill/optimize`), orchestration (`/dev`, `/ship`, `/todo`, `/pr/fix/loop`), ticket planning/sync, and PR review/shipping flows. `/branch/inline`, `/commit/inline`, `/commit-and-push/inline`, `/pr/create/inline`, and `/ship/inline` reuse the invoking session instead of starting a subtask.
- Agents are intentionally narrow: `worker` handles implementation and multi-step workflows, `planner` is no-edit planning, and `reviewer` is a no-edit review specialist.
- Structured tools keep workflows grounded in repo and GitHub state: `changes_load`, `pr_load`, `pr_load_review`, `pr_sync`, `ticket_load`, `ticket_sync`.
- Structured tools keep workflows grounded in repo and GitHub state: `changes_load`, `pr_load`, `pr_load_review`, `pr_sync`, `ticket_load`, `ticket_sync`. OpenCode users can opt into the eight Navigator session and worktree tools.
- Reusable command-template components live in `packages/core/components/` and are documented in the components reference.

## Prerequisites
Expand Down Expand Up @@ -52,6 +52,34 @@ Kompass loads the bundled base config, then optional home-directory overrides, t

The recommended project override path is `.opencode/kompass.jsonc`.

## Kompass Navigator

Navigator is an OpenCode capability for orchestrating native sessions in the current checkout and OpenCode-managed Git worktrees. It is enabled by default, uses the OpenCode server and SDK directly, returns immediately after admitting prompts, supports parallel sessions, and discovers native sessions and worktrees again after plugin restarts. It requires OpenCode `1.17.12` or newer.

Configure Navigator and its limits with:

```jsonc
{
"adapters": {
"opencode": {
"navigator": {
"enabled": true,
"maxConcurrentSessions": 8,
"maxReadChars": 20000,
"maxOutputCharsPerItem": 4000,
"maxWaitMs": 120000
}
}
}
}
```

The default runtime names are `kompass_worktree_list`, `kompass_session_create`, `kompass_session_list`, `kompass_session_read`, `kompass_session_send`, `kompass_session_wait`, `kompass_session_interrupt`, and `kompass_worktree_remove`. Disable or alias any logical name through `tools`; an alias is registered exactly as configured.

Set `adapters.opencode.navigator.enabled` to `false` to disable all Navigator tools.

Navigator accepts only sessions from the current OpenCode project and only worktrees returned by OpenCode. It rejects self-targeting lifecycle calls, arbitrary directories, main-checkout removal, unmanaged worktrees, and removal while a worktree has active sessions. It never force-removes or automatically cleans up resources after a partial failure.

## Workspace

This repository is the Kompass development workspace.
Expand Down
23 changes: 13 additions & 10 deletions bun.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 15 additions & 0 deletions kompass.jsonc
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,14 @@
"pr_sync": { "enabled": true },
"ticket_load": { "enabled": true },
"ticket_sync": { "enabled": true },
"worktree_list": { "enabled": true },
"session_create": { "enabled": true },
"session_list": { "enabled": true },
"session_read": { "enabled": true },
"session_send": { "enabled": true },
"session_wait": { "enabled": true },
"session_interrupt": { "enabled": true },
"worktree_remove": { "enabled": true },
},

"components": {
Expand All @@ -78,6 +86,13 @@
"adapters": {
"opencode": {
"agentMode": "all",
"navigator": {
"enabled": true,
"maxConcurrentSessions": 8,
"maxReadChars": 20000,
"maxOutputCharsPerItem": 4000,
"maxWaitMs": 120000,
},
},
},
}
45 changes: 44 additions & 1 deletion kompass.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,30 @@
},
"ticket_load": {
"$ref": "#/$defs/toolConfig"
},
"worktree_list": {
"$ref": "#/$defs/toolConfig"
},
"session_create": {
"$ref": "#/$defs/toolConfig"
},
"session_list": {
"$ref": "#/$defs/toolConfig"
},
"session_read": {
"$ref": "#/$defs/toolConfig"
},
"session_send": {
"$ref": "#/$defs/toolConfig"
},
"session_wait": {
"$ref": "#/$defs/toolConfig"
},
"session_interrupt": {
"$ref": "#/$defs/toolConfig"
},
"worktree_remove": {
"$ref": "#/$defs/toolConfig"
}
}
},
Expand Down Expand Up @@ -327,6 +351,17 @@
"agentMode": {
"type": "string",
"enum": ["subagent", "primary", "all"]
},
"navigator": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": { "type": "boolean", "default": true },
"maxConcurrentSessions": { "type": "integer", "minimum": 1, "maximum": 8, "default": 8 },
"maxReadChars": { "type": "integer", "minimum": 1, "default": 20000 },
"maxOutputCharsPerItem": { "type": "integer", "minimum": 1, "default": 4000 },
"maxWaitMs": { "type": "integer", "minimum": 1, "default": 120000 }
}
}
}
}
Expand Down Expand Up @@ -432,7 +467,15 @@
"pr_load_review",
"pr_sync",
"ticket_sync",
"ticket_load"
"ticket_load",
"worktree_list",
"session_create",
"session_list",
"session_read",
"session_send",
"session_wait",
"session_interrupt",
"worktree_remove"
]
}
}
Expand Down
2 changes: 2 additions & 0 deletions packages/core/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ export {
getConfiguredToolNames,
getConfiguredToolName,
getEnabledToolNames,
NAVIGATOR_TOOL_NAMES,
loadKompassConfig,
mergeWithDefaults,
} from "./lib/config.ts";
Expand All @@ -17,6 +18,7 @@ export type {
CommandName,
KompassConfig,
MergedKompassConfig,
NavigatorConfig,
ToolName,
ToolConfig,
} from "./lib/config.ts";
Expand Down
15 changes: 15 additions & 0 deletions packages/core/kompass.jsonc
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,14 @@
"pr_sync": { "enabled": true },
"ticket_load": { "enabled": true },
"ticket_sync": { "enabled": true },
"worktree_list": { "enabled": true },
"session_create": { "enabled": true },
"session_list": { "enabled": true },
"session_read": { "enabled": true },
"session_send": { "enabled": true },
"session_wait": { "enabled": true },
"session_interrupt": { "enabled": true },
"worktree_remove": { "enabled": true },
},

"components": {
Expand All @@ -78,6 +86,13 @@
"adapters": {
"opencode": {
"agentMode": "all",
"navigator": {
"enabled": true,
"maxConcurrentSessions": 8,
"maxReadChars": 20000,
"maxOutputCharsPerItem": 4000,
"maxWaitMs": 120000,
},
},
},
}
Loading
Loading