Installation¶

Install the Atlas command-line interface (CLI) in an isolated Python environment. Isolation prevents Atlas dependencies from conflicting with other projects.

Supported platforms¶

Platform	Minimum version	Status
Windows	Windows 11	Supported
macOS	13	Supported
Ubuntu	22.04 LTS	Supported
Other Linux distributions	—	Community tested

Install with `pipx`¶

pipx is the recommended installation method.

python -m pip install --user pipx
python -m pipx ensurepath
pipx install atlas-docs==1.2.0

Restart the terminal after ensurepath updates the executable path.

Install in a virtual environment¶

Use this method for CI runners or project-specific installations:

python -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install atlas-docs==1.2.0

On Windows PowerShell, activate the environment with:

.\.venv\Scripts\Activate.ps1

Verify the installation¶

atlas --version

Expected output:

atlas-docs 1.2.0

Also run a diagnostic check:

atlas doctor

The check confirms the Python version, configuration path, Markdown parser, and Git availability.

Warning

Do not install Atlas with administrator or root privileges. A privileged installation can create files that ordinary users cannot modify.

Upgrade or uninstall¶

pipx upgrade atlas-docs
pipx uninstall atlas-docs

For proxy, certificate, or path failures, see Troubleshooting.