Docs · Install · Quick Start · Releases · Contributing
Give it a task — it reads your code, writes changes, runs your tests, and verifies the result.
All inside a rich terminal UI or a single non-interactive command.
Built in Rust. Wired to every major LLM.
curl -fsSL https://get.nyzhi.com | sh|
Cargo cargo install nyzhi |
npm npm install -g nyzhi |
Source git clone https://github.com/nyzhi-com/code
cd code && cargo build --release |
Self-update & rollback
nyz update # check and apply
nyz update --rollback latest # revert to previous
nyz uninstall # remove everythingUpdates run automatically every 4h. Every update backs up the current binary, verifies the new one with SHA256, and auto-rolls back on failure.
nyz # launch the TUI
nyz login openai # connect a provider (OAuth)
nyz run "explain this codebase" # one-shot, no TUI
nyz --continue # pick up where you left off|
OpenAI, Anthropic, Gemini, OpenRouter, DeepSeek, Groq — and any OpenAI-compatible endpoint. Switch mid-session. Route prompts to the right cost tier automatically. Autopilot — five-phase autonomous pipeline: expand, plan, execute, QA, validate. Teams — spawn coordinated sub-agents with mailbox messaging and task boards. Planning — planner/critic loops with persistent, replayable plans. Drop a |
File ops, git, grep, glob, bash, sub-agents, LSP, AST search, browser automation, PR workflows, semantic search, debug instrumentation — all with a permission model you control. 8 themes. 14 accent colors. Syntax highlighting. Tab completion. Persistent history with reverse search. Multi-line editing. Session export. Desktop notifications. Every file change is tracked. |
| Provider | Auth | Models |
|---|---|---|
| OpenAI | API key / OAuth | GPT-5.3 Codex, GPT-5.2, o3, o4-mini |
| Anthropic | API key / OAuth | Claude Opus 4.6, Sonnet 4.6, Haiku 4.5 |
| Gemini | API key / OAuth | Gemini 3.1 Pro, 3 Flash, 2.5 Flash |
| OpenRouter | API key | Any model on the platform |
| DeepSeek | API key | DeepSeek Chat |
| Groq | API key | Groq-hosted models |
| Custom | API key | Any OpenAI-compatible endpoint |
Multi-account per provider. Automatic token refresh. Rate-limit rotation across accounts.
| Autopilot | /autopilot <idea> — expand → plan → execute → QA → validate |
| Teams | /team 3 <task> — coordinated sub-agents with mailbox + task board |
| Planning | plan: prefix — planner/critic loop, persistent plans |
| Routing | Auto-select model tier by prompt complexity |
| Verification | Auto-detect build/test/lint for Rust, Node, Go, Python |
| Skills | /learn — extract reusable patterns from sessions |
| Memory | Persistent notepad across sessions with topic-based recall |
| Hooks | Run formatters/linters/tests after edits or agent turns |
|
Files Shell Git Agent |
Analysis Web & Browser Teams PR & Search & Debug |
nyz interactive TUI
nyz run "<prompt>" one-shot (non-interactive)
nyz run -i img.png "<prompt>" with image
nyz -c / --continue resume last session
nyz -s / --session "<query>" resume by title or ID
nyz -p openai -m gpt-5.2 provider and model flags
All commands
| Command | |
|---|---|
nyz login <provider> |
OAuth login |
nyz logout <provider> |
Remove stored token |
nyz whoami |
Auth status for all providers |
nyz config |
Show merged config |
nyz init |
Create .nyzhi/ in current project |
nyz mcp add|list|remove |
Manage MCP servers |
nyz sessions [query] |
List / search sessions |
nyz export <id> [-o path] |
Export session to markdown |
nyz stats |
Session statistics |
nyz cost [daily|weekly|monthly] |
Cost report |
nyz replay <id> |
Replay session events |
nyz deepinit |
Generate AGENTS.md from project analysis |
nyz skills |
List learned skills |
nyz teams list|show|delete |
Team management |
nyz ci-fix |
Auto-fix CI failures |
nyz update [--rollback] |
Self-update or rollback |
nyz uninstall |
Uninstall nyzhi |
Three layers, merged in order: global ~/.config/nyzhi/config.toml → project .nyzhi/config.toml → local .nyzhi/config.local.toml
[provider]
default = "anthropic"
[provider.anthropic]
model = "claude-sonnet-4-20250514"
[tui]
theme = "nyzhi-dark"
accent = "copper"
[agent]
max_steps = 100
auto_compact_threshold = 0.8
[agent.trust]
mode = "limited"
allow_tools = ["edit", "write"]
allow_paths = ["src/"]
[[agent.hooks]]
event = "after_edit"
command = "cargo fmt -- {file}"
pattern = "*.rs"| File | Purpose |
|---|---|
AGENTS.md or .nyzhi/rules.md |
Project rules the agent follows |
.nyzhi/commands/ |
Custom slash commands |
.mcp.json |
MCP server definitions |
Six crates, zero cycles, one binary.
nyzhi (cli)
╱ │ ╲
nyzhi-tui nyzhi-core nyzhi-provider
│ ╱ ╲ │
nyzhi-auth nyzhi-config
| Crate | |
|---|---|
| nyzhi | Binary entry point. CLI parsing, command dispatch, tool and MCP assembly. |
| nyzhi-core | Agent loop, 50+ tools, sessions, workspace, MCP, planning, teams, hooks, skills, verification, analytics. |
| nyzhi-provider | LLM abstraction. OpenAI, Anthropic, Gemini with streaming and thinking support. |
| nyzhi-tui | Terminal UI. ratatui, themes, syntax highlighting, completion, history, export. |
| nyzhi-auth | OAuth2 PKCE + device code, API keys, token store, multi-account rotation. |
| nyzhi-config | Config loading and merging across global, project, and local layers. |
| What | Where | Touched by updates? |
|---|---|---|
| Binary | ~/.nyzhi/bin/nyz |
Yes (backed up first) |
| Config | ~/.config/nyzhi/ |
Never |
| Sessions | ~/.local/share/nyzhi/sessions/ |
Never |
| Tokens | ~/.local/share/nyzhi/auth.json |
Never |
| Analytics | ~/.local/share/nyzhi/analytics.jsonl |
Never |
| Memory | ~/.local/share/nyzhi/MEMORY.md |
Never |
| Backups | ~/.nyzhi/backups/ |
Pruned to 3 |
Full documentation at code.nyzhi.com/docs — or browse the docs/ directory:
Core Architecture · Configuration · Authentication
Features Providers · Tools · TUI · MCP · Sessions · Teams · Autopilot
Workflow Hooks · Commands · Skills · Verification · Routing · Notifications · Memory
System Self-Update · Building · Releasing
Contributing · Code of Conduct · Support · Security · Issues