> ## Documentation Index
> Fetch the complete documentation index at: https://platform.atlan.com/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI

> Work with Agent Registry, coding-agent traces, and Gateway APIs from a terminal.

The `atlanai` CLI gives developers one terminal interface for Registry
artifacts, repository skills, files, Gateway APIs, and coding-agent trace
capture.

<Note>
  **Preview.** Verify the CLI workflow in your environment before depending on
  it in production automation.
</Note>

<CardGroup cols={2}>
  <Card title="Install the CLI" icon="download" href="/cli/install">
    Install or update the current Preview release on macOS, Linux, or Windows.
  </Card>

  <Card title="Get started" icon="terminal" href="/cli/get-started">
    Publish and verify a disposable Skill before you automate a real one.
  </Card>

  <Card title="Automate with the CLI" icon="code" href="/cli/api-automation">
    Use API-key auth, structured output, stable exit codes, and the API escape hatch.
  </Card>

  <Card title="Command reference" icon="list" href="/cli/reference">
    Browse every public command group and its current flags.
  </Card>
</CardGroup>

## Common jobs

* Find artifacts with `atlanai search`, or list one kind with `skill`,
  `harness`, or `file`.
* Validate, publish, install, and roll back repository skills.
* Upload and download file artifacts.
* Call any authenticated Gateway endpoint with `atlanai api`.
* Install coding-agent integrations and inspect trace delivery.

Registry permissions always come from the authenticated Atlan identity. The
CLI does not bypass workspace access, review gates, or archive confirmation.

## Automation and agents

Start a script or coding agent with a read-only identity check, then ask it to
discover the command surface in one call:

```bash theme={null}
atlanai auth status
atlanai --map json
```

Use `--json`, `--jq`, or `--template` when another program consumes the
result. Keep destructive commands interactive unless the exact target and
approval are already part of the automation.

## Discover commands

Use built-in help for one command or print the complete command tree for a
coding agent or script:

```bash theme={null}
atlanai <command> --help
atlanai --map tree
atlanai --map json
```

The reference is pinned to the released CLI source. Your installed binary is
still authoritative when it is newer than this site.