Loading CLI command reference
CLI command reference

Every sz CLI command with usage, options, examples, output and underlying API operations.
# CLI command reference

The [Scheduler Zero CLI](/cli) currently exposes the commands below. Usages and options are generated from the same metadata as `sz help`, with hand-written behavioral and authorization notes. This reference is built from package version **0.2.2**.

## Commands

| Command | Purpose |
| --- | --- |
| [`sz whoami`](/cli/commands/whoami) | Show the current credential |
| [`sz login`](/cli/commands/login) | Sign in in a browser or save an API key |
| [`sz auth login`](/cli/commands/auth-login) | Sign in in a browser or save an API key |
| [`sz auth status`](/cli/commands/auth-status) | Show local authentication status |
| [`sz auth logout`](/cli/commands/auth-logout) | Remove the saved API key |
| [`sz organizations list`](/cli/commands/organizations-list) | List visible organizations |
| [`sz workspaces list`](/cli/commands/workspaces-list) | List workspaces (optionally --organization <id>) |
| [`sz campaigns list`](/cli/commands/campaigns-list) | List campaigns in --workspace <id> |
| [`sz campaigns get <campaign-id>`](/cli/commands/campaigns-get) | Show one campaign in --workspace <id> |

## Help and version

```bash
sz help
sz campaigns list --help
sz auth login --help
sz --version
```

Help and version need no credential. `sz login` is an alias for `sz auth login`. Command-specific `--help` prints the exact usage and supported options.

## Common behavior

Use workspace UUIDs for campaign commands, a parent organization UUID for the workspace-list filter, and `--json` for machine output. Objects remain JSON in default table mode; arrays render as tables. Inspect [options, environment precedence and exit codes](/cli/reference) before scripting.

The current CLI implements authentication, organization/workspace discovery and campaign reads. Permission metadata may contain writes, but that does not create matching CLI commands. For broader actions, use [REST operations](/rest-api/reference) or [MCP capabilities](/mcp/tools) with their required permissions and confirmations.

## Machine-readable versions

[CLI catalog](/cli/catalog.json) · [Command index Markdown](/cli/commands.md) · [CLI llms.txt](/cli/llms.txt) · [Complete CLI text](/cli/llms-full.txt) · [Markdown formats](/markdown)