Getting Started

Set up OpenKit and let your AI agents start shipping.

Install

Download the desktop app. It includes a guided setup wizard that walks you through everything — no prerequisites needed.

Download OpenKit

Open the app, point it at your project, and the wizard handles config, port discovery, and integrations. That's it — you're ready to go.

Agent Setup

OpenKit’s agent workflow is driven by Skills. During setup flow, OpenKit enables the bundled work-on-task skill in project skill directories so agents know the expected flow automatically.

Recommended flow:

Initialize your project
Integrate your issue tracker
Let agents run with OpenKit-provided task context and skills
Use hooks for checks and review steps before shipping

If the OpenKit UI is running, agent actions appear in the activity feed in real time.

CLI Reference

OpenKit includes an underlying CLI that powers agent workflows and local automation. The bundled work-on-task skill instructs agents to use these CLI commands for deterministic task resolution, setup, and activity tracking.

The short alias ok is also available and accepts the same commands/options as openkit.

$ openkit [command] [options]

$ ok [command] [options]

`openkit`

Start the server.

$ openkit

$ openkit --no-open

$ openkit --auto-init

Loads config from .openkit/config.json, starts the HTTP server, and opens the UI.

Option	Description
`--no-open`	Start the server without opening the UI
`--auto-init`	Auto-initialize config if none is found (skips prompts)
`--help`, `-h`	Show help
`--version`, `-v`	Show version

`openkit init`

Interactive setup wizard. Creates .openkit/config.json with your project settings.

$ openkit init

Must be run inside a git repository. Auto-detects:

Setting	Detection
Base branch	`origin/main` or `origin/master`
Dev command	From `package.json` scripts
Install command	`pnpm install`, `yarn install`, etc.
Ports	Discovered from running dev server

After setup, both .openkit/config.json and .openkit/.gitignore are staged and ready to commit.

`openkit add [integration]`

Connect an integration. Run without arguments for an interactive picker.

$ openkit add # Interactive picker

$ openkit add github

$ openkit add linear

$ openkit add jira

Integration	What You Need
`github`	GitHub CLI installed and authenticated (`gh auth login`)
`linear`	API key from Linear settings
`jira`	OAuth app or API token from Atlassian

`openkit task [source] [ID...]`

Create worktrees from Jira, Linear, or local issues. Run without arguments for an interactive prompt.

$ openkit task # Interactive

$ openkit task jira TASK-123 # Jira

$ openkit task jira 101 102 103 # Batch

`openkit activity`

Emit workflow activity events for agent/user coordination.

await-input — mark that agent work is waiting for user action
phase — record workflow phase checkpoints
check-flow — validate required workflow checkpoints/hooks
todo — update issue todo checkboxes from terminal flows

$ openkit activity --help

$ openkit activity await-input --message "Need approval for deploy"