> ## 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.

# Everywhere Nika meets you

> The complete map: every install path, IDE, agent, skill, plugin, CI surface, SDK and registry where Nika ships — one page, categorized.

One binary, many doors. This page is the single map of **every surface Nika
ships on** — pick your door, each row links to the exact guide.

> [!NOTE]
>
> The one-liner everywhere: `brew install supernovae-st/tap/nika` — then
> `nika init` teaches whatever agent you run.

## Install paths

| Surface | What you get | Where |
| - | - | - |
| **Homebrew tap** | `brew install supernovae-st/tap/nika` (macOS + Linux) | [Quickstart](https://docs.nika.sh/integrations/quickstart.md) |
| **Release tarballs** | per-platform binaries + `SHA256SUMS` + SLSA provenance (`multiple.intoto.jsonl`): verify before you trust | [Verify a download](https://docs.nika.sh/getting-started/installation.md#verify-a-download) |
| **`install.sh`** | one-command install from the site | [Installation guide](https://docs.nika.sh/getting-started/installation.md) |
| **npm** | `npm install -g @supernovae-st/nika` (Node.js 22+, macOS or glibc Linux): the `nika` command plus the TypeScript SDK; inside a project, `./node_modules/.bin/nika` | [Installation](https://docs.nika.sh/getting-started/installation.md) |
| **Container image** | `docker run --rm ghcr.io/supernovae-st/nika:0.124.3 --version` (linux/amd64 · linux/arm64, entrypoint `nika`); mount a project with `docker run --rm -v "$PWD:/work" -w /work ghcr.io/supernovae-st/nika:0.124.3 check flow.nika` | [Installation](https://docs.nika.sh/getting-started/installation.md) |
| **cargo binstall** | the prebuilt release tarball, no compile (`cargo binstall --git https://github.com/supernovae-st/nika nika-cli`) | [Installation](https://docs.nika.sh/getting-started/installation.md) |
| **nix flake** | `nix run github:supernovae-st/nika/v0.124.3` builds that release tag, store-cached (the bare `github:supernovae-st/nika` builds `main`, which can be ahead of the release) | [Installation](https://docs.nika.sh/getting-started/installation.md) |
| **GitHub CLI extension** | `gh extension install supernovae-st/gh-nika` → `gh nika check/run` — pass-through to a PATH `nika`, else a one-time checksum-verified release fetch (Actions runners · Codespaces) | [gh-nika](https://github.com/supernovae-st/gh-nika) |
| **MCP oracle Dockerfile (kit)** | the read-only oracle in a container you build (`integrations/mcp/Dockerfile` in the kit) | [nika-plugins kit](https://github.com/supernovae-st/nika-plugins) |

## Keeping the suite fresh

Every surface below invokes the **binary**, and the plugin kits ride its
release train — but no surface updates another: brew never touches a
plugin, a marketplace never touches the binary. The ladder, per surface:

| Surface | Update gesture | Note |
| - | - | - |
| **Binary** | `brew upgrade nika` | patch releases ship binary-only |
| **Claude Code plugin** | `claude plugin marketplace update nika` **then** `claude plugin update nika@nika` | TWO rungs — the clone, then the install; restart after |
| **Codex plugin** | `codex plugin marketplace upgrade nika` | the per-version cache refreshes on your next run |
| **Cursor** | marketplace installs self-manage; a local drop re-syncs via the kit's `scripts/update-mirrors.sh` | — |
| **Every surface at once** | `scripts/update-mirrors.sh` in a [nika-plugins](https://github.com/supernovae-st/nika-plugins) checkout | `--check` reports drift read-only (CI-able) |

> [!NOTE]
>
> `nika doctor` is the coherence oracle: from v0.107 it reads what each
> client actually loads, names any kit lagging or leading the binary's
> train, and prints the exact per-client fix. Drift is advisory
> (warn · exit 0) — a diagnosis never breaks automation.

## IDEs & editors

| Surface | Mechanism | Where |
| - | - | - |
| **Any LSP editor** | `nika lsp`, the language server built into the binary and the editor path qualified with 0.124 (hover · completion · diagnostics · quick fixes) | [Editors guide](https://docs.nika.sh/getting-started/editors.md) |
| **VS Code** | `nika wire vscode` for the MCP oracle. The editor extension, frozen at 0.120 and not qualified with 0.124: use `nika lsp` and the JSON Schema ([Marketplace listing](https://marketplace.visualstudio.com/items?itemName=supernovae.nika) · [known limits](https://docs.nika.sh/changelog/known-limits.md)) | [VS Code / Copilot guide](https://docs.nika.sh/integrations/clients/vscode.md) |
| **Cursor** | marketplace plugin (skill · subagent · commands · check-on-edit hook · MCP, one Add) + `nika wire cursor` + `nika init` (`.cursor/rules` + `.cursor/mcp.json`) | [Cursor guide](https://docs.nika.sh/integrations/clients/cursor.md) |
| **Windsurf** | `nika wire windsurf` | [Windsurf guide](https://docs.nika.sh/integrations/clients/windsurf.md) |
| **Zed** | `nika wire zed` (0.99+) | [Zed guide](https://docs.nika.sh/integrations/clients/zed.md) |
| **JetBrains (Junie)** | project-scope `.junie/mcp/mcp.json` stanza | [Junie guide](https://docs.nika.sh/integrations/clients/junie.md) |
| **Cursor forks / VSCodium** | The editor extension, frozen at 0.120 and not qualified with 0.124: use `nika lsp` and the JSON Schema ([OpenVSX listing](https://open-vsx.org/extension/supernovae/nika)) | — |
| **Antigravity · Kiro** | `nika wire antigravity` · `nika wire kiro` write the MCP stanza | [MCP clients](https://docs.nika.sh/integrations/mcp-clients.md) |
| **LM Studio** | `nika wire lmstudio` writes the MCP stanza | [LM Studio guide](https://docs.nika.sh/integrations/clients/lm-studio.md) |
| **Neovim** | add the `nika` stdio stanza to mcphub.nvim's servers file by hand (covers avante · codecompanion); the mcphub registry listing is pending review | [MCP clients → Neovim](https://docs.nika.sh/integrations/mcp-clients.md#neovim) |
| **Any editor with YAML-LSP** | the `# yaml-language-server: $schema=` modeline `nika init` writes | [Editors guide](https://docs.nika.sh/getting-started/editors.md) |

## Agents & assistants

| Surface | Mechanism | Where |
| - | - | - |
| **Claude Code** | first-party plugin (`.claude-plugin` · the six `/nika:*` commands · 4 skills · 3 subagents) + `nika wire claude` | [Claude Code guide](https://docs.nika.sh/integrations/clients/claude-code.md) |
| **Claude Desktop** | `nika wire claude-desktop` writes the `claude_desktop_config.json` stanza | [Claude Desktop guide](https://docs.nika.sh/integrations/clients/claude-desktop.md) |
| **Codex** | first-party plugin (`.codex-plugin` · same commands) + `nika wire codex` | [Codex guide](https://docs.nika.sh/integrations/clients/codex.md) |
| **Grok Build** | reads the Claude Code kit natively · one marketplace add installs the full plugin (skills · subagents · commands · hooks · oracle) | [Grok Build guide](https://docs.nika.sh/integrations/clients/grok-build.md) |
| **OpenClaude** | its loader reads the Claude Code marketplace layout · `openclaude plugin marketplace add supernovae-st/nika-plugins && openclaude plugin install nika@nika` installs the whole bundle unported | [kit dossier](https://github.com/supernovae-st/nika-plugins/tree/main/integrations/openclaude) |
| **Hermes** | skill pack (`skills/autonomous-ai-agents/nika` · guard-scanned SAFE) | [Hermes guide](https://docs.nika.sh/integrations/hermes.md) |
| **OpenCode** | `opencode.json` MCP stanza + native `.agents/` reading — `nika init` suffices | [OpenCode guide](https://docs.nika.sh/integrations/opencode.md) |
| **goose** | MCP extension stanza + native `AGENTS.md` reading | [goose guide](https://docs.nika.sh/integrations/clients/goose.md) |
| **Gemini CLI · Qwen Code** | `mcpServers` stanza in the user-scope `settings.json` | [Gemini CLI](https://docs.nika.sh/integrations/clients/gemini-cli.md) · [Qwen Code](https://docs.nika.sh/integrations/clients/qwen-code.md) |
| **Kimi Code CLI** | `mcpServers` entry in `~/.kimi-code/mcp.json` + the `.agents/skills` authoring skill discovered natively | [Kimi Code guide](https://docs.nika.sh/integrations/clients/kimi-code.md) |
| **Warp (Oz)** | reads the Claude Code and Codex configs plus the project `.mcp.json` natively — `nika wire claude` or `nika init` opens this door | [MCP clients](https://docs.nika.sh/integrations/mcp-clients.md) |
| **GitHub Copilot CLI** | reads the project `.mcp.json` (cwd up to repo root) and `AGENTS.md` — `nika init` covers both · `nika wire copilot` writes `~/.copilot/mcp-config.json` for the machine level | [MCP clients](https://docs.nika.sh/integrations/mcp-clients.md) |
| **Amp** | reads `AGENTS.md` and the `.agents/skills` dir natively (both written by `nika init`) · `nika wire amp` wires the oracle into `~/.config/amp/settings.json` | [MCP clients](https://docs.nika.sh/integrations/mcp-clients.md) |
| **Cline · Continue** | `cline_mcp_settings.json` (hot-reloaded) · own-file `~/.continue/mcpServers/nika.json` | [Cline](https://docs.nika.sh/integrations/clients/cline.md) · [Continue](https://docs.nika.sh/integrations/clients/continue.md) |
| **Open WebUI · AnythingLLM · Cherry Studio · Jan** | mcpo recipe · generic stdio stanza | [Open WebUI](https://docs.nika.sh/integrations/clients/open-webui.md) · [AnythingLLM](https://docs.nika.sh/integrations/clients/anythingllm.md) · [Cherry Studio](https://docs.nika.sh/integrations/clients/cherry-studio.md) · [Jan](https://docs.nika.sh/integrations/clients/jan.md) |
| **Aider** | no MCP — `AGENTS.md` (written by `nika init`) covers it | [MCP clients → Aider](https://docs.nika.sh/integrations/mcp-clients.md#aider) |
| **Any MCP client** | `nika mcp` over stdio (or Streamable HTTP with `--transport http`) · the kit's `server.json` registry shape and MCP Dockerfile serve directories that list or containerize MCP servers | [MCP clients](https://docs.nika.sh/integrations/mcp-clients.md) |
| **Any AGENTS.md reader** | `nika init` writes `AGENTS.md` with the rest of the agent scaffold: the authoring skill, Cursor rules and subagents, project MCP configs and the Claude Code and Cursor hooks | [What `nika init` writes](https://docs.nika.sh/getting-started/agents#nika-init-teach-the-repo) |

## Skills & plugins (the teaching surfaces)

| Element | What it is | Lives at |
| - | - | - |
| **SKILL.md pack** | the authoring skill (check-before-run law · cost honesty) — installable via `npx skills add supernovae-st/nika-plugins` | [nika-plugins kit](https://github.com/supernovae-st/nika-plugins) |
| **Plugin commands** | the six `/nika:*` commands (check · compile · explain · trace · permits · doctor) mirrored from the engine | kit `.agents/plugins/nika/` |
| **`nika-author` subagent** | routes an intent to a template, fills the `# SLOT:` markers, loops `nika check` until rc=0 — read-only | kit `.agents/plugins/nika/agents/` |
| **Integration kit contract** | « You want to support Nika? Copy this folder » — pinned mirrors, drift-gated in CI | [kit README](https://github.com/supernovae-st/nika-plugins#readme) |

## MCP (the read-only oracle)

`nika mcp` exposes 9 tools — validate, explain, examples, schema, cost — **no
execution, no mutation, by design** ([threat model](https://github.com/supernovae-st/nika-plugins/blob/main/integrations/mcp/THREAT-MODEL.md)).

| Element | Where |
| - | - |
| Full tool reference | [MCP server reference](https://docs.nika.sh/reference/mcp-server.md) |
| Per-client wiring (one dedicated page per client — the matrix) | [MCP clients](https://docs.nika.sh/integrations/mcp-clients.md) |
| `server.json` (registry shape) + Dockerfile + threat model | [kit `integrations/mcp/`](https://github.com/supernovae-st/nika-plugins/tree/main/integrations/mcp) |

## CI/CD

| Element | What it does | Where |
| - | - | - |
| **nika-action** — *plan with receipts* | check verdict · honest cost floor · permits · the DAG, as a sticky PR comment. Static, zero secrets by default | [GitHub Actions guide](https://docs.nika.sh/integrations/github-actions.md) · [repo](https://github.com/supernovae-st/nika-action) |
| **Offline test lane** | `nika test` golden runs on the mock provider — CI with no API key | [Local-first tutorial](https://docs.nika.sh/examples/local-first-daily-brief.md) |

## SDKs & language surfaces

| Element | What it is | Where |
| - | - | - |
| **TypeScript SDK** | `@supernovae-st/nika@0.124.4` — one typed facade (`check` · `compile` · `run` · `run.events()` · `run.result()` · `traceVerify`) · Apache-2.0. `traceVerify` reads existing evidence; it does not seal, rerun, or prove the job was correct. | [SDK overview](https://docs.nika.sh/sdk/overview.md) · [source](https://github.com/supernovae-st/nika-client) |
| **Language spec** | the `.nika` contract — Apache-2.0, runtime-agnostic | [nika-spec](https://github.com/supernovae-st/nika-spec) |
| **Registry** | CI-re-proven workflow artifacts (hash + oracle + engine cert). In 0.124.3 a `registry:owner/name` coordinate is refused (`NIKA-REG-005`: the public index is schema 2, this engine reads schema 1): clone the registry and run `python3 scripts/get.py <name>` (Python 3.11+ with PyYAML), which fetches the pinned bytes and verifies their sha256, then `nika check` the local file | [nika-registry](https://github.com/supernovae-st/nika-registry) · [Known limits](https://docs.nika.sh/changelog/known-limits.md#registry-coordinates-are-refused) |
| **Local inference lane** | `nika model pull <owner/repo[:QUANT]>` downloads a GGUF into `~/.nika/models`, then `nika model serve --model <id>` starts an OpenAI-compatible server on `127.0.0.1:8712` (Qwen3-family models in 0.124.3) that a workflow reaches as `llamacpp/<id>` with `NIKA_LLAMACPP_BASE_URL=http://127.0.0.1:8712` · `list`/`rm` manage the disk | [Local models](https://docs.nika.sh/guides/local-models.md) · [CLI reference](https://docs.nika.sh/reference/cli.md) |

## Where Nika is listed

Marketplaces and directories where you'll find us today — the public
submissions ledger (with pinned descriptions and review cadence) lives in
[`listings.yaml`](https://github.com/supernovae-st/nika-plugins/blob/main/listings.yaml).

* [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=supernovae.nika) · [OpenVSX](https://open-vsx.org/extension/supernovae/nika) — the editor extension, frozen at 0.120 and not qualified with 0.124: use `nika lsp` and the JSON Schema
* [skills.sh](https://skills.sh/supernovae-st/nika-plugins) — the skill pack
* GitHub topics + release feeds — engine · kit · action · docs · spec · client
* Other MCP registries and community catalogs, including submissions still
  under review (the mcphub.nvim registry, for one), are recorded in the ledger
  above, the day each submission goes out.

## Learn the patterns first

New to agentic workflows as a concept?
[agentic-ai-systems](https://github.com/ThibautMelen/agentic-ai-systems)
explains the workflow taxonomy (chaining, routing, parallelization,
orchestrator and workers, evaluator and optimizer) with diagrams. Read it for
the ideas only: the files in its `patterns-as-code` folder use a retired file
suffix and the retired envelope (`nika: v1`, `vars:`), and 0.124.3 refuses
them. For patterns that run, use `nika try`, which lists the
worked path and the jobs and rehearses any of them on the mock model (a step
that fetches still reaches its host), and the
[examples](https://docs.nika.sh/examples/overview.md).

> [!TIP]
>
> Something missing? The kit contract makes adding a surface a folder-copy:
> [`nika-plugins`](https://github.com/supernovae-st/nika-plugins) — and the
> [integration quickstart](https://docs.nika.sh/integrations/quickstart.md) is the 10-minute path.


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