Development

After installing dependencies with poetry install, CodeLimit can be run from the repository root like this:

poetry run codelimit

For example, to check a codebase at ~/projects/fastapi run:

poetry run codelimit scan ~/projects/fastapi

Local installation using pipx

To install the development repository locally run:

pipx install .

To install the main branch locally run:

pipx install git+https://github.com/getcodelimit/codelimit.git

Or to install another branch locally run:

pip install git+https://github.com/getcodelimit/codelimit.git@issue-123

Building the binary distribution

Generate a self-contained binary:

poetry run poe bundle

Static documentation

Generating the static documentation:

poetry run mkdocs build

See the output:

poetry run mkdocs serve

Terminal sessions in the documentation are recorded with the Asciinema CLI and stored in the assets folder:

asciinema rec scan.cast