Documentation menu
nid manual
nid coordinates terminal coding agents on your machine. Install it, cd into a
repository and run nid: it sets the repository up, asks what your agents should work
on and shows them working. Add review policies and configuration when you need them.
| Guide | What it covers |
|---|---|
| Upgrading from terminid | What terminid update moves for you, the terminid shim, compatibility names, nid migrate, rolling back. |
| Upgrading from pawmux | What pawmux update moves for you, compatibility names, nid migrate, rolling back. |
| Compatibility and upgrades | What on-disk state every release keeps reading, for how long, no downgrades, how it is tested. |
| Getting started | Install, cd repo, nid; your first team, the same with plain commands, start at login, update, uninstall. |
| The terminal app | What bare nid opens: first run, keys, slash commands, permission prompts, the DONE card, nid -p. |
| Concepts and coordination | Groups, sessions, worktrees, the board, reviews, budgets and landing changes. |
| Billing: subscription or API key | Billing modes per agent (subscription, api, auto), API keys with nid auth, what each agent supports. |
| Account usage and limits | Account windows, reset times, observation ages, sources, stale session reports and read-only refresh. |
| Compression settings | Turn token compression of nid traffic, the proxy, terse prompts and project memory on or off (global, group, session) and see the tokens saved. |
| Long-running sessions | Context-window tracking, compaction and handoff rotation, nid rotate. |
| Compression proxy | Experimental local proxy for Claude Code traffic: turning it on, credentials, what changes in a request, proxyTerse, limits. |
| Learnings | nid learn: turn what failed and then worked into AGENTS.md/CLAUDE.md learnings, learn after DONE. |
| Native compression | Content routing, diagnostic preservation, measured token savings, and reversible local originals. |
| Dashboard | The goal box, group and session views, approvals, the command palette, keyboard shortcuts and CLI equivalents. |
| Project memory | Learnings new sessions in a repository start with: automatic promotion from the board, dedupe, nid memory, the dashboard panel. |
| Configuration reference | Every project/user configuration key, defaults, custom agents, notifications and environment settings. |
| Agents and known issues | Built-in drivers, ACP, PTY presets, native takeover and integration limitations. |
| Security model | Permissions, sandboxing, local authentication, secrets and shared files. |
| Troubleshooting | Doctor, logs, recovery, stalls, rate limits and Windows behavior. |
| CLI reference | Command syntax, flags and links to the relevant guides. |
| Development and tests | Source layout, unit/e2e tests, optional browsers and live-agent checks. |
| Building and releasing | Binaries, optional signing/notarization, certificates, Actions and local publishing. |
| Brand | The mark, colours and tokens, type, voice and copy rules for every nid surface. |
| Open source and nid Cloud | What is free forever, what Cloud adds, and what never leaves your machine. |
| Remote access | Design of end-to-end encrypted remote access through a relay: pairing, keys, the secure channel, push, the allowlist and the threat model. |
| Daemon API | Authenticated RPC, event streaming and dashboard transport. |
The repository README is the quick introduction; the guides and the API reference describe the implementation. Open source and nid Cloud explains what this repository contains and what it never will.