Skip to content

Development

Use uv for local development.

uv sync
uv run gitai --help

Run the repository checks:

make check

Build the package:

make build

Build the documentation:

uv run --group docs mkdocs build --strict

The editable documentation source is in mkdocs/. Generated HTML is written to docs/.

Safety Notes

Do not commit provider API keys, .env files, generated virtual environments, or ~/.gitai/config.json contents. Use placeholders in .env.example and the documentation.