Axis CLI

Deploy and operate Axis apps from a terminal. Output is human-readable by default and JSON when piped. axis dashboard is a read-only live view of the environment.

Install

npm install --global @blackbox-labs-llc/axis-cli

The package ships standalone binaries for macOS (Intel and Apple Silicon), Linux (x64 and arm64), and Windows x64. A launcher picks the binary for your machine. Node.js 18+ is required only to run that launcher.

Quick start

axis login
axis link
axis status
axis deploy
axis logs --follow

axis dashboard watches deployments, resources, and logs without changing anything. Use the regular commands to deploy, edit variables, or work with databases.

axis <command> --help lists flags for a specific command.

Update

npm install --global @blackbox-labs-llc/axis-cli

In a terminal, Axis prints that command when npm has a newer release than the one you are running. axis update prints it on demand. Set AXIS_NO_UPDATE_CHECK=1 to silence the notice.

Shell completion

Completion is generated from the live command tree, so nested commands, global flags, and known option values stay in sync:

# bash
source <(axis completion bash)

# zsh
source <(axis completion zsh)

# fish
axis completion fish | source

# PowerShell
axis completion powershell | Out-String | Invoke-Expression

Add the same line to your shell profile to keep completion in later sessions.

Automation

Set AXIS_TOKEN, pass explicit context flags, and pick an output format:

AXIS_TOKEN="$TOKEN" axis resource list --environment "$ENVIRONMENT_ID" --output json
axis logs --resource "$RESOURCE_ID" --follow --output ndjson

Finite piped output defaults to JSON. Streaming output defaults to NDJSON. Progress and diagnostics go to stderr.

Errors use the requested structured format (json, ndjson, or yaml) on stderr. Add --verbose to human-readable commands to include the error code and request/trace identifiers. Prompts are disabled when stdin or stderr is not a terminal; destructive commands still require --yes.