Getting started
Start here when you want the shortest path to a working setup. Open the getting started overview
Installation¶
Install envctl, verify that it works, and then move straight into the quickstart.
Keep this page practical — install first, theory later.
Option 1: install from PyPI¶
This is the shortest path when you want to use envctl as a normal CLI tool.
$ python3 -m pip install envctlUse this when you are onboarding into a project and do not need to work on envctl itself.
Option 2: install from the repo for local development¶
Use this when you are contributing to envctl or testing changes locally.
$ uv sync --devThis creates a fully reproducible development environment using the locked dependency set defined in uv.lock.
Verify that it works¶
Once installed, confirm that the CLI is available:
$ envctl --versionIf you see a version printed successfully, the CLI is installed and ready.
What to do next¶
Once envctl is available in your shell, continue with the Quickstart.
If you prefer to understand the model before running commands, read the Mental model.
Read next¶
First project¶
Follow a fuller onboarding path inside a real repository checkout.