Skip to content

Installation

The Apogee Framework is distributed as a single standalone binary built with PyInstaller. You do not need to install Python dependencies on your machine to use it — only Python 3.11+ for projects you generate.

Prerequisites

  • Python 3.11+ (for the projects you will generate, not for apogee itself)
  • Docker and Docker Compose v2 (for apogee up)
  • make (for building from source)
  • Linux or macOS (Windows users: WSL2 recommended)

Option A — Build from source

This is the supported path while the framework is pre-1.0.

Bash
git clone https://github.com/Digital-Codigos/apogee-framework
cd apogee-framework

# build a local binary into .dist/apogee
make build

# install globally to /usr/local/bin/apogee (or ~/.local/bin)
make install

After installation, verify:

Bash
apogee --version
apogee --help

Option B — Run from sources without installing

Useful for development on the framework itself.

Bash
PYTHONPATH="src" python3 -m presentation.cli --help

Option C — Pre-built binary (coming soon)

Pre-built binaries for Linux/macOS will be published in GitHub Releases once a 1.0 milestone ships.

Verify your install

Bash
apogee --version
# → 0.2.0 (or later)

apogee new --help
# → shows the project generator subcommand

Next step

→ Generate your first project: Quickstart.