Skip to content
Closed
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
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ Kompass keeps AI coding agents on course with token-efficient, composable workfl
- Structured tools keep workflows grounded in repo and GitHub state: `changes_load`, `command_expansion` (resolve a slash command and return the expanded prompt for immediate delegation), `pr_load`, `pr_sync`, `ticket_load`, `ticket_sync`.
- Reusable command-template components live in `packages/core/components/` and are documented in the components reference.

## Prerequisites

- **GitHub CLI** (`gh`) must be installed and authenticated. Kompass uses `gh` for all GitHub operations (PRs, issues, reviews). Install from [cli.github.com](https://cli.github.com/) and run `gh auth login`.

## Installation

For OpenCode, add the adapter package to your config:
Expand Down
6 changes: 5 additions & 1 deletion packages/web/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,18 @@ export default defineConfig({
title: "Kompass Docs",
description: "Guided workflows for AI coding agents.",
favicon: "/kompass-icon.png",
logo: {
src: "./public/kompass-icon.png",
alt: "Kompass",
replacesTitle: false
},
social: {
github: "https://github.com/kompassdev/kompass"
},
customCss: ["./src/styles/starlight.css"],
sidebar: [
"docs",
"docs/getting-started",
"docs/installation",
{
label: "Concepts",
items: ["docs/concepts/modes", "docs/concepts/architecture"]
Expand Down
20 changes: 19 additions & 1 deletion packages/web/src/content/docs/docs/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ title: Getting Started
description: Install Kompass for OpenCode and start using the bundled workflow system.
---

## Prerequisites

- **GitHub CLI** (`gh`) must be installed and authenticated. Kompass uses `gh` for all GitHub operations (PRs, issues, reviews). Install from [cli.github.com](https://cli.github.com/) and run `gh auth login`.

## Quick start

Kompass currently ships an OpenCode adapter package: `@kompassdev/opencode`.
Expand All @@ -15,7 +19,7 @@ Add it to your OpenCode config:
}
```

## Add optional project config
## Optional project config

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

Expand All @@ -34,6 +38,15 @@ To start from the published base config:
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:
Expand All @@ -59,6 +72,11 @@ opencode export <sessionID>
- 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

- Read [`OpenCode`](/docs/adapters/opencode/) for adapter-specific behavior.
Expand Down
3 changes: 1 addition & 2 deletions packages/web/src/content/docs/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,7 @@ Kompass is a shared workflow toolkit for AI coding agents.

## What to read next

- Start with [`Getting Started`](/docs/getting-started/) for the fastest path.
- Use [`Installation`](/docs/installation/) for config setup and override locations.
- Start with [`Getting Started`](/docs/getting-started/) for installation and first steps.
- See [`OpenCode`](/docs/adapters/opencode/) for the current supported adapter.
- Use [`Commands`](/docs/reference/commands/) and [`Tools`](/docs/reference/tools/) as the main reference.
- See [`Workspace Development`](/docs/workspace/development/) if you are contributing to this repo.
47 changes: 0 additions & 47 deletions packages/web/src/content/docs/docs/installation.mdx

This file was deleted.

Loading