Agent Quick Reference
Agent Quick Reference
Section titled “Agent Quick Reference”Core CI Gates You Must Not Break
Section titled “Core CI Gates You Must Not Break”vox ci line-endings: LF only source formats limit. No CRLF allowed except for*.ps1.vox ci command-compliance: Check CLI compliance updates.vox stub-check(TOESTUB): Prevent submittingtodo!(),unimplemented!(),empty-bodies, or any stubs.vox ci sync-ignore-files: EnsuresAGENTS.mdrules and.voxignoreexclusions correctly sync to.cursorignoreand.aiignore.vox ci clavis-parity: Requires secret references securely bind toresolve_secret(...). No static env variables allowed! (CI command name retained for backward compat; checks againstsecrets-ssot.md.)
Documentation Rules Fast Track
Section titled “Documentation Rules Fast Track”- Do NOT read or modify files within
docs/src/archive/orarchive/for current work streams. - All new documentation requires comprehensive YAML frontmatter:
title,description,category,status,last_updated,training_eligible. - Inline code blocks across
.mdfiles should be explicitly imported using{{#include}}pointing toexamples/golden/files, OR manually prepended with// vox:skip.
Secret Management One-Liner
Section titled “Secret Management One-Liner”Never read std::env::var("SECRET"); exclusively employ vox_secrets::resolve_secret(...) and declare it in crates/vox-secrets/src/spec.rs.
Running Dev Environment
Section titled “Running Dev Environment”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 Surfaces Quick Map
Section titled “Retired Surfaces Quick Map”| Retired / Deprecated | Canonical Replacement (Use Instead) |
|---|---|
| Legacy orchestrator packaging | vox-orchestrator |
| Legacy ARS/OpenClaw predecessor crate | vox-openclaw-runtime |
| Legacy gamification crate label | vox-gamify |
| Legacy split compiler crates | vox-compiler |
| Legacy React-interop component decorator | component Name() {} |
| Legacy Turso-prefixed DB env aliases | VOX_DB_URL / VOX_DB_TOKEN |
| Sync recall API | recall_async() |
| Persist-fact API | sync_to_db() |
Entry Points
Section titled “Entry Points”- Full cross-agent definitions:
AGENTS.md - Governance strict rules:
docs/agents/governance.md - Contributor entry hub:
docs/src/contributors/contributor-hub.md