Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Contributing

cargo fmt --all --check
cargo clippy --all-targets --locked -- -D warnings
cargo test --all --locked

Crates: core (data model, rule files, git), engine (ast-grep), learn (capture, cluster, rule writing, backtest, eval), ledger (decisions, scope, checks, extraction), cli (the ingrain binary). PLAN.md is the working plan.

See CONTRIBUTING.md before opening a PR, SECURITY.md to report a vulnerability, and CHANGELOG.md for release notes. This project follows a Code of Conduct.

License: Apache-2.0.

Docs

This book lives in docs/book/. The CLI reference is generated from the clap definitions; regenerate it after changing a command or flag:

cargo run -q -p ingrain -- --markdown-help > docs/book/src/reference/cli.md
mdbook serve docs/book   # http://localhost:3000

CI fails when reference/cli.md is out of date. Pushes to main deploy the book to GitHub Pages.