CLI Reference

Lizard CLI (lizard) deploys and manages apps, databases and Sandboxes on Lizard from a terminal, a CI job or a coding agent. This page covers installation, global flags, exit codes, and runtime discovery. Each command has a reference page in the sidebar. See lizard up, lizard service, lizard secrets, and the rest. For an overview of what the CLI does, see the Lizard CLI page.

Reference written for Lizard CLI v4.0.34. Run lizard <cmd> --help --json for the exact, version-matched schema of any command.

Install & upgrade

curl -fsSL https://lizard.build/install.sh | bash   # macOS and Linux
lizard --version
lizard upgrade            # update to the latest version
lizard upgrade --check    # check without installing

See lizard upgrade for the flags.

On Windows, run irm https://lizard.build/api/cli/install.ps1 | iex in PowerShell. With Node.js you can install from npm instead: npm install -g @lizard-build/cli.

On macOS and Linux, the binary from the install script also updates itself in the background, at most once every 6 hours. It skips the check when CI or LIZARD_NO_UPDATE=1 is set. The Windows binary does not update itself: run the installer again. An npm install updates through npm: lizard upgrade prints the command.

Use the globally installed lizard binary rather than npx. See Quickstart for permission-error fixes.

Authentication

lizard login                  # browser OAuth
lizard login --token liz_xxx  # API key auth
lizard logout
lizard whoami                 # current user, workspace, linked project

Reference pages: lizard login, lizard logout, lizard whoami, and lizard workspace to list and create workspaces.

API keys start with liz_. Create one with lizard keys create <name>. In CI, set LIZARD_TOKEN (or LIZARD_API_KEY) in the environment instead of running login.

Global flags

Most commands also accept -p, --project and -s, --service to target a specific resource instead of the linked one. init, link, and project also take -w, --workspace. lizard add always uses the linked project.

Exit codes

Runtime discovery

The CLI is self-documenting. To see the full command tree, global flags, and exit codes:

lizard --help --json

For any command or subcommand’s exact arguments and options:

lizard <cmd> --help --json
lizard <cmd> <sub> --help --json     # e.g. lizard service set --help --json

The output lists the arguments and flags your installed version accepts. It is also how an agent learns the CLI without being trained on it: see deploying from Claude Code.

Configuration & state

• The CLI stores auth and the current directory’s project link in ~/.lizard/config.json.
• lizard status shows the cwd’s workspace/project/service link (no auth required). lizard link sets that link, lizard unlink removes it, and lizard project lists, creates, and deletes projects.
• lizard config apply applies a lizard-config.json file to a project (use --dry-run to preview).
• lizard open opens the linked project in the dashboard, and lizard docs opens these docs.

Environment variables

Sandbox volumes

Use names to manage Persistent Volumes within a project. Full reference: lizard volume and lizard sandbox.

lizard volume create agent-workdir --size 10 --project proj_123
lizard volume list --project proj_123
lizard volume resize agent-workdir --size 20 --project proj_123
lizard sandbox create --volume agent-workdir --project proj_123

Names are unique per project: lowercase letters, digits and dashes, starting and ending with a letter or digit, up to 64 characters. New volumes allow whole GB from 1 to 50, default 5. The CLI reads the server’s current limits before creating a volume, so it follows config changes. Existing larger volumes keep their size.

After detaching a volume, lizard volume rm agent-workdir --project proj_123 deletes it and its data. volume list shows names; --json includes generated IDs.

Updated October 12, 2026