> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.youratlas.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.youratlas.com/_mcp/server.

# Commands Reference

## Global Options

Every command supports these flags:

| Flag                | Short | Description                                      |
| ------------------- | ----- | ------------------------------------------------ |
| `--output <format>` | `-o`  | Output format: `json` (default), `table`, `yaml` |
| `--verbose`         | `-v`  | Show HTTP request/response details               |
| `--help`            | `-h`  | Show help for any command                        |
| `--version`         |       | Show CLI version                                 |

## Built-in Commands

| Command                            | Description                      |
| ---------------------------------- | -------------------------------- |
| `atlas login --api-key KEY`        | Authenticate with API key        |
| `atlas logout`                     | Remove active profile            |
| `atlas whoami`                     | Show current profile and account |
| `atlas profile list`               | List all profiles                |
| `atlas profile use NAME`           | Switch active profile            |
| `atlas update-spec`                | Force refresh the API spec       |
| `atlas completion bash\|zsh\|fish` | Output shell completion          |

## API Commands

All API commands are auto-generated from the Atlas OpenAPI specification. They follow the pattern:

```
atlas <resource> <operation> [arguments] [flags]
```

### Campaigns

```bash
atlas campaign get-all-campaigns
atlas campaign get-campaign <id>
atlas campaign create-campaign
atlas campaign update-campaign <id>
atlas campaign delete-campaign <id>
atlas campaign get-templates
atlas campaign set-campaign-status <id>
atlas campaign get-campaign-snapshots <campaignId>
atlas campaign get-campaign-calendars <campaignId>
```

### Calls

```bash
atlas call get-call-records
atlas call get-call-record <id>
atlas call get-scheduled-calls <campaignId>
```

### Statistics

```bash
atlas statistic get-all-campaigns-overview
atlas statistic get-campaign-overview <campaign_id>
```

### Agents

```bash
atlas agent get-all-agents
atlas agent get-agents-by-campaign <campaignId>
atlas agent get-agent <campaignId> <id>
```

### Contacts

```bash
atlas contact get-contacts <campaignId>
atlas contact get-global-contacts
atlas contact get-contact-count <campaign_id>
atlas contact get-contact-tokens <campaignId>
```

### Knowledge Base

```bash
atlas knowledge-base get-all-knowledge-files
atlas knowledge-base get-knowledge-files <campaignId>
```

### Tools

```bash
atlas tool get-all-tools
atlas tool get-tool-templates
atlas tool get-tool-template-categories
```

### Phone Numbers

```bash
atlas phone-number get-all-phone-numbers
atlas phone-number get-phone-number <id>
```

### Voices

```bash
atlas voice get-all-voices
atlas voice get-pangrams
```

### Other Resources

```bash
atlas calendar-setting get-calendar-settings
atlas calls-forward get-call-forwards <campaignId>
atlas events-gateway events-get-campaign-triggers <campaignId>
atlas dashboard get-dashboard-stats
atlas dashboard get-deployment-stats
atlas account get-profile
atlas customer-quota get-customer-quota
atlas customer-quota get-monthly-minutes
atlas campaign-chat get-chat-sessions <campaignId>
atlas api-key get-api-keys
```

## Output Formats

### JSON (default)

```bash
atlas campaign get-all-campaigns
```

Raw JSON output. Great for scripting and piping to tools like `jq`:

```bash
atlas campaign get-all-campaigns | jq '.[].name'
```

### Table

```bash
atlas campaign get-all-campaigns --output table
```

Human-readable table with column headers. Best for interactive use.

### YAML

```bash
atlas campaign get-all-campaigns --output yaml
```

YAML format for config files and readability.

## Shell Completion

Shell completion is **automatically configured** when you install Atlas using the install script. Just restart your terminal after installing.

If you need to set it up manually:

#### Zsh

Add to `~/.zshrc`:

```bash
eval "$(atlas completion zsh)"
```

#### Bash

Add to `~/.bashrc`:

```bash
eval "$(atlas completion bash)"
```

#### Fish

```bash
atlas completion fish > ~/.config/fish/completions/atlas.fish
```

#### PowerShell

Add to your PowerShell profile:

```powershell
atlas completion powershell | Out-String | Invoke-Expression
```

## Discover Commands

The CLI dynamically generates commands from the Atlas API. To see all available commands:

```bash
# List all resource groups
atlas --help

# List operations for a resource
atlas campaign --help

# Show usage for a specific command
atlas campaign get-campaign --help
```