> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nika.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Integrate Nika in 10 minutes

> Whatever agent you run — Claude Code, Codex, Cursor, OpenCode, Hermes, Zed — two commands teach it Nika, and CI gets receipts.

Nika is not another agent. It is **the workflow file your agents already
run** — checked before, verified after. Integration therefore means two
small things: teach your agent the language, and wire the read-only oracle.

## Minute 0-2 · install the CLI

This 10-minute loop uses the **CLI** (`nika init`, `nika wire`,
`nika compile`). The later commands on this page require a `nika`
binary on `PATH`.

```sh theme={"system"}
brew install supernovae-st/tap/nika    # or: curl -LsSf https://nika.sh/install.sh | sh
nika --version && nika doctor          # doctor prints exact fixes, never mutates
```

No key needed yet — `mock/echo` and local providers run without one.

Driving Nika from Node instead of a shell? That is a different door:
`npm install @supernovae-st/nika@0.124.4` inside a project bundles the
engine for your app and gives you `./node_modules/.bin/nika`, but does not
add `nika` to your `PATH`. Do not type `npx nika` outside such a project:
the unscoped npm name `nika` belongs to an unrelated package. Follow the
[SDK quickstart](https://docs.nika.sh/sdk/start/quickstart.md) (`run()` admits, `run.result()`
settles, `run.events()` yields normalized kinds).

## Minute 2-5 · teach the repo

```sh theme={"system"}
nika init
```

One command writes the agent surface: `AGENTS.md` (read natively by Codex,
Claude Code, Cursor, OpenCode, Hermes, Jules and every AGENTS.md-aware
tool), `CLAUDE.md`, the Cursor rules and subagents, the Copilot
instructions, the repo-level [agent skill](https://agentskills.io), the
`.vscode` schema wiring, a commented `nika.yaml` and a starter workflow. It
also writes project MCP configs (`.mcp.json`, `.cursor/mcp.json`,
`.agents/mcp_config.json`) and Claude Code and Cursor hooks: shell scripts
those clients run at session start, after an edit and before a shell
command. Read them before you commit them
([every file `nika init` writes](https://docs.nika.sh/getting-started/agents#nika-init-teach-the-repo)).
Existing files are skipped.

## Minute 5-7 · wire the oracle

```sh theme={"system"}
nika wire detected --dry-run   # preview what this machine shows
nika wire detected             # or one client: cursor · vscode · claude ·
                               # claude-desktop · codex · gemini · qwen ·
                               # opencode · hermes · zed · continue · cline ·
                               # lmstudio · junie · grok · kimi · antigravity ·
                               # kiro · copilot · amp · windsurf
```

`nika wire --help` lists every target on this binary. Clients with no
target (goose, Open WebUI, AnythingLLM, Cherry Studio, Jan) take the same
two-field stanza — copy it from [per-client wiring](https://docs.nika.sh/integrations/mcp-clients.md).
What the oracle exposes (and refuses to): [Nika as an MCP server](https://docs.nika.sh/reference/mcp-server.md).

## Minute 7-10 · prove the loop

Ask your agent:

> Create a workflow from the `chain` template that summarizes ./notes.md
> into ./out/brief.md, **check it**, then run it with the mock model.

The agent previews (`nika compile chain --json` — incomplete questions
stay questions; no file is written), answers them with repeatable
`--answer KEY=JSON_LITERAL`, writes a Ready destination, audits
(`nika check` — plan, cost floor, permits, **before** any token is
spent), runs on the mock model (`--model mock/echo`: no key, no model
call), and the receipts land in `.nika/traces/` (`nika trace verify` →
exit 0: bare, it reads the latest trace; the run card prints each trace's
path on its `trace:` line).

## Then: CI receipts

Put [the GitHub Action](https://docs.nika.sh/integrations/github-actions.md) on the repo — every PR
that touches a `.nika` gets a sticky comment with the check verdict,
the honest cost floor, required secrets and the DAG. Check-only, zero
secrets, by default.

## The per-tool pages

* [OpenCode](https://docs.nika.sh/integrations/opencode.md) — native skills + AGENTS.md + MCP; zero
  packaging needed.
* [Hermes](https://docs.nika.sh/integrations/hermes.md) — the delegation pattern: Hermes
  orchestrates, Nika runs the repeatable work with receipts.
* [GitHub Actions](https://docs.nika.sh/integrations/github-actions.md) — plan with receipts on
  every PR.
* [Everything MCP-capable](https://docs.nika.sh/integrations/mcp-clients.md) — Cursor · Claude Code
  · Codex · Zed · Gemini CLI · Windsurf · Continue · Cline · Aider, one
  stanza each.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.