Skip to main content

​
Getting credentials

Contact your Atlas account team to receive access. You’ll need your account credentials to log in.

​
Installing the CLI

Run the install script:
Then reload your shell:
The CLI is supported on macOS and Linux. Confirm the installation:

​
CLI authentication

Configure the CLI with the Atlas server URL:
Then authenticate:
This opens a browser window to complete authentication. Once finished, your token is saved to ~/.atlas/token and the server URL to ~/.atlas/url. Export the token as an environment variable for use in API requests:
To revoke credentials:
Tokens are valid for 24 hours. Run atlas login again when yours expires.

​
Environment variable overrides

You can override stored credentials with environment variables. These take precedence over values saved to ~/.atlas/:

​
API authentication

All API requests require a Bearer token in the Authorization header:
The token is the same credential saved by atlas login. You can retrieve it from ~/.atlas/token or set it via the ATLAS_TOKEN environment variable.
All API requests must be made over HTTPS. Requests without a valid Bearer token return 401 Unauthorized.