Atlas CLI

Atlas CLI Quickstart

Get up and running with the Atlas CLI in under 2 minutes

Install

$curl -fsSL https://cdn.youratlas.com/atlas-cli/install.sh | bash

Authenticate

Get your API key from the Atlas Portal under Settings > API Keys, then:

$atlas login --api-key YOUR_API_KEY

Try it out

$# List your campaigns
$atlas campaign get-all-campaigns
$
$# Get a specific campaign
$atlas campaign get-campaign CAMPAIGN_ID
$
$# View as JSON
$atlas campaign get-all-campaigns --output json
$
$# See all available commands
$atlas --help
$
$# See commands for a specific resource
$atlas campaign --help

What’s next?

Installation

Detailed install instructions for all platforms

Authentication

Multi-profile setup and managing credentials

Commands Reference

Full list of commands and output options