Agents
Preview docs describe unreleased preview builds. Stable docs remain at /docs/.
Nagi is built for running more than one coding agent at a time. Each agent stays in a real terminal pane with its shell, logs, prompts, and running processes intact. Nagi tracks which panes contain agents, rolls their state up to tabs and workspaces, and lets you jump straight to the pane that needs attention instead of polling every terminal by hand.
Supported agents
Section titled “Supported agents”Automatic detection works out of the box for common coding agents. The important difference is not whether Nagi can see an agent. It is which signal is allowed to author idle, working, and blocked.
| Agent | State authority | Integration role |
|---|---|---|
| Pi | lifecycle hooks when installed; otherwise screen manifest | state and session |
| OMP | lifecycle hooks when installed | state |
| GitHub Copilot CLI | screen manifest | session |
| Devin CLI | screen manifest | session |
| Kimi Code CLI | lifecycle hooks when installed; otherwise screen manifest | state and session |
| Hermes Agent | lifecycle hooks when installed; otherwise screen manifest | state and session |
| Qoder CLI | screen manifest | session |
| Droid | screen manifest | session |
| OpenCode | lifecycle plugin when installed; otherwise screen manifest | state and session |
| Kilo Code CLI | lifecycle plugin when installed; otherwise screen manifest | state and session |
| MastraCode | lifecycle hooks when installed | state and session |
| Claude Code | screen manifest | session |
| Codex | screen manifest | session |
| Cursor Agent CLI | screen manifest | session |
| Amp | screen manifest | none |
| Grok CLI | screen manifest | none |
| Antigravity CLI | screen manifest | none |
| Kiro CLI | screen manifest | none |
| Maki | screen manifest | none |
Detected but less thoroughly tested: Gemini CLI and Cline. Unsupported agents still run normally as terminal processes. They just may not get rich state unless you add an integration or report state over the socket API.
Status authority
Section titled “Status authority”Nagi first detects the foreground process in each pane. After that, each pane has one status authority.
For agents with complete lifecycle hooks, the integration is authoritative when it is installed and actively reporting for the running pane. Nagi uses those hook reports for idle, working, blocked, and session identity. It does not also run screen manifest fallback for that same lifecycle authority. This avoids two competing sources of truth.
For agents without complete lifecycle hooks, Nagi identifies the foreground process and reads the live bottom-buffer screen snapshot. It evaluates TOML manifests against that snapshot to classify idle, working, and blocked. For agents that emit them, manifests can also match terminal title and progress (OSC) sequences as detection evidence; when that evidence is absent, screen rules carry detection on their own.
The screen snapshot comes from the recent bottom of the pane buffer, not the scrolled viewport. If you scroll back in Nagi, detection still follows the live agent UI at the bottom.
Claude Code, Codex, GitHub Copilot CLI, Droid, Qoder CLI, and Cursor Agent CLI integrations are intentionally not lifecycle authorities. They provide native session identity for restore, but their hooks do not cover the whole lifecycle. They can miss permission approval results, escape interrupts, or other transitions. For those agents, Nagi still uses screen manifest detection.
VMs and sandbox wrappers
Section titled “VMs and sandbox wrappers”On Linux, wrappers such as VMs, Bubblewrap, or fence can hide the real agent process from host /proc. Set NAGI_AGENT=<agent> on the command, for example NAGI_AGENT=claude fence -- claude, to tell Nagi which existing agent screen manifest to use. The hint is scoped to that foreground process; avoid exporting it globally from your shell unless every inherited foreground process should be treated as that agent.
Blocked state
Section titled “Blocked state”Blocked detection is deliberately strict for screen-manifest agents. Nagi only marks blocked when the live bottom-buffer snapshot matches known visible approval, question, or permission UI. If no manifest rule matches for a known agent, Nagi falls back to idle and labels that fallback as default_known_agent_idle_fallback in explain output.
This means unusual new agent prompts may initially show as idle instead of blocked until Nagi learns that screen shape. Those interactions should not make Nagi send input or take destructive action; they only affect the visible status and waits.
Detection manifests
Section titled “Detection manifests”Bundled manifests live inside Nagi. Remote manifest updates inherited from upstream are disabled until Nagi publishes and verifies its own update source. Local overrides still apply.
Local overrides can replace a remote or bundled manifest from the platform config directory:
~/.config/nagi/agent-detection/<agent>.tomlLocal overrides always win. Without a local override, Nagi uses the newer compatible manifest between the cached remote manifest and the bundled manifest in the running binary. On debug builds, the same config helper may use a development directory such as nagi-dev. Invalid override files are ignored with a warning and Nagi falls back to the cached remote or bundled manifest for that agent.
Remote manifests patch detection rules for agents Nagi already knows how to identify. Adding a completely new agent still requires a Nagi binary update for process detection, labels, and integration behavior.
The running server loads active manifests into memory on startup. Automatic remote manifest updates reload that in-memory cache after new rules are written. Run nagi server update-agent-manifests to fetch remote manifest updates immediately and reload the running server. After editing a local override manually, restart Nagi or run nagi server reload-agent-manifests to apply the file to the running server.
Use nagi agent explain when a pane shows the wrong state:
nagi agent explain <target>nagi agent explain --file screen.txt --agent codex --jsonLive explain is evaluated by the running server, so it reflects the active manifest cache. The explain output shows the agent, final state, whether screen detection was skipped by a full lifecycle authority, manifest source and version, cached remote version, local override shadowing, remote update status, matched rule, visible evidence flags, matcher and region evidence for evaluated rules, skipped-update reason for transcript viewers, and the idle fallback reason when no rule matched.
Nagi can run inside tmux as the outer terminal environment. Agent detection does not inspect tmux sessions launched inside a Nagi pane. If a shell framework auto-enters tmux inside Nagi, Nagi sees tmux as the pane process instead of the agent behind it.
State rollups
Section titled “State rollups”The sidebar rolls state upward.
A blocked agent makes its pane, tab, and workspace look blocked. A working agent makes the workspace look active. A done agent stays visible until you view it.
This is the main Nagi workflow: start several agents, let them work in parallel, and use the sidebar to see which project needs a decision, which one is still running, and which one is ready to review.
Direct integrations
Section titled “Direct integrations”Install the integration for each agent you use; it gives Nagi hook or plugin reports instead of screen detection alone:
nagi integration install claudenagi integration statusEach supported agent has its own integration name and behavior. See Integrations for the per-agent details and the full install list.
Custom agent labels
Section titled “Custom agent labels”You can rename an agent target for display:
nagi agent rename w1:p1 reviewernagi agent rename reviewer --clearTargets accept terminal IDs, unique agent names, detected or reported agent labels, and legacy pane IDs.
Custom status labels
Section titled “Custom status labels”Integrations report lifecycle state as semantic state only. Add display customization separately with pane metadata tokens.
nagi pane report-agent w1:p1 \ --source custom:indexer \ --agent docs-bot \ --state working
nagi pane report-metadata w1:p1 \ --source custom:indexer-display \ --token summary=indexingstate controls waits, notifications, and rollups. The summary token is display-only and can be used as $summary in an Agent sidebar row.
Agent sidebar rows can also opt into terminal_title or terminal_title_stripped; neither appears in the default rows. The first shows the latest safety-normalized OSC 0/2 terminal title. The second removes one recognized leading activity or spinner glyph and following whitespace. Nagi owns these values on the server; they are ephemeral across a cold restart and remain independent of metadata titles and semantic agent state. Spinner animation can therefore update the raw title without producing a pane update when the stripped text stays the same.
Start agents from the CLI
Section titled “Start agents from the CLI”Use nagi agent ... commands when you want a terminal to be treated as an agent target. Agent targets show up in agent list, can be read or sent input by agent name, can be waited on by agent state, and can be directly attached.
Spawn an agent into Nagi from a script:
nagi agent start reviewer --cwd ~/project --split right -- piYou can place that agent in a specific workspace or tab:
nagi agent start docs --workspace w1 --tab w1:t1 -- claudeUse nagi pane ... commands for ordinary terminals, servers, tests, shells, and low-level terminal input. For example, use pane split and pane run for cargo test, not agent start, unless that terminal is intentionally being treated as an agent target.
Attach directly to an agent
Section titled “Attach directly to an agent”Attach your current terminal to one agent terminal instead of the full Nagi UI:
nagi agent attach reviewerDetach with ctrl+b q. Send a literal ctrl+b with ctrl+b ctrl+b.
Scroll with the mouse wheel or plain page up/page down. Normal input jumps back to the bottom.
Use --takeover if another direct attach client already owns input:
nagi agent attach reviewer --takeoverUse nagi terminal attach <terminal_id> when you want the same direct attach behavior for a non-agent terminal.