# AGENTS.md
Conventions for AI agents contributing to **lade** (a Rust CLI). For *using*
lade with coding agents and CI, see the README — this file is about working on
the codebase itself.
## Build & test
Run these before proposing changes; they must all pass:
```bash
cargo build --workspace --locked
cargo test --workspace --locked
cargo clippy --all-targets -- -D warnings
shellcheck installer.sh
bash tests/installer_test.sh
```
## House rules
- **All user-facing stderr goes through `message_box::MessageBox`** — never
`eprintln!`. The box is always emitted; only interactive parts (prompts,
countdowns, sleeps) are gated on `UiMode`. See
`.cursor/rules/message-box.mdc`.
- Never rely on default values; be explicit. Prefer the simplest solution that
compiles. Comment only non-obvious intent, not what the code does.
- Keep documented exit codes (`src/exit_codes.rs`) and the `lade status --json`
shape stable across minor versions; callers branch on them.
## Project layout
- `src/` — CLI crate. Key modules: `hook/` (agent `preToolUse` handler),
`agent_hooks/` (install/uninstall `lade hook` into Cursor/Claude configs),
`agent.rs` (direct-path agent detection), `prompt.rs` (disclaimer flow),
`inject.rs`/`exec/` (PTY execution + masking), `status.rs`, `shell/`
(shell-hook integration), `config/`, `message_box/`.
- `sdk/` — the secret-loader crate (vault providers).
- `tests/` — Rust integration tests + `installer_test.sh`.
- `scripts/`, `examples/tape/` — shell-hook fixtures and README demo tapes.
- `installer.sh`, `action.yml`, `Dockerfile`, `.github/workflows/` —
install & CI surface.
## Maintainer note
The GitHub Action (`action.yml`) is **not** auto-published to the Marketplace:
on each release, tick "Publish this Action to the GitHub Marketplace" in the
release UI once.