CremindRequirements
What each install mode needs before you run the one-liner — Docker Engine for Docker mode, Python 3.13.9+ for native mode.
Cremind runs on Linux, macOS, and Windows. What you need depends on which install mode you choose. The one-liner detects what's available and asks; the table below is what each mode actually requires.
By install mode
| Mode | Requirement | Platforms |
|---|---|---|
| Docker (recommended) | Docker Engine with Compose v2 | Any OS |
| Native | Python 3.13.9+ | Linux, macOS, Windows |
Docker mode
Docker mode needs Docker Engine with Compose v2. The installer detects Docker and, if present, can run fully unattended. The agent runs inside a container, so you don't need Python or anything else installed on the host beyond Docker itself.
You can confirm Compose v2 is available with:
docker compose versionCompose v2 is the docker compose (space) subcommand built into modern Docker, not the legacy standalone docker-compose (hyphen) binary. The installer and all management commands use the v2 form.
Native mode
Native mode needs Python 3.13.9 or newer on PATH. The installer creates a virtualenv at ~/.cremind/venv and installs the cremind wheel into it — your system Python is only used to create the venv, not polluted by the install.
Check your Python version with:
python --versionpython --versionIf your system Python is older than 3.13.9, install a newer Python (or use Docker mode, which has no Python requirement on the host).
Network access
Both modes fetch from the network during install:
- Docker mode pulls images from Docker Hub and resolves the package version from PyPI / Test PyPI.
- Native mode runs
pip install cremindfrom PyPI.
The installer also downloads templates over the network. For offline or CI installs, the CREMIND_TEMPLATE_BASE environment variable points the scripts at a different template source — see Files written.