@novaaiops/cli
v1.5.3
Published
Nova CLI — Command-line interface for Nova AI Ops SRE platform
Maintainers
Readme
Nova CLI
Command-line interface for the Nova AI Ops SRE platform.
Install
# From npm (recommended once published):
npm install -g @novaaiops/cli
# From source (clone + link):
git clone https://github.com/Samsontanimawo/nova-cli.git
cd nova-cli
npm install
npm link # registers `nova` in your $PATHVerify:
nova --version # should print 1.5.0
nova status # hits prod (auth required for most commands)Publishing to npm (maintainer only)
# 1. Make sure you're logged in to an npm account that owns the @novaaiops scope
npm whoami
# 2. From the nova-cli directory:
cd nova-cli
npm publish # uses publishConfig.access = "public" from package.jsonThe package.json files array limits what's shipped: bin/, src/,
README.md, LICENSE. Everything else (node_modules, dotfiles, tests)
is excluded by .npmignore.
Quick Start
# Authenticate
nova login
# Check platform health
nova status
# List incidents
nova incidents list
# List services
nova services listCommands
| Command | Description |
|---------|-------------|
| nova login | Authenticate with Nova AI Ops |
| nova logout | Clear credentials |
| nova whoami | Show current user |
| nova status | Platform health overview |
| nova config | Show CLI configuration |
| nova open | Open web UI in browser |
Incidents
nova incidents list # List all incidents
nova incidents list --status open # Filter by status
nova incidents list --json # JSON output
nova incidents create -t "DB latency spike" -s critical
nova incidents resolve INC-42 --note "Fixed pool"
nova incidents ack INC-42 # AcknowledgeServices
nova services list # List all services
nova services list --status critical # Filter by status
nova services health # Health check all
nova services health api-gateway # Check specific serviceAlerts
nova alerts list # List all alerts
nova alerts list --firing # Only firing alertsSLO
nova slo check # Check all SLOs
nova slo check --service api-gateway # Specific serviceAgents
nova agent status # Show all agents
nova agent install # Install instructionsRunbooks
nova runbooks list # List runbooks
nova runbooks run RB-01 --target prod-web-01 # Execute
nova runbooks run RB-01 --dry-run # Preview onlyMetrics
nova metrics query "cpu > 80" --last 1h # Query metrics
nova metrics push deploy.count 1 --tags env:prod # Push custom metricGolden Signals
nova golden-signals # Latency / Traffic / Errors / Saturation
nova gs # Short alias
nova golden-signals --json # Machine-readableApprovals (agent action approvals)
nova approvals list # Pending high-risk action approvals
nova approvals approve <id> # Approve a request
nova approvals reject <id> -r "Wrong target" # Reject with reasonSecurity
nova security events # Recent security events (last 50)
nova security events --json # Machine-readable
nova security stats # 24h summary by type/severity
nova security blocks # List blocked IPs
nova security block 1.2.3.4 -r "brute force" # Block an IP
nova security unblock 1.2.3.4 # Unblock an IPPlatform Health
nova health # One-screen platform health overviewService Map
nova service-map # Render dependency graph as a tree
nova service-map -s api-gateway # Filter to one service + neighbours
nova smap --json # Short alias, JSON outputEmail Outbox (admin)
nova outbox list # All outbox rows
nova outbox list --status queued # Only queued
nova outbox stats # Counts per status
nova outbox retry 42 # Re-queue a failed/dead row
nova outbox cancel 99 # Cancel a queued rowInvitations + Roles + Users
nova invitations list # Pending org invites
nova roles list # Roles for your org
nova roles permissions # All permission strings (grouped)
nova users list # User directory
nova users show <id> # Full user record
nova users stats # Directory totalsUniversal Search
nova search "checkout latency" # Search incidents, runbooks, services
nova search "deploy" -t incident,runbook # Filter to specific types
nova search "p99" --json | jq '.results[]' # Pipe JSONDrills + Trends + Rooms
nova drill list # Available chaos / automation scripts
nova drill run 17 --dry-run # Plan a drill run
nova trends alerts # Alert volume + severity trends
nova trends uptime # Uptime trend (rolling)
nova trends weekly # Weekly health trend
nova trends aws-cost # AWS cost trend
nova rooms list # Your war rooms / channels
nova rooms search "checkout-incident" # Search rooms
nova rooms presence # Who's onlineDatabricks + Prometheus
nova databricks list # Recent export jobs
nova databricks trigger -t full # Trigger a full export
nova databricks status export_xxx # Check job status
nova prom query 'rate(http_requests_total[5m])' # Ad-hoc PromQL
nova prom labels # Available label names
nova prom targets # Scrape targetsSessions + Slack + Remediations + System
nova sessions list # Your active auth sessions
nova sessions revoke <id> # Revoke a session
nova sessions revoke-others # Revoke all but the current
nova slack status # Is Slack connected?
nova slack channels # List visible Slack channels
nova remediations active # Active AI-driven remediations
nova remediations config # Blast-radius limits
nova system info # Backend version + env
nova system gauge # CPU/memory/load gaugeNova Shell + Settings + Onboarding
nova shell session # Show shell session info
nova shell exec "ls /var/log" # Run a command on Nova Shell
nova shell reset # Reset shell session
nova settings get # All your settings
nova settings get notifications # Just one category
nova settings email-alerts # Email alert subscription state
nova onboarding status # Tenant onboarding checklistSession Replay + Grafana + AWS
nova replay sessions # Recent recorded sessions
nova replay dashboard # Replay summary
nova replay timeline INC-42 # Replay timeline for an incident
nova grafana status # Grafana connection
nova grafana dashboards # List dashboards
nova grafana datasources # List datasources
nova aws status # AWS account/region/profile
nova aws ec2 # List EC2 instances
nova aws cost # 30d cost trend
nova aws vpcs # List VPCsPage Control + User Analytics + Query Hub
nova pages list # Pages visible to your role
nova pages visibility # Full visibility config (Developer+)
nova pages show-all # Make all pages visible
nova pages hide-all # Hide all non-default pages
nova analytics realtime # Active users right now
nova analytics growth # Signup / retention trends
nova analytics engagement # Engagement metrics
nova analytics sessions # Recent sessions
nova db schema # All tables (Founder)
nova db schema users # One table's columns
nova db execute "SELECT COUNT(*) FROM incidents" # Run SQL (Founder, audited)
nova db templates # Saved query templates
nova db history # Recent queries
nova db stats # Database statsNova Connect + Dashboard Studio
nova connect channels # List Connect channels
nova connect messages <channelId> # Recent messages
nova connect members <channelId> # Channel members
nova studio boards # Saved Studio boards
nova studio signals # Signal catalogPage → command coverage
All 33 active pages from the platform now have CLI mappings (some
inherently visual pages — Session Replay, Dashboard Studio — expose
read-only metadata only; the actual playback / drag-drop builder stays
in the browser via nova open).
Configuration
Profiles (multi-environment)
nova profile list # all profiles
nova profile create staging --api-url=https://staging.novaaiops.com
nova profile use staging # switch active
nova profile show # active profile details
nova profile set staging orgId acme-corp # update one field
nova profile delete staging # remove
nova --profile prod incidents list # one-shot overrideLayout under ~/.nova/:
config.json— active profile pointer + global aliasesprofiles/<name>.json— per-profile settingsprofiles/<name>.token— per-profile auth token (mode 0600)
Legacy ~/.nova/config.json + ~/.nova/token files are auto-migrated
into a default profile on first run.
Environment variables (CI-friendly)
| Var | Effect |
|---|---|
| NOVA_API_URL | Override active profile's API URL |
| NOVA_TOKEN | Auth token (bypasses token files) |
| NOVA_PROFILE | Active profile name |
| NOVA_OUTPUT | Default -o format |
| NOVA_TIMEOUT | Default request timeout (ms) |
| NOVA_DEBUG=1 | Enable HTTP debug logging |
| NOVA_NO_VERSION_CHECK=1 | Skip the npm version check |
| NO_COLOR=1 | Disable ANSI colors |
Global flags
| Flag | Effect |
|---|---|
| --profile <name> | Use a specific profile for this invocation |
| -o, --output <fmt> | json | yaml | wide | jsonpath=<expr> |
| --watch [N] | Re-run every N seconds (default 5; Ctrl-C to exit) |
| -d, --debug | Print HTTP requests/responses to stderr |
| --timeout <ms> | Override request timeout (default 15000) |
| --no-color | Disable ANSI colors |
Output Formats
nova incidents list # default table
nova incidents list -o json | jq '.[] | .title' # JSON for jq
nova incidents list -o yaml # YAML
nova incidents list -o jsonpath='$[*].id' # extract one field
nova services list --watch 10 # live, every 10s
nova golden-signals -o jsonpath='$.signals.latency' # specific pathAliases
nova alias create open-inc "incidents list --status open"
nova open-inc # uses the alias
nova open-inc -o yaml # composes with flags
nova alias list # all aliases
nova alias delete open-inc # removeShell Completion
# bash
nova completion bash >> ~/.bashrc
# zsh (somewhere on $fpath)
nova completion zsh > "${fpath[1]}/_nova"
# fish
nova completion fish > ~/.config/fish/completions/nova.fishSelf-update
nova upgrade # re-installs @novaaiops/cli@latest
nova upgrade --check # shows the npm view command without installingA non-blocking version check runs in the background after each command
and prints a single-line warning to stderr if a newer version exists.
Skip with NOVA_NO_VERSION_CHECK=1.
Editor + stdin patterns
nova incidents create -t "DB latency spike" --edit # opens $EDITOR for body
nova incidents resolve - <<EOF # ids from stdin
INC-101
INC-102
EOF
nova incidents resolve INC-42 --dry-run # plan without sendingLicense
MIT
