Documentation
CLI Quickstart
Command surface defined in packages/nikcli/src/index.ts and packages/nikcli/src/cli/cmd.
Entry Point
The CLI registers commands in packages/nikcli/src/index.ts using yargs.
nikcli --help
Default TUI
Running nikcli starts the TUI command ($0 [project]) with options:
--model, --agent, --session, --continue,
--prompt, plus network flags.
Core Commands
| Command | Description | Source |
|---|---|---|
run [message..] | Run a single-shot session with optional attachments and flags. | src/cli/cmd/run.ts |
generate | Emit OpenAPI schema with code samples injected. | src/cli/cmd/generate.ts |
auth | Manage provider credentials (login/logout/list). | src/cli/cmd/auth.ts |
agent | Create and list agents from prompts. | src/cli/cmd/agent.ts |
models | List models (optionally refresh cache). | src/cli/cmd/models.ts |
Run command options
run supports --model, --agent, --file,
--format, --attach, --share, --session,
--continue, --title, and provider-specific --variant.
Session & Export
session list | List sessions with paging support. |
export [sessionID] | Export session data as JSON. |
import <file|url> | Import session data from file or share URL. |
stats | Usage statistics across sessions. |
Server & Web
Server flags are defined in src/cli/network.ts.
nikcli serve --hostname 0.0.0.0 --port 4096
nikcli web --mdns
Remote & ACP
remote start | Create a mobile remote session + optional tunnel. |
remote status | Show current remote session state. |
acp | Start an ACP server (Agent Client Protocol). |
GitHub
The GitHub agent is managed via nikcli github.
nikcli github install
Maintenance
upgrade [target] | Upgrade to the latest or a specific version. Optional --method. |
uninstall | Remove nikcli; supports --keep-config, --keep-data, --dry-run, --force. |
pr <number> | Fetch GitHub PR, checkout, optionally import linked session. |