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 asatlan, and sign in with a bearer
token on standard input:
--sourceis the Atlan API address. Usehttps://api.atlan.comunless your Atlan contact gave you a different one. It must be anhttpsaddress on an Atlan domain, with no path.- The command also declares
atlanas a registry in your user scope, so you don’t need a separatebrain 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.
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: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 andbrainsays so. The default is your personal workspace, unless the registry setsdefault_namespace.- Atlan accepts skills only. If you include another kind,
brain publishstops withAtlan cannot publish <kind> artifacts.and publishes nothing. - A skill can be blocked by its security scan, and
brain publishreports that. A version held for review is reported bybrain syncand background jobs, not bybrain publish. See Errors with Atlan.
Use a token in CI
In CI, nobody signs in. Load the API key from your CI secret store intoREGISTRY_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.
brain to PATH for later steps only,
which is why the example sets PATH for the current one.
Related
- Atlan adapter reference: every setting, command, and limit the adapter adds.
- Capture traces: send coding-agent sessions to Atlan.
- Move to brain: from
atlanai. - brain CLI reference: every
braincommand.