Installation

Acme can be installed via pip, Homebrew, or Docker.

pip install acme-cli

Verify the installation:

acme --version
# Acme CLI v2.4.0

Using Homebrew (macOS)

brew tap acme/tap
brew install acme

Using Docker

docker pull acme/acme:latest
docker run --rm acme/acme:latest --version
Python version

Acme requires Python 3.10 or higher. If you're using an older version, consider using pyenv to manage multiple Python versions.

Post-installation setup

After installing, initialize your configuration:

acme init

This creates a ~/.acme/config.yml file with default settings. See Configuration for all available options.

Shell completions

Enable tab completions for your shell:

# Bash
acme completions bash >> ~/.bashrc

# Zsh
acme completions zsh >> ~/.zshrc

# Fish
acme completions fish > ~/.config/fish/completions/acme.fish

Upgrading

pip install --upgrade acme-cli
Note

After upgrading, run acme migrate up to apply any database schema changes. See the Changelog for breaking changes.

Next steps

Once installed, head to the Quickstart to build your first pipeline.

Built with LogoFlowershow