Documentation
Everything you need to master Nyzhi. From installation to advanced autonomous workflows.
Getting Started
Install Nyzhi and run your first task in under two minutes.
Core Concepts
Architecture, configuration, and authentication deep dives.
Architecture
Seven Rust crates, zero dependency cycles, one binary — how Nyzhi is structured internally.
Configuration
Global and project-level config, merge rules, and a complete TOML reference for every setting.
Authentication
API keys, OAuth login, multi-account rotation, and credential resolution order.
Key Features
Providers, tools, TUI, MCP, sessions, teams, and autopilot.
Providers
Every supported LLM provider — open-source, local, and proprietary — with setup instructions.
Tools
The complete inventory of 50+ built-in tools — file ops, git, code intelligence, browser, teams, and more.
MCP
Connect external tool servers via Model Context Protocol — stdio or HTTP, with hot-add and deferred discovery.
Sessions
Persistent conversation history — save, search, export, replay, and resume sessions.
Teams
Multi-agent collaboration — spawn teammates, share inboxes, coordinate tasks, and build agent teams.
Autopilot
Multi-phase autonomous execution — from idea to validated implementation, with persistent state.
Advanced Workflow
Hooks, commands, skills, verification, routing, and memory.
Hooks
Event-driven automation — run commands, inject prompts, or trigger agents on any lifecycle event.
Commands
Every CLI command and flag — from interactive TUI to CI scripting mode.
Skills
Reusable instruction packs — encode domain knowledge and repeatable workflows as markdown files.
Verification
Automated quality checks — build, test, lint — with auto-detection and structured evidence.
Routing
Automatic model selection based on prompt complexity — send simple tasks to fast models, hard ones to powerful models.
Notifications
Terminal bells, desktop alerts, and external webhooks — Telegram, Discord, Slack, and custom endpoints.
Memory
Persistent knowledge across sessions — user preferences, project conventions, and decision history.
System & Releases
Self-update, building from source, and the release process.
Self-Update
Automatic updates, manual upgrades, rollback to previous versions, and uninstalling.
Building from Source
Clone, build, and run Nyzhi from source — prerequisites, workspace commands, and cross-compilation.
Releasing
The release pipeline — version tags, build matrix, crates.io and npm publishing, pre-release checklist.
Terminal UI
The interactive TUI — keybindings, slash commands, panels, completion, and background tasks.
Reference
Complete CLI hierarchy, slash commands, and quick-lookup tables.
Internals
Deep dives into agent roles, workspace rules, and subagent lifecycle.
Roles & Context Briefing
How agent roles are resolved, applied, and how context is propagated to subagents.
Workspace Rules
How Nyzhi detects your project root, loads rules, and constructs the system prompt.
Subagent Lifecycle
The internal lifecycle of subagents — spawn, interact, wait, resume, and close.