Skip to content

Development

After installing dependencies with uv sync, CAPM can be run from the repository root like this:

uv run capm

For example, to run the tokei package, run:

uv run capm run tokei

Local installation using pipx

To install the development repository locally in editable mode run:

pipx install --force --editable .

To install the main branch locally run:

pipx install git+https://github.com/getcapm/capm.git

Or to install another branch locally run:

pip install git+https://github.com/getcapm/capm.git@issue-123

Building the binary distribution

Generate a self-contained binary:

uv run poe bundle

Static documentation

Generating the static documentation:

uv run mkdocs build

See the output:

uv run mkdocs serve