gitpane: Instructions file for Codex

AGENTS.md

Guidance for AI coding agents working on gitpane, a multi-repo Git workspace dashboard TUI (Rust, ratatui). For the human-facing overview, see README.md.

Setup

• Rust edition 2024, MSRV 1.88.0. Install a matching toolchain (rustup recommended).
• No services or network access are needed to build, run, or test.
• Full integration coverage requires git on PATH, plus sh and sleep on Unix. CLI tests use crate::git::git_test_available() to skip only missing Git, with a reason visible under --nocapture; broken Git must fail tests.
• Optional tooling for the full local suite: cargo install cargo-audit cargo-llvm-cov, plus just for the task recipes below.

Build and run

just run                 # or: cargo run
cargo build --release

Checks (run before every commit)

just ci                  # fmt + lint + docs + test, the full gate
# or individually:
just fmt                 # cargo fmt --all
just lint                # cargo clippy --all-targets --all-features -- -D warnings
just test                # cargo test --all-targets --all-features
just docs                # rustdoc with -D warnings

CI runs the same checks and treats every warning as an error, so just ci must pass before you push. Tests are inline #[cfg(test)] modules in the binary target, so a plain cargo test --lib finds nothing. Use just test or cargo test --bin gitpane.

For changes to tests or subprocess dependencies, also run python3 scripts/check_test_environment.py on Linux or macOS. This runs every test harness with only sh and sleep on its PATH. Missing-Git skips count as passed in Rust's summary, so the normal suite with Git remains required.

Before a release, also run python3.14 scripts/check_source_package.py. It extracts the Cargo source archive into a temporary directory and runs its tests with a fresh build target, including the no-Git check on Unix. CI runs this on Linux, macOS, and Windows, and publication requires all release checks to pass.