Skip to navigation
Atlas CLI

Commands Reference

All available Atlas CLI commands and options

Global Options

Every command supports these flags:

FlagShortDescription
--output <format>-oOutput format: json (default), table, yaml
--verbose-vShow HTTP request/response details
--help-hShow help for any command
--versionShow CLI version

Built-in Commands

CommandDescription
atlas login --api-key KEYAuthenticate with API key
atlas logoutRemove active profile
atlas whoamiShow current profile and account
atlas profile listList all profiles
atlas profile use NAMESwitch active profile
atlas update-specForce refresh the API spec
atlas completion bash|zsh|fishOutput 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

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

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

Statistics

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

Agents

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

Contacts

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

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

Tools

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

Phone Numbers

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

Voices

atlas voice get-all-voices
atlas voice get-pangrams

Other Resources

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)

atlas campaign get-all-campaigns

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

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

Table

atlas campaign get-all-campaigns --output table

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

YAML

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:

Add to ~/.zshrc:

eval "$(atlas completion zsh)"

Discover Commands

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

# 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