getting-started.md

Getting started

Install the locked development and documentation environments:

uv sync --frozen --group docs
uv run pre-commit install --install-hooks

Run the example command:

uv run fgcz-reference "Example Project"

Expected output:

example-project

Run the fast checks:

uv run pre-commit run --hook-stage pre-commit --all-files