atlan-cli-install-configure

Install the Atlan CLI only when missing and configure tenant authentication.

4|7|Updated Apr 30, 2025
One-click install
npx skills add https://github.com/atlanhq/atlan-sample-apps --skill atlan-cli-install-configure
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: atlan-cli-install-configure
Source: https://github.com/atlanhq/atlan-sample-apps/tree/main/.agents/skills/atlan-cli-install-configure
Command: npx skills add https://github.com/atlanhq/atlan-sample-apps --skill atlan-cli-install-configure

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill makes it simple to install the Atlan CLI only when it's missing and to configure baseline tenant authentication and logging settings, preventing unnecessary changes to a user's environment.

Core Features & Use Cases

  • OS-aware installation: Detects the operating system and installs the appropriate Atlan CLI binary or uses Homebrew on macOS when available.
  • Safe configuration: Ensures the .atlan/config.yaml contains atlan_base_url and logging settings, and sets authentication via an environment variable or config file.
  • Quick setup: Works with minimal input to get the CLI ready for normal app workflows.

Quick Start

Use the skill to install the Atlan CLI on a target machine when it is missing, verify the installation, and apply the baseline configuration using the references in this skill.

Frequently Asked Questions about atlan-cli-install-configure

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I install the Atlan CLI on my machine?

Install the Atlan CLI by running the skill, which detects your operating system and installs the appropriate binary or uses Homebrew on macOS if available. The skill only installs if the CLI is missing, then validates the installation with atlan --version and atlan --help.

What authentication methods does Atlan CLI support?

Atlan CLI supports authentication via the ATLAN_API_KEY environment variable or configuration in the .atlan/config.yaml file. The skill configures baseline tenant authentication automatically during setup.

Can I use Atlan CLI on Windows, macOS, and Linux?

Yes, Atlan CLI works cross-platform. The installation skill detects your OS and installs OS-aware binaries for Windows, macOS, and Linux, with Homebrew support on macOS.

What happens if Atlan CLI is already installed?

The skill skips installation if Atlan CLI is already present, preventing unnecessary changes to your environment. It then applies baseline configuration for authentication and logging.

What configuration does the skill set up?

The skill ensures .atlan/config.yaml contains atlan_base_url and logging settings, and configures authentication using either an environment variable or config file, establishing baseline tenant setup.

How do I verify the Atlan CLI installation was successful?

Run atlan --version and atlan --help to validate the installation. The skill performs these checks automatically and summarizes the installation method and path used.