Skip to content

Installation

Installation

The Constellation CLI supports macOS, Linux (Ubuntu, Debian, CentOS, RHEL, Arch), and Windows.

The easiest way to install is with our installer script:

Terminal window
curl -fsSL https://dev.constellation-io.com/install.sh | sh

The script will:

  1. Detect your OS and architecture
  2. Install Python 3.10+ if needed
  3. Install the constellation-cli package
  4. Walk you through initial configuration

Windows

On Windows, use PowerShell:

Terminal window
irm https://dev.constellation-io.com/install.ps1 | iex

Manual Install

via pip

Requires Python 3.10+:

Terminal window
pip install constellation-cli

via pipx (Isolated Environment)

Terminal window
pipx install constellation-cli

From Source

Terminal window
git clone https://github.com/constellation-io/constellation-cli.git
cd constellation-cli
pip install -e .

Verify Installation

Check that the CLI is installed:

Terminal window
constellation --version

Expected output:

constellation-cli 1.0.0

Configuration

After installation, configure your credentials:

Interactive Login

Terminal window
constellation login

This opens your browser for OAuth authentication.

Manual Token Configuration

Terminal window
constellation config set token YOUR_API_TOKEN
constellation config set endpoint https://api.constellation-io.com

Configuration File

Config is stored at ~/.constellation/config.yaml:

endpoint: https://api.constellation-io.com
operator_id: your-operator-id

Credentials are stored separately at ~/.constellation/credentials (not committed to git).

Platform-Specific Notes

macOS

  • Tested on macOS 12+ (Monterey and later)
  • Supports both Intel and Apple Silicon (arm64)
  • Uses Homebrew for Python if not installed

Ubuntu / Debian

  • Tested on Ubuntu 20.04, 22.04, 24.04
  • Tested on Debian 11, 12
  • Uses apt for Python installation

CentOS / RHEL / Fedora

  • Tested on CentOS 8, 9
  • Tested on RHEL 8, 9
  • Tested on Fedora 38+
  • Uses dnf or yum for Python installation

Arch Linux

  • Uses pacman for Python installation
  • Works with standard Arch and derivatives (Manjaro, EndeavourOS)

Windows

  • Tested on Windows 10, 11
  • Uses winget for Python if not installed
  • Creates scheduled task instead of cron for daemon mode

Upgrading

Terminal window
pip install --upgrade constellation-cli

Or reinstall via the install script:

Terminal window
curl -fsSL https://dev.constellation-io.com/install.sh | sh

Uninstalling

Terminal window
pip uninstall constellation-cli
rm -rf ~/.constellation

On Windows:

Terminal window
pip uninstall constellation-cli
Remove-Item -Recurse -Force $env:USERPROFILE\.constellation