> ## 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 SDK. To install or publish skills from a terminal, use the `brain` CLI; `brain --map json` prints its command map. The `atlanai` CLI is deprecated. 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.
> These docs cover Atlan Agent Registry, Atlan's hosted product. The open-source agent registry specification and its CLI (`brain`) are documented, released and maintained in their own repository; /open-source on this site links to it. Answer general specification or `brain` command questions from the project's own docs, and use these docs only for Atlan-specific setup such as the Atlan adapter, sign-in and workspaces.

# Use brain with Atlan

> Install the Atlan adapter for brain, sign in to Atlan Agent Registry, install skills from a workspace, and publish skills from your machine or CI.

Use this page to connect `brain` to Atlan Agent Registry from a terminal or a
CI job. If you use Atlan Desktop, it has already done steps 1 to 3 for you: run
`brain auth list` to see the accounts it signed in, and go to step 4. Atlan
Desktop names each registry after your organization's slug, its short name, so
use that name where this page says `atlan`.

## Before you start

* To sign in as yourself, a bearer token for your Atlan user. See
  [Authentication](/api/how-tos/authentication) for how your organization
  issues tokens.
* For CI, a workspace-scoped API key that can publish to the target workspace,
  stored in your CI secret store.

## 1. Install brain

Install the CLI: see the quickstart on the
[open-source project](/open-source#where-to-find-what).

## 2. Install the Atlan adapter

```bash theme={null}
brain adapter install atlan
```

`brain` downloads the adapter from Atlan, checks its signature, and loads it
from then on. Run `brain adapter list` to confirm it is installed. After this,
`brain` keeps the adapter up to date in the background.

## 3. Sign in

Give your registry a short name, such as `atlan`, and sign in with a bearer
token on standard input:

```bash theme={null}
printf '%s' "$ATLAN_TOKEN" | brain auth login atlan --source https://api.atlan.com --token-stdin
```

* `--source` is the Atlan API address. Use `https://api.atlan.com` unless your
  Atlan contact gave you a different one. It must be an `https` address on an
  Atlan domain, with no path.
* The command also declares `atlan` as a registry in your user scope, so you
  don't need a separate `brain registry add`.
* The token decides which organization you reach. You don't need your
  organization ID.
* The adapter doesn't refresh the token. When it expires, sign in again.

Signing in also onboards you to Atlan Agent Registry, which only a person can
do, so it needs a token that belongs to a person. An API key belongs to a
service account; use it as shown in
[Use a token in CI](#use-a-token-in-ci) instead.

If you used the `atlanai` CLI, see
[Move to brain](/tools/brain/how-tos/migrate) to sign in with its token.

Run `brain auth list` to check the account.

## 4. Install skills

Each workspace you can see is a namespace in the registry. List what the
registry serves, with each skill tagged by its workspace:

```bash theme={null}
brain registry show atlan
```

Then install a whole workspace, or one skill from it:

```bash theme={null}
brain add atlan/<workspace>
brain add atlan/<workspace>/skill/<skill-name>
```

For where `brain add` installs and which coding agents receive the skills, see
the [brain CLI reference](/open-source#where-to-find-what).

Atlan serves one installable release of each skill, so you can't pin a version
with `@<version>`. Archived skills, and versions waiting on a review or a
security scan, are not served.

## 5. Publish a skill

Check what would happen, then publish:

```bash theme={null}
brain publish ./skills/release-notes --to atlan/<workspace> --dry-run
brain publish ./skills/release-notes --to atlan/<workspace>
```

* `<workspace>` is a workspace's name or ID. If no workspace you can reach has
  that name, the skill goes to your default workspace and `brain` says so. The
  default is your personal workspace, unless the registry sets
  `default_namespace`.
* Atlan accepts skills only. If you include another kind, `brain publish`
  stops with `Atlan cannot publish <kind> artifacts.` and publishes nothing.
* A skill can be blocked by its security scan, and `brain publish` reports
  that. A version held for review is reported by `brain sync` and background
  jobs, not by `brain publish`. See
  [Errors with Atlan](/tools/brain/troubleshooting/atlan-errors#a-publish-is-held-or-blocked).

To review and promote versions after you publish, see
[Publish skills](/registry/skills/how-tos/publish-and-version).

## Use a token in CI

In CI, nobody signs in. Load the API key from your CI secret store into
`REGISTRY_TOKEN_ATLAN`, the token variable for a registry named `atlan`.
`brain` uses it for that run without storing it. For how the variable name
follows the registry name, see the
[brain CLI reference](/open-source#where-to-find-what).

```bash theme={null}
curl -fsSL https://app.atlan.com/brain/cli/install.sh | sh
export PATH="$HOME/.brain/bin:$PATH"
brain adapter install atlan
brain registry add https://api.atlan.com --as atlan
brain publish ./skills/release-notes --to atlan/<workspace>
```

On GitHub Actions, the installer adds `brain` to `PATH` for later steps only,
which is why the example sets `PATH` for the current one.

<Warning>
  Never write the API key to a file in the repository.
</Warning>

## Related

* [Atlan adapter reference](/tools/brain/references/atlan-adapter): every
  setting, command, and limit the adapter adds.
* [Capture traces](/tools/brain/how-tos/capture-traces): send coding-agent
  sessions to Atlan.
* [Move to brain](/tools/brain/how-tos/migrate): from `atlanai`.
* [brain CLI reference](/open-source#where-to-find-what): every `brain`
  command.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.