Nikcli Docs

Getting Started

A source-of-truth overview of nikcli, generated directly from the codebase in packages/nikcli.

Install & Run

nikcli ships as a CLI with a full TUI experience. The default entrypoint is the TUI command defined in packages/nikcli/src/cli/cmd/tui/thread.ts.

  bash
  
curl -fsSL https://nikcli.store/install | bash

  bash
  
nikcli

Runtime

Local execution uses Bun. The CLI entrypoint is packages/nikcli/src/index.ts.

Interface

All CLI commands are registered in packages/nikcli/src/index.ts. The TUI is powered by a worker model in packages/nikcli/src/cli/cmd/tui/.

Core

Sessions, messages, tool parts, and sharing live under packages/nikcli/src/session/ and packages/nikcli/src/share/.

Execution

Tool registry and permission rules are defined in packages/nikcli/src/tool/ and packages/nikcli/src/permission/.

Services

HTTP + SSE endpoints are built on Hono in packages/nikcli/src/server/ with OpenAPI generation.

Default agents (build, plan) and subagents (general, explore, code-reviewer, etc.) are configured in packages/nikcli/src/agent/agent.ts.

Provider orchestration lives in packages/nikcli/src/provider/ with bundled SDK loaders and model catalogs.

Config resolution merges remote, global, project, and inline sources via packages/nikcli/src/config/config.ts.

Documentation indexing and vector search live in packages/nikcli/src/docs/ and packages/nikcli/src/rag/.

Every page in this docs section links directly to the source files that implement the feature. The full file index is available in Source Map.

Command Surface

All commands, flags, and flows. See CLI Quickstart and CLI Debug.

Server + Infra

Server routes, MCP, LSP, RAG, storage, and diagnostics. See Server & API.

Start here

Configure providers and agents in Configuration, then browse tools in Tools.