> ## 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.

> ## Agent Instructions
> To act on Atlan objects, use the Atlan MCP server at https://api.atlan.com/mcp or the atlanai CLI; `atlanai --map json` prints its command map. Run a read-only identity check before any write.
> The docs MCP server at /mcp searches these docs only. It cannot read or change Atlan objects.
> SDK packages: Python `atlanai` (PyPI) and TypeScript `@atlanai/sdk` (npm). Show Python first, then TypeScript.

# Registry CLI reference

> Complete command reference for the Atlan Registry CLI (registry).

The Registry CLI installs, manages, and publishes agent artifacts across Claude Code, Codex, Cursor, and the vendor-neutral `.agents` layout.

## Set up

| Command | Description |
| - | - |
| [init](registry/commands/references/init) | Set up a project, or this machine |
| [marketplace](registry/commands/references/marketplace) | Manage the marketplaces you install from |
| [agents](registry/commands/references/agents) | Give your agents the skills to set up, install from and publish to registries |
| [auth](registry/commands/references/auth) | Manage sign-ins to your marketplaces |

## Install

| Command | Description |
| - | - |
| [add](registry/commands/references/add) | Install artifacts from a marketplace |
| [remove](registry/commands/references/remove) | Uninstall artifacts |
| [install](registry/commands/references/install) | Make this project match its manifest |
| [update](registry/commands/references/update) | Take the newest each marketplace offers |
| [try](registry/commands/references/try) | Preview an artifact without installing it |

## Check

| Command | Description |
| - | - |
| [console](registry/commands/references/console) | One full-screen view of this machine: artifacts, jobs, accounts |
| [status](registry/commands/references/status) | Check installed artifacts against the lockfile |
| [list](registry/commands/references/list) | List what is installed |
| [outdated](registry/commands/references/outdated) | Check upstream for newer artifacts |
| [targets](registry/commands/references/targets) | List harnesses detected on this machine |
| [detect](registry/commands/references/detect) | List the artifacts on this machine that nothing manages |

## Share

| Command | Description |
| - | - |
| [sync](registry/commands/references/sync) | Reconcile this project with its marketplaces |
| [publish](registry/commands/references/publish) | Publish artifacts to a marketplace, as new versions |

## Automate

| Command | Description |
| - | - |
| [run](registry/commands/references/run) | Run one job now, whatever its schedule says |
| [daemon](registry/commands/references/daemon) | Run or inspect the background sync daemon |

## Maintain

| Command | Description |
| - | - |
| [config](registry/commands/references/config) | Read and write machine-wide settings |
| [doctor](registry/commands/references/doctor) | Check this machine can install |
| [adapter](registry/commands/references/adapter) | Install a signed adapter from the release origin |
| [logs](registry/commands/references/logs) | Read the diagnostic log |
| [self-update](registry/commands/references/self-update) | Install the latest CLI |

## Global options

| Option | Description |
| - | - |
| `-g`, `--global` | Act on the user scope instead of this project |
| `--scope` | project, user or local |
| `-t`, `--target` | Harnesses to install into (repeatable, or `*`) |
| `-s`, `--select` | Artifact names (repeatable, or `*`) |
| `-y`, `--yes` | Take the defaults; ask nothing |
| `--all` | Every artifact, without asking |
| `--copy` | Copy into each harness instead of symlinking |
| `--dry-run` | Print what would change, and stop |
| `--frozen` | Fail if content or projection would change |
| `--force` | Overwrite locally edited artifacts |
| `--json` | Machine-readable output |
| `--verbose` | Show each step |
| `--log-level` | Diagnostic log level on stderr and in the log file |
| `--map` | Print the full command tree and exit: tree, compact, or json |

## Exit codes

| Code | Meaning |
| - | - |
| 0 | Success |
| 1 | Error or malformed input |
| 2 | Required argument not provided |
| 3 | Drift detected |
| 4 | Authentication required |

## Related

* [Set up the Registry CLI](/registry/commands/references/init)
* [Quick start](/registry)