CLI Commands
Complete reference for all whisp commands.
CLI Commands
Complete reference for all whisp commands.
Global Options
These options work with any command:
| Option | Description |
|---|---|
-h, --help | Show help for command |
-V, --version | Show version |
--no-color | Disable colored output |
-v, --verbose | Show debug information |
-q, --quiet | Suppress non-critical output |
Daemon Commands
whisp start
Start the daemon process.
whisp start [OPTIONS]| Option | Description |
|---|---|
-f, --foreground | Run in foreground for debugging |
# Start in background (default)
whisp start
# Start in foreground to see logs
whisp start --foregroundwhisp stop
Stop the running daemon. Sends SIGTERM and waits up to 5 seconds for graceful shutdown.
whisp stopwhisp restart
Restart the daemon. Equivalent to whisp stop && whisp start.
whisp restartwhisp status
Show daemon status including PID and socket connectivity.
whisp statusSetup Commands
whisp init
Interactive setup wizard for configuring whisp.
whisp init [OPTIONS]| Option | Description |
|---|---|
-c, --check | Verify setup without making changes |
# Run interactive setup
whisp init
# Check if setup is complete
whisp init --checkwhisp doctor
Run comprehensive diagnostic checks.
whisp doctorChecks: daemon status, socket connectivity, config validity, permissions, API keys, required tools.
Configuration Commands
whisp config
View or modify configuration.
whisp config [SUBCOMMAND]Subcommands:
# Show all settings
whisp config
# Get specific value
whisp config get <key>
whisp config get provider
whisp config get model
whisp config get socket
# Set value
whisp config set <key> <value>
whisp config set provider anthropic
whisp config set model gpt-4o
# Validate configuration
whisp config validatewhisp providers
List all available AI providers and their status.
whisp providersShows active provider, configured models, and API key status for each provider.
Monitoring Commands
whisp health
Show daemon health metrics.
whisp healthDisplays: version, uptime, provider, request/error counts, active connections, memory usage.
whisp metrics
Show performance and token usage metrics.
whisp metrics [OPTIONS]| Option | Description |
|---|---|
-p, --period <PERIOD> | Time filter: day, week, month, all |
--json | Output as JSON |
# Last week (default)
whisp metrics
# Last 30 days
whisp metrics --period month
# JSON output for scripts
whisp metrics --jsonInteractive Commands
whisp chat
Open interactive multi-turn conversation mode.
whisp chatWithin chat:
- Type messages and press Enter
- Use
/clearto reset conversation - Type
exit,quit, or press Ctrl+D to exit
whisp history
View and manage command history.
whisp history [SUBCOMMAND]Subcommands:
# Show recent history (last 20)
whisp history
# Search history
whisp history search <query>
whisp history search docker
whisp history search "large files"
# Clear all history
whisp history clearService Commands
whisp install
Install auto-start service (systemd on Linux, launchd on macOS).
whisp installwhisp uninstall
Remove the auto-start service.
whisp uninstallUtility Commands
whisp update
Check for and install updates from GitHub.
whisp update [OPTIONS]| Option | Description |
|---|---|
-c, --check | Check for updates without installing |
# Check if update available
whisp update --check
# Download and install update
whisp updatewhisp completions
Generate shell completion scripts.
whisp completions <SHELL>Available shells: bash, zsh, fish, elvish, powershell
whisp completions bash >> ~/.bashrc
whisp completions zsh > ~/.zsh/completions/_whisp
whisp completions fish > ~/.config/fish/completions/whisp.fishwhisp help
Show comprehensive help with shortcuts and examples.
whisp help
# or
whispShell Integration Commands
These are typically called by shell shortcuts, not directly:
whisp shell query
Generate command from natural language (called by ,).
whisp shell query "<query>"whisp shell explain
Explain a command (called by ,.).
whisp shell explain "<command>"whisp shell dry-run
Preview command effects (called by ,d).
whisp shell dry-run "<command>"whisp shell variants
Show alternative commands (called by ,,).
whisp shell variantswhisp shell search
Search command history (called by ,/).
whisp shell search "<query>"whisp shell clipboard
Copy last command to clipboard (called by ,c).
whisp shell clipboardwhisp shell session-id
Generate a unique session ID.
whisp shell session-idwhisp shell send-error
Send error context for fix suggestions.
whisp shell send-error "<command>" <exit_code> [stderr]whisp shell pipe
Process piped stdin with AI (used when piping to ,).
echo "log content" | whisp shell pipe "<query>"whisp shell escape-json
Escape text for JSON embedding (internal utility).
whisp shell escape-json "<text>"