Skip to content

vox-cli-ci API Reference (generated)

Crate: vox-cli-ci · Version: 0.6.0 · Target: Library (lib.rs)

CI guard checks extracted from vox-cli (line-endings, workflow-concurrency-guard, …).

Repository CI guard checks extracted from vox-cli (vox ci * implementation wedge).

FeatureDefault / Enables
completion-toestubdep:vox-code-audit
DependencyKind
vox-bounded-fsNormal
vox-capability-registryNormal
vox-cli-contractsNormal
vox-cli-coreNormal
vox-code-auditNormal
vox-compilerNormal
vox-configNormal
vox-cryptoNormal
vox-dbNormal
vox-doc-inventoryNormal
vox-doc-pipelineNormal
vox-gitNormal
vox-grammar-exportNormal
vox-graph-readerNormal
vox-http-clientNormal
vox-jsonschema-utilNormal
vox-mcp-registryNormal
vox-orchestratorNormal
vox-orchestrator-mcpNormal
vox-plugin-apiNormal
vox-plugin-catalogNormal
vox-plugin-hostNormal
vox-plugin-typesNormal
vox-publisherNormal
vox-repositoryNormal
vox-rule-packNormal
vox-scaling-policyNormal
vox-secretsNormal
vox-telemetryNormal
ModuleDescription
affected—
benchmark_telemetry—
build_bench—
build_timings—
completion_quality—
constants—
coolify_eval—
corpus_integrity—
coverage_gates—
crate_api_docs—
crate_edges—
data_storage_guard—
dep_cycles—
determinism_audit—
grammar_ssot_parity—
gui_smoke—
helpers—
job_timings—
mcp_vox_surface_parity—
mens_scorecard—
overlay_parity—
retired_symbol_check—
scaling_audit—
scientia_novelty_ledger_contract—
speech_runtime_suite—
version_ssot—
watch_run—
affected_cmd—
agentskills_compliance—
ai_fixtures_coverage—
attention_ledger_parity—
attention_parity—
cache_key_lint—
canonical_docs—
capability_snapshot—
check_changed—
check_links—
ci_changes—
cmd_enums—
commit_lint—
compile_matrix—
config_aggregate—
config_gui_codegen—
config_hygiene—
config_registry_parity—
contracts_index—
crate_budget—
crate_build_map_parity—
db_schema_coverage—
dep_sprawl—
deploy_status—
detect_rules_bench—
dev_loop_audit—
dev_loop_guard—
docs_deprecated_command_guard—
docs_reality_audit—
doctest_md—
doctor_build_cache—
dom_test_env_ban—
evidence_asset_ban—
fan_in_budget—
free_binary—
generate_plugin_catalog_docs—
gui_command_backends—
gui_coverage_exemptions—
gui_honesty—
gui_surface_coverage—
gui_version_sync—
gui_visual_review—
harness_trust_guard—
hit_every_surface—
install_hooks—
kb_facets_ts—
kill_stuck_tests—
knip_gui—
line_endings—
model_routing_check—
no_plugin_cdylib_as_compile_dep—
no_tauri_in_core—
node_pnpm_ssot_guard—
nomenclature_guard—
openclaw_contract—
package_manifests—
parse_check—
parse_status—
plugin_abi_parity—
plugin_catalog_parity—
plugin_catalog_sync—
plugin_dep_boundary—
plugin_skill_parity—
plugin_surface—
pm_provenance—
pre_push_refs—
preview_trust_audit—
profile_parity—
publish_dry_run—
release_draft_guard—
required_context_guard—
retirement_audit—
row_serde_lint—
safety_inventory—
sccache_workflow_guard—
scientia_heuristics_parity—
scientia_worthiness_contract—
status—
string_id_lint—
suppression_review_gate—
sync_ignore_files—
test_governance—
test_inventory—
test_runtime_report—
tier_budget_check—
toestub_budget—
toolchain_ssot—
toolchain_workflow_lint—
transfer_budget_report—
vouched_parse—
workflow_concurrency_guard—
workflow_permissions_guard—
workflow_policy_guard—
workspace_artifacts—
TraitDescription
HeavyGuardHostSeam for the Tier-2 vox ci guards that stay in vox-cli because they reach into its internals (command_catalog, command_registry_model, utils, fs_utils, commands::runtime). The moved dispatcher (run::run) calls dispatch_heavy(&cmd) first; vox-cli implements it on VoxCliProviders. Extends GateStatusWriter so the dispatcher can also record per-gate status through the same host object.
Dependency Topology, diagram 115 nodes, 14 edges: vox-cli-ci → vox-bounded-fs; vox-cli-ci → vox-capability-registry; vox-cli-ci → vox-cli-contracts; vox-cli-ci → vox-cli-core; vox-cli-ci → vox-code-audit; vox-cli-ci → vox-compiler; vox-cli-ci → vox-config; vox-cli-ci → vox-crypto; vox-cli-ci → vox-db; vox-cli-ci → vox-doc-inven…vox-cli-civox-bounded-fsvox-capability-registryvox-cli-contractsvox-cli-corevox-code-auditvox-compilervox-configvox-cryptovox-dbvox-doc-inventoryvox-doc-pipelinevox-gitvox-clivox-cli-research
Diagram source
graph {
direction: right
node vox_cli_ci: "vox-cli-ci"
node vox_bounded_fs: "vox-bounded-fs"
vox_cli_ci -> vox_bounded_fs
node vox_capability_registry: "vox-capability-registry"
vox_cli_ci -> vox_capability_registry
node vox_cli_contracts: "vox-cli-contracts"
vox_cli_ci -> vox_cli_contracts
node vox_cli_core: "vox-cli-core"
vox_cli_ci -> vox_cli_core
node vox_code_audit: "vox-code-audit"
vox_cli_ci -> vox_code_audit
node vox_compiler: "vox-compiler"
vox_cli_ci -> vox_compiler
node vox_config: "vox-config"
vox_cli_ci -> vox_config
node vox_crypto: "vox-crypto"
vox_cli_ci -> vox_crypto
node vox_db: "vox-db"
vox_cli_ci -> vox_db
node vox_doc_inventory: "vox-doc-inventory"
vox_cli_ci -> vox_doc_inventory
node vox_doc_pipeline: "vox-doc-pipeline"
vox_cli_ci -> vox_doc_pipeline
node vox_git: "vox-git"
vox_cli_ci -> vox_git
node vox_cli: "vox-cli"
vox_cli -> vox_cli_ci
node vox_cli_research: "vox-cli-research"
vox_cli_research -> vox_cli_ci
}
Consumer CrateRole
vox-cliDirect workspace dependent
vox-cli-researchDirect workspace dependent
KindSymbolSignatureSourceDescription
traitHeavyGuardHostpub trait HeavyGuardHost: vox_cli_contracts::GateStatusWritercrates/vox-cli-ci/src/lib.rs#L8-L16Seam for the Tier-2 vox ci guards that stay in vox-cli because they reach into its internals (command_catalog, command_registry_model, utils, fs_utils, commands::runtime). The moved dispatcher (run::run) calls dispatch_heavy(&cmd) first; vox-cli implements it on VoxCliProviders. Extends GateStatusWriter so the dispatcher can also record per-gate status through the same host object.
fnaffected::is_sentinelpub fn is_sentinel(path: &str) -> boolcrates/vox-cli-ci/src/affected.rs#L28-L30—
fnaffected::contracts_outside_graph_force_fullpub fn contracts_outside_graph_force_full(changed_files: &[String]) -> boolcrates/vox-cli-ci/src/affected.rs#L39-L45Non-graph contracts/** edits can change SSOT surfaces workspace-wide; force a full PR gate. Generated reports are the exception (see [GENERATED_CONTRACT_REPORTS]); every other contracts path still forces a full run, so a new reader of a contract can never be skipped.
fnaffected::ci_workflow_force_fullpub fn ci_workflow_force_full(changed_files: &[String]) -> boolcrates/vox-cli-ci/src/affected.rs#L48-L52CI workflow edits can change gate behavior workspace-wide; force a full PR gate.
fnaffected::file_to_cratepub fn file_to_crate(path: &str) -> Option<&str>crates/vox-cli-ci/src/affected.rs#L54-L58—
structaffected::PathFlagspub struct PathFlagscrates/vox-cli-ci/src/affected.rs#L61-L68—
fnaffected::compute_path_flagspub fn compute_path_flags(changed_files: &[String]) -> PathFlagscrates/vox-cli-ci/src/affected.rs#L70-L101—
fnaffected::invertpub fn invert(graph: &BTreeMap<String, Vec<String>>) -> BTreeMap<String, BTreeSet<String>>crates/vox-cli-ci/src/affected.rs#L103-L112—
fnaffected::reverse_closurepub fn reverse_closure(crates/vox-cli-ci/src/affected.rs#L114—
fnaffected::set_includes_compilerpub fn set_includes_compiler(set: &BTreeSet<String>) -> boolcrates/vox-cli-ci/src/affected.rs#L136-L138—
enumaffected::Affectedpub enum Affectedcrates/vox-cli-ci/src/affected.rs#L141-L145—
fnaffected::compute_affectedpub fn compute_affected(crates/vox-cli-ci/src/affected.rs#L147—
fnaffected::shadow_missespub fn shadow_misses(junit_xml: &str, affected: &BTreeSet<String>) -> Vec<String>crates/vox-cli-ci/src/affected.rs#L175-L203Parse nextest JUnit for failing tests; return crate names not in affected.
structaffected_cmd::CrateGraphpub struct CrateGraphcrates/vox-cli-ci/src/affected_cmd.rs#L5-L8—
fnaffected_cmd::graph_from_metadatapub fn graph_from_metadata(meta: &serde_json::Value) -> CrateGraphcrates/vox-cli-ci/src/affected_cmd.rs#L10-L50—
fnaffected_cmd::regen_graphpub fn regen_graph(out_path: &std::path::Path) -> Result<(), String>crates/vox-cli-ci/src/affected_cmd.rs#L52-L70—
fnaffected_cmd::check_graphpub fn check_graph(committed: &std::path::Path) -> Result<(), String>crates/vox-cli-ci/src/affected_cmd.rs#L72-L90—
fnaffected_cmd::partition_cratespub fn partition_crates(weights: &[(String, u64)], n: usize) -> Vec<Vec<String>>crates/vox-cli-ci/src/affected_cmd.rs#L103-L124Split crates into at most n groups of near-equal weight (longest-processing-time greedy: heaviest first, each into the currently lightest group). Each CI shard then compiles and runs only its own group’s test binaries — compiling every test binary in every shard (hash sharding) cost 17-19 min per shard. Empty groups are dropped; ties break by name.
fnaffected_cmd::run_affected_cmdpub fn run_affected_cmd(args: &[String]) -> i32crates/vox-cli-ci/src/affected_cmd.rs#L181—
fnagentskills_compliance::runpub fn run() -> Result<()>crates/vox-cli-ci/src/agentskills_compliance.rs#L86—
fnai_fixtures_coverage::runpub fn run(repo_root: &Path) -> Result<()>crates/vox-cli-ci/src/ai_fixtures_coverage.rs#L15-L55Verify AI fixture catalog parity against shipped parser + HIR surfaces.
fnattention_ledger_parity::runpub fn run(root: &Path) -> Result<()>crates/vox-cli-ci/src/attention_ledger_parity.rs#L16-L54—
fnattention_parity::runpub fn run(root: &Path) -> Result<()>crates/vox-cli-ci/src/attention_parity.rs#L5-L38—
fnbenchmark_telemetry::record_optpub async fn record_opt(name: &str, metric_value: Option<f64>, details: Option<serde_json::Value>)crates/vox-cli-ci/src/benchmark_telemetry.rs#L74-L76Async: connect and write one benchmark row (no-op unless VOX_BENCHMARK_TELEMETRY is set).
fnbenchmark_telemetry::record_opt_with_unitpub async fn record_opt_with_unit(crates/vox-cli-ci/src/benchmark_telemetry.rs#L79Like [record_opt] but forwards metric_value_unit (e.g. "seconds") to Codex.
fnbenchmark_telemetry::record_syntax_k_optpub async fn record_syntax_k_opt(crates/vox-cli-ci/src/benchmark_telemetry.rs#L128Async: connect and write one syntax-k telemetry row (no-op unless telemetry env is enabled).
fnbenchmark_telemetry::record_opt_blockingpub fn record_opt_blocking(crates/vox-cli-ci/src/benchmark_telemetry.rs#L164Blocking variant for sync CLI paths (no Tokio handle required).
fnbenchmark_telemetry::record_opt_with_unit_blockingpub fn record_opt_with_unit_blocking(crates/vox-cli-ci/src/benchmark_telemetry.rs#L173Blocking variant for sync CLI paths that includes a metric unit.
fnbenchmark_telemetry::record_syntax_k_opt_blockingpub fn record_syntax_k_opt_blocking(crates/vox-cli-ci/src/benchmark_telemetry.rs#L231Blocking variant for sync syntax-k telemetry paths.
structbuild_bench::TimingEntrypub struct TimingEntrycrates/vox-cli-ci/src/build_bench.rs#L18-L21—
fnbuild_bench::extract_unit_datapub fn extract_unit_data(html: &str) -> Vec<TimingEntry>crates/vox-cli-ci/src/build_bench.rs#L30-L60Parse the embedded UNIT_DATA JS array from a cargo —timings HTML file. cargo emits const UNIT_DATA = [ {..}, .. ]; where each entry’s duration is float seconds (e.g. 9.37). We convert to whole milliseconds and drop zero-duration units (cached / no-rebuild). We do NOT filter on mode: in a cached/sccache build the real compile rows carry mode:"todo" with a nonzero duration, so a mode filter would discard exactly the data we want.
fnbuild_bench::find_newest_timings_htmlpub fn find_newest_timings_html(repo_root: &Path) -> Option<std::path::PathBuf>crates/vox-cli-ci/src/build_bench.rs#L63-L74Return the most-recently-modified cargo-timing-*.html under target/cargo-timings/.
structbuild_bench::HistoryRecordpub struct HistoryRecordcrates/vox-cli-ci/src/build_bench.rs#L77-L80—
fnbuild_bench::append_to_historypub fn append_to_history(history_path: &Path, run_id: &str, entries: &[TimingEntry]) -> Result<()>crates/vox-cli-ci/src/build_bench.rs#L83-L101Append one JSONL record to the history file (create if absent).
structbuild_bench::Scenariopub struct Scenariocrates/vox-cli-ci/src/build_bench.rs#L104-L108—
structbuild_bench::ScenarioFilepub struct ScenarioFilecrates/vox-cli-ci/src/build_bench.rs#L111-L114—
structbuild_bench::BenchRecordpub struct BenchRecordcrates/vox-cli-ci/src/build_bench.rs#L117-L121—
structbuild_bench::Snapshotpub struct Snapshotcrates/vox-cli-ci/src/build_bench.rs#L124-L132—
fnbuild_bench::current_hostpub fn current_host() -> Stringcrates/vox-cli-ci/src/build_bench.rs#L139-L141Host identifier for a snapshot written now, e.g. "x86_64-windows". arch-os rather than the full target triple: std::env::consts gives these without a build script, and the distinction that matters for wall-clock comparison is the machine class, not the ABI suffix.
fnbuild_bench::host_mismatch_warningpub fn host_mismatch_warning(baseline_host: Option<&str>, current: &str) -> Option<String>crates/vox-cli-ci/src/build_bench.rs#L150-L160Warn when a baseline was timed on a different host than the current run. Scenario wall-clock is host-bound far more strongly than per-crate self-time: a Windows-measured baseline compared against a Linux CI run produces a large delta on every scenario that reflects the machine, not the code. Returns None when the baseline predates provenance, so pre-existing files do not emit a warning on every run — the dynamic that gets warnings ignored.
fnbuild_bench::by_idpub fn by_id(&self) -> BTreeMap<&str, &BenchRecord>crates/vox-cli-ci/src/build_bench.rs#L163-L165—
structbuild_bench::DeltaRowpub struct DeltaRowcrates/vox-cli-ci/src/build_bench.rs#L169-L175—
fnbuild_bench::compute_deltaspub fn compute_deltas(base: &Snapshot, new: &Snapshot) -> Vec<DeltaRow>crates/vox-cli-ci/src/build_bench.rs#L177-L204—
fnbuild_bench::baseline_is_unpopulatedpub fn baseline_is_unpopulated(base: &Snapshot) -> boolcrates/vox-cli-ci/src/build_bench.rs#L213-L222True when base is a committed placeholder rather than a real measurement: it has at least one ok record and every ok record is wall_ms == 0. This matters because [compute_deltas] defines pct as 0.0 whenever the base is zero, so an unpopulated baseline makes every scenario report a 0% delta and the gate can never fail. A real cargo check scenario cannot measure 0 ms, so all-zero is unambiguously “never filled in”.
fnbuild_bench::format_delta_markdownpub fn format_delta_markdown(label: &str, rows: &[DeltaRow]) -> Stringcrates/vox-cli-ci/src/build_bench.rs#L224-L235—