Sirio

Contributing

Build from source

Toolchain requirements per platform and the commands that build Sirio and sirioctl.

Requirements

  • A current stable Rust toolchain.
  • Zig exactly 0.15.2 on PATH. The terminal crate builds libghostty-vt with zig build, and upstream pins that version. A newer install fails too.
  • Windows: the MSVC toolchain. Linux: GTK 3 and WebKitGTK 4.1 development packages.

Build

git clone https://github.com/ai-sirio/sirio
cd sirio/rust
cargo build -p sirio --release
cargo build -p sirio_control --bin sirioctl --release

Iterate on one crate with cargo test -p <crate>. The whole-repository gate is Scripts/ci.sh, which prints CI OK when everything passes.

Conventions

Commit messages follow Conventional Commits with a lower-case imperative subject. Tests come first. Design specs live in docs/superpowers/specs/ and ADRs in docs/adr/: read the relevant one before changing behaviour it describes, and write one for anything that changes how the pieces fit.