Cawdit documentation
Cawdit reviews pull requests on Forgejo and Arbinel with a large language model of your choice. These pages show how to install, configure and run it.
Start with the quick start, which adds Cawdit to one repository as a Crow CI step in about fifteen minutes.
Tutorials
- Quick start: review your first pull request with the Crow plugin.
How-to guides
- Set up the forge: the bot account, its token scopes, the webhook, and dashboard sign-in.
- Set up SSO sign-in: sign in to the dashboard through an OpenID Connect provider, such as Zitadel.
- Configure a model provider: Anthropic, OpenAI, and servers such as Ollama or vLLM.
- Self-host with Docker: run
cawdit servewith Docker Compose and Postgres. - Self-host with Helm: run
cawdit serveon Kubernetes.
Reference
- Deployment configuration: every key of the server’s TOML file and its environment variables.
- Repository configuration: every key of
.cawdit.toml. - Command line: the subcommands, their flags and exit codes.
- HTTP server: the routes, the webhooks Cawdit handles, and the metrics.
Explanation
- How Cawdit reviews: the steps of a review, the markers, fixed findings, and commands.
- Security model: the secrets, untrusted input, and what is left to you.
- Frequently asked questions.
Keeping the reference current
docs/reference_test.go fails when a key of the deployment configuration or of .cawdit.toml, an environment variable, or a command-line flag is missing from the reference pages.
When you add one, document it in the same pull request.