Skip to content

Installation

Requirements

  • Python 3.11 or higher
  • An internet connection (to reach the AXLE API)

Install from PyPI

pip install axle

Install CLI via Homebrew (macOS/Linux)

brew install axle

Install from Source

git clone https://github.com/AxiomMath/axiom-lean-engine.git
cd axiom-lean-engine
pip install -e .
or
pip install git+ssh://git@github.com/AxiomMath/axiom-lean-engine

Development Installation

For development, install with dev dependencies:

git clone https://github.com/AxiomMath/axiom-lean-engine.git
cd axiom-lean-engine
make setup-env

This will:

  • Install all dependencies (including dev tools)
  • Set up pre-commit hooks
  • Install the package in editable mode

Verify Installation

# Check CLI
axle --version

# Check Python package
python -c "from axle import AxleClient; print('OK')"

Configuration

Set your API key to authenticate with the AXLE service:

export AXLE_API_KEY=your-api-key

You can also configure the API URL if needed:

export AXLE_API_URL=http://10.1.10.100:8989

See Configuration for more options.