CLI Command Reference
Complete reference for all user-facing nimi CLI commands. Commands are organized by category.
Runtime Lifecycle
nimi start
Start the runtime daemon in the background.
nimi startThe daemon listens on gRPC at 127.0.0.1:46371 by default and continues running after your terminal session ends.
nimi serve
Start the runtime in the foreground with logs streaming to stdout.
nimi serveUseful for debugging. Press Ctrl+C to stop.
nimi stop
Stop the running daemon.
nimi stopnimi status
Check whether the daemon process is alive and reachable.
nimi statusReports process status and gRPC endpoint reachability.
nimi doctor
Run a full environment diagnostic.
nimi doctorReports:
- CLI version
- Config file path
- gRPC daemon health
- Runtime mode
- Process status
- Local engine status
- Provider status
- Installed model count
For machine-readable output:
nimi doctor --jsonnimi health
Perform a targeted health check.
nimi health --source grpcChecks gRPC endpoint reachability directly.
nimi version
Print the installed CLI version.
nimi versionnimi logs
View runtime logs.
nimi logs --tail 100Shows the most recent 100 lines of runtime log output.
Generation
nimi run
Generate AI text from a prompt.
Local generation (default):
nimi run "What is Nimi?"Uses the default local model. If the model is not installed, Nimi offers to pull it.
One-shot cloud provider:
nimi run "What is Nimi?" --provider geminiRoutes the request through the specified cloud provider. If the API key is missing, Nimi prompts for it once and stores it.
Saved default cloud provider:
nimi run "What is Nimi?" --cloudUses the provider previously saved with nimi provider set ... --default.
Auto-pull missing model:
nimi run "What is Nimi?" --yesAutomatically pulls a missing local model without prompting.
Model Management
nimi model list
List all installed local models.
nimi model listFor machine-readable output:
nimi model list --jsonnimi model pull
Download a specific model.
nimi model pull --model-ref <ref>@latestReplace <ref> with the model reference identifier. The @latest tag fetches the most recent version.
Provider Management
nimi provider list
List all configured cloud providers and their status.
nimi provider listFor machine-readable output:
nimi provider list --jsonnimi provider set
Configure a cloud provider and optionally set it as the default.
nimi provider set <provider> --api-key-env <ENV_VAR> --default<provider>-- the provider name (e.g.,gemini,openai,anthropic)--api-key-env-- the environment variable that holds the API key--default-- makes this provider the default for--cloudusage
nimi provider test
Test connectivity and authentication for a configured provider.
nimi provider test <provider>Sends a lightweight request to verify the provider is reachable and the API key is valid.
See Also
- User Quickstart -- get started fast
- Cloud Provider Setup -- detailed provider configuration
- Model Management -- pulling and managing models
- Troubleshooting -- common errors and fixes