Skip to content

Agent Quick Reference

  1. vox ci line-endings: LF only source formats limit. No CRLF allowed except for *.ps1.
  2. vox ci command-compliance: Check CLI compliance updates.
  3. vox stub-check (TOESTUB): Prevent submitting todo!(), unimplemented!(), empty-bodies, or any stubs.
  4. vox ci sync-ignore-files: Ensures AGENTS.md rules and .voxignore exclusions correctly sync to .cursorignore and .aiignore.
  5. vox ci clavis-parity: Requires secret references securely bind to resolve_secret(...). No static env variables allowed! (CI command name retained for backward compat; checks against secrets-ssot.md.)
  • Do NOT read or modify files within docs/src/archive/ or archive/ for current work streams.
  • All new documentation requires comprehensive YAML frontmatter: title, description, category, status, last_updated, training_eligible.
  • Inline code blocks across .md files should be explicitly imported using {{#include}} pointing to examples/golden/ files, OR manually prepended with // vox:skip.

Never read std::env::var("SECRET"); exclusively employ vox_secrets::resolve_secret(...) and declare it in crates/vox-secrets/src/spec.rs.

If vox is explicitly omitted from terminal $PATH, use the dev scripts:

  • Windows: scripts\windows\vox-dev.ps1 <commands>
  • Linux/Mac: ./scripts/vox-dev.sh <commands>
Retired / DeprecatedCanonical Replacement (Use Instead)
Legacy orchestrator packagingvox-orchestrator
Legacy ARS/OpenClaw predecessor cratevox-openclaw-runtime
Legacy gamification crate labelvox-gamify
Legacy split compiler cratesvox-compiler
Legacy React-interop component decoratorcomponent Name() {}
Legacy Turso-prefixed DB env aliasesVOX_DB_URL / VOX_DB_TOKEN
Sync recall APIrecall_async()
Persist-fact APIsync_to_db()