Atlan CLI Install Configure
Use this skill when CLI setup is the blocker. Keep it lightweight and safe.
Trigger
- •Trigger when a workflow needs CLI and
command -v atlanfails. - •Trigger when the user explicitly asks to install, reinstall, or configure Atlan CLI.
- •Do not trigger for normal app tasks if
atlanis already available and user did not request reinstall.
Workflow
- •Pre-check:
- •run
command -v atlan - •if found and reinstall is not requested, skip install and move to config check.
- •run
- •Detect platform (
uname -s,uname -m, or PowerShell OS/arch on Windows). - •Use install guidance from
references/install-matrix.md:- •macOS: prefer Homebrew when available.
- •otherwise use pre-built binary for detected OS/arch.
- •never use
go getor source-build as default install path.
- •Verify installation:
- •
atlan --version - •
atlan --help
- •
- •Configure CLI using
references/config-template.md:- •ensure
.atlan/config.yamlhasatlan_base_urlandlogsettings. - •auth via
ATLAN_API_KEYenv var (preferred) oratlan_api_keyin config.
- •ensure
- •Configure
data_sourceentries only if user has provided source details. - •Summarize install method, binary path, CLI version, and config status.
Security Rules
- •Never print raw API keys in logs or summaries.
- •Prefer
ATLAN_API_KEYenv var for automation and CI. - •Ask user for missing
atlan_base_urlor auth inputs before writing config.
Failure Handling
- •If network/policy blocks download, stop and ask for either:
- •temporary network access, or
- •an existing local
atlanbinary path.
- •If extraction fails, retry once, then report exact failing command and output.
- •If install succeeded but
atlanis still not inPATH, provide a shell-specificPATHupdate step.
References
- •Install matrix:
references/install-matrix.md - •Config template:
references/config-template.md