Getting Started — Nyzhi Docs

Get Nyzhi running in a few steps: install the binary, set an API key, launch the TUI, and run your first task.

Install

Recommended — one-line install:

curl -fsSL https://get.nyzhi.com | sh

This downloads the latest release, verifies the SHA256 hash, and installs the nyz binary to ~/.nyzhi/bin/. Add that directory to your PATH if it isn’t already.

Alternative methods:

# From crates.io (requires Rust)
cargo install nyzhi

# From npm
npm i -g nyzhi

# From source (for development)
git clone https://github.com/nyzhi/nyzhi && cd nyzhi && cargo build --release

See Building for full source build instructions.

Self-Update and Rollback

Nyzhi checks for updates when the TUI starts. To update manually:

nyz update                   # check and apply if available
nyz update --force           # ignore throttle, check now
nyz update --list-backups    # list available rollback points
nyz update --rollback latest # rollback to previous version

See Self-Update for the full update flow and backup behavior.

Quick Start

1. Connect a Provider

Set an API key for your preferred LLM. The simplest option:

export OPENAI_API_KEY="sk-..."
# Or: export ANTHROPIC_API_KEY="sk-ant-..."
# Or: export GEMINI_API_KEY="AI..."

For OAuth login instead, use /login in the TUI. See Authentication and Providers for details.

2. Launch the TUI

nyz

In a project directory, Nyzhi detects the workspace and loads project rules (e.g., from .nyzhi/ or AGENTS.md). Type a task and press Enter.

3. Run a One-Shot Task

For non-interactive runs (e.g., from scripts or CI):

nyz run "Add unit tests for the parse_config function"

Output streams to stdout. Trust mode defaults apply for tool approval. See Configuration for [agent.trust] options.

4. Resume a Session

nyz
# In the TUI:
/sessions              # list saved sessions
/resume <session-id>   # restore a conversation

Sessions are stored as JSON. See Sessions for save, search, and export.

Basic CLI Flags

Flag	Description
`nyz`	Start the interactive TUI (default)
`nyz run "<prompt>"`	Run a single task non-interactively
`nyz --provider <name>`	Override the default provider
`nyz --model <id>`	Override the model for this run
`nyz --config <path>`	Use a specific config file
`nyz --version`	Print version and exit
`nyz update`	Check for and apply updates

For more options, run nyz --help.

Next Steps

Configuration — Global, project, and local TOML settings
Providers — OpenAI, Anthropic, Gemini, OpenRouter, and custom endpoints
TUI — Slash commands, shortcuts, theming, and session management