# Atlas Cloud CLI: AI Image & Video Generation

Generate AI images, videos, speech, and 3D assets from your terminal, Claude Code, or Codex. Install Atlas Cloud CLI, estimate costs, and save results.

Source: https://atlascloud.ai/docs/en/cli

The Atlas Cloud CLI provides the `atlas` command for generating AI media and
calling LLMs from your terminal, scripts, Claude Code, or Codex. Discover models,
inspect their inputs, estimate cost, and save generated files in your project.

This guide targets the published CLI **v0.1.36**. Model availability, input
requirements, and pricing depend on the live catalog. Generation and chat are
billable; setup, model discovery, and cost estimation do not submit a generation.

[GitHub repository](https://github.com/AtlasCloudAI/cli) ·
[English agent guide](https://github.com/AtlasCloudAI/cli/blob/main/docs/AGENT_QUICKSTART_EN.md) ·
[中文指南](https://github.com/AtlasCloudAI/cli/blob/main/docs/AGENT_QUICKSTART.md)

## Install

Choose one method. macOS / Linux:

```sh
curl -fsSL https://raw.githubusercontent.com/AtlasCloudAI/cli/main/install.sh | sh
```

Windows PowerShell:

```powershell
irm https://raw.githubusercontent.com/AtlasCloudAI/cli/main/install.ps1 | iex
```

Or use Homebrew or npm:

```sh
brew install AtlasCloudAI/tap/atlascloud
# Or:
npm install -g atlascloud-cli
```

The Homebrew formula is named `atlascloud`; all methods install `atlas`.
Verify with `atlas version`. The shell installer uses `~/.local/bin`; add it to
PATH if needed. Windows installs to `%LOCALAPPDATA%\AtlasCloud\bin`; reopen your
terminal afterward. Installers download a prebuilt release and verify its checksum.
[Custom paths, versions, and manual installation](https://github.com/AtlasCloudAI/cli/blob/main/docs/api-caller-workflows.md#installation-options).

## Sign in and generate AI media

### Sign in once

```sh
atlas auth login
```

Choose device login to authorize your AtlasCloud account, or paste an
[API key](https://www.atlascloud.ai/console/api-keys). For an existing session,
`atlas auth ensure --non-interactive` checks and refreshes credentials without
starting a login flow. Chat and generation are billable; model discovery and
cost estimation do not submit a generation.

### Generate images and videos with Claude Code or Codex

Choose the command for your agent:

```sh
atlas skills install --agent claude
# Or:
atlas skills install --agent codex
```

Start a new agent session, attach a reference image, and ask:

> Use Atlas to create a product photo from this reference. Keep the packaging
> and logo intact. Show me the model and cost estimate before generating, then
> save the result in this project.

The skill reads its detailed instructions from your installed CLI and updates
with it. See the [English agent guide](https://github.com/AtlasCloudAI/cli/blob/main/docs/AGENT_QUICKSTART_EN.md)
or [中文指南](https://github.com/AtlasCloudAI/cli/blob/main/docs/AGENT_QUICKSTART.md) for setup requests and more tasks.

### Generate an AI image from your terminal

```sh
atlas models get google/nano-banana-2/text-to-image --json
atlas generate cost image google/nano-banana-2/text-to-image \
  -p "A matte black water bottle on a beige pedestal, studio lighting" --json

# Billable: wait for completion and save the files.
mkdir -p outputs
atlas generate image google/nano-banana-2/text-to-image \
  -p "A matte black water bottle on a beige pedestal, studio lighting" -o ./outputs/
```

Generation waits and downloads by default; the result reports status and saved
file paths. Use `--no-download` for remote results only.
[Complete image, video, speech, and 3D examples](https://github.com/AtlasCloudAI/cli/blob/main/docs/MEDIA_EXAMPLES.md)
include real model IDs and required inputs.

## Discover models

```sh
atlas models list --type video --json
atlas models list --type audio --json
atlas models list --type 3d --json
atlas models search seedance --type video --json
```

Use `atlas models get MODEL_ID --json` to inspect required fields and defaults.
Model availability and pricing depend on your account catalog. Audio and 3D
commands require the selected model and schema to be exposed there.
For model-specific flags, use `atlas generate video MODEL_ID --help`.

## Scripts and existing tasks

Use `--json` for scripts; output is also JSON when stdout is not a terminal.
`--no-wait` returns a submission receipt. After a timeout or interruption, use
its prediction ID with `atlas generate get` or `atlas generate wait` to continue
the same task. Local receipts are available through `atlas generate ops list`.
If submission is unknown, inspect the receipt before creating another billable job.

For CI, inject an API key from your secret store and authenticate explicitly:

```sh
atlas auth login --token "$ATLASCLOUD_API_KEY"
```

The CLI does not automatically load `.env` or use `ATLASCLOUD_API_KEY` without
that login command. See the [script and JSON guide](https://github.com/AtlasCloudAI/cli/blob/main/docs/api-caller-workflows.md)
and [runnable examples](https://github.com/AtlasCloudAI/cli/tree/main/examples).

## Commands

| Command | Purpose |
|---|---|
| `atlas auth` | Sign in, check/refresh the existing session, or sign out |
| `atlas models` | Discover models and inspect schemas |
| `atlas chat` | Chat or analyze supported image/video/audio inputs |
| `atlas generate` | Generate image/video/audio/3D outputs, estimate cost, and retrieve tasks |
| `atlas generate ops` | Inspect local receipts and resume accepted tasks |
| `atlas skills` | Install or read the Atlas agent skill |
| `atlas account` | Show, list, or switch accounts |
| `atlas doctor` | Diagnose local installation and configuration |
| `atlas update` | Update an official native installation |
| `atlas version` | Show the installed version |

Run `atlas --help` or `atlas <command> --help` for flags. Chat currently returns
its full response when ready; it does not stream tokens.

## Updating and troubleshooting

Official native installs check for background updates during interactive use,
at most once every 24 hours. JSON commands and CI do not start background updates.

```sh
atlas update          # Native installer: update now
atlas update --check  # Check only
atlas doctor --json  # Local diagnostics

# For package-manager installs:
brew upgrade atlascloud
npm install -g atlascloud-cli@latest
```

Set `ATLAS_AUTO_UPDATE=0` in your shell profile to disable background updates.
For authentication errors, use `atlas auth ensure --non-interactive`; log in again
if credentials cannot be refreshed. For an unknown model, search the live catalog.
If generation succeeded but download failed, retrieve the same task again.
[More troubleshooting and recovery](https://github.com/AtlasCloudAI/cli/blob/main/docs/api-caller-workflows.md#recover-after-a-timeout).

## Privacy and uninstall

Authentication uses your platform's credential storage or a protected local
fallback. Official releases send usage events with command, model ID, version,
platform, duration, and outcome/error metadata, linked to a random installation ID.
They exclude prompts, auth/API tokens, media content, and file paths.
Set `ATLAS_TELEMETRY=0` before installation and keep it set to disable usage events
and the installer ping. This does not disable the API requests needed for your task.
In PowerShell, use `$env:ATLAS_TELEMETRY="0"`.

Optionally run `atlas auth logout` to clear credentials, then uninstall:

```sh
rm -f "$HOME/.local/bin/atlas"   # Default shell install
# Or, for your package manager:
brew uninstall atlascloud
npm uninstall -g atlascloud-cli
```

On Windows, remove `%LOCALAPPDATA%\AtlasCloud\bin\atlas.exe`, or your chosen
custom install path, and remove the unused directory from your user PATH.

## Product images with Claude Code or Codex

[Follow the product image tutorial](https://github.com/AtlasCloudAI/cli/blob/main/docs/PRODUCT_IMAGES_WITH_AGENTS.md)
to set up the agent skill, use a text description or reference image, check the
estimated cost, and save the result. The tutorial includes a real generated
product photo and explains how to retrieve the same task after a timeout.

## Image-to-video generation from your terminal

[Follow the image-to-video tutorial](https://github.com/AtlasCloudAI/cli/blob/main/docs/IMAGE_TO_VIDEO.md)
to inspect a Seedance image-to-video model, use a local image, estimate a five-second
video at 720p, and download the result. Its inputs were validated without submitting
a paid video task.

## More examples and support

- [Image, video, speech, and 3D commands](https://github.com/AtlasCloudAI/cli/blob/main/docs/MEDIA_EXAMPLES.md)
- [Script, JSON, and CI workflows](https://github.com/AtlasCloudAI/cli/blob/main/docs/api-caller-workflows.md)
- [CLI releases and changelog](https://github.com/AtlasCloudAI/cli/releases)
- [GitHub Issues](https://github.com/AtlasCloudAI/cli/issues) — include the CLI version, platform, and failing command with secrets removed.
