Contributing

Setup

Python 3.11 or newer and uv.

uv sync --group dev

Checks

These commands stay offline and do not need an API key:

uv run ruff check .
uv run ruff format --check .
uv run mypy
uv run pytest

pytest disables network sockets.

Documentation

The documentation site uses the docs group:

uv sync --frozen --group docs && uv run mkdocs build

A GitHub Release deploys that version and points latest at it. Pushes to main update the dev docs.

Demo recording

tools/record_demo.sh rewrites examples/demo.cast and examples/demo.gif. It needs asciinema and agg. Run it when the CLI output changes.