Skip to main content

Development

Local build

cargo build --release
cargo run -- --help

Tests

cargo test -q
Optional checks:
cargo fmt --check
cargo clippy --all-targets --all-features -- -D warnings

Repo notes

  • core Rust implementation lives under src/
  • release installers live under scripts/
  • npm wrapper lives under npm/
  • recorded demo assets and regeneration notes live in the existing repo docs material

Documentation maintenance

When user-facing behavior changes:
  • update the Mintlify pages in this repo
  • update the README if it still serves as a high-level landing page
  • keep examples aligned with the current kagi --help output
  • keep removed or deferred features out of the public docs surface