Skip to main content
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 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.

2. Install the Atlan adapter

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:
  • --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 instead. If you used the atlanai CLI, see Move to brain 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:
Then install a whole workspace, or one skill from it:
For where brain add installs and which coding agents receive the skills, see the brain CLI reference. 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:
  • <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.
To review and promote versions after you publish, see Publish skills.

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.
On GitHub Actions, the installer adds brain to PATH for later steps only, which is why the example sets PATH for the current one.
Never write the API key to a file in the repository.