Skip to content
Unverified: This page has not yet been anchored to automated code tests.

vox-cli API Reference (generated)

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

Vox command-line interface: compile, run, bundle, and workspace diagnostics.

Shared library for the vox and vox-compilerd binaries.

For the end-user CLI surface and subcommand map, see the vox binary crate root (src/main.rs) and repository docs/src/reference/cli.md.

FeatureDefault / Enables
arsdep:vox-openclaw-runtime, dep:vox-skill-discovery
broken_inference_stub—
coderabbitdep:vox-cli-review
codex—
completion-toestubdep:vox-code-audit, vox-cli-ci/completion-toestub
databasevox-corpus/database
defaultkeyring-store, script-execution
dei—
execution-apiscript-execution, dep:tokio-stream
extras-ludusvox-gamify, dep:vox-code-audit
fuzzy-searchdep:nucleo
gui—
heavy-retrievalvox-search/tantivy-lexical, vox-search/web-scrape, vox-orchestrator-mcp/web-scrape
keyring-storedep:keyring
live—
ludus-hudextras-ludus
mcp-servervox-orchestrator/populi-transport, vox-orchestrator-mcp/populi-transport, dep:rmcp
mens-deidei, database
oratio—
scientia-socialvox-publisher/scientia-reddit, vox-publisher/scientia-twitter, vox-publisher/scientia-linkedin, vox-publisher/scientia-mastodon, vox-publisher/scientia-bluesky, vox-publisher/scientia-discord, vox-publisher/scientia-opencollective, vox-publisher/live-api-canary, vox-orchestrator/news-publish
script-executiondep:xxhash-rust, dep:landlock, dep:win32job
stub-checkdep:vox-code-audit, vox-gamify, completion-toestub
vox-gamifydep:vox-gamify
workflow-runtimemens-dei, dep:vox-workflow-runtime
DependencyKind
vox-actor-runtimeNormal
vox-auditNormal
vox-bounded-fsNormal
vox-capability-registryNormal
vox-cli-ciNormal
vox-cli-contractsNormal
vox-cli-coreNormal
vox-cli-researchNormal
vox-cli-reviewNormal
vox-cli-shareNormal
vox-code-auditNormal
vox-codegenNormal
vox-compilerNormal
vox-configNormal
vox-constrained-genNormal
vox-containerNormal
vox-corpusNormal
vox-cryptoNormal
vox-dbNormal
vox-deploy-codegenNormal
vox-doc-inventoryNormal
vox-doc-pipelineNormal
vox-drift-checkNormal
vox-effort-auditNormal
vox-effort-routeNormal
vox-evalNormal
vox-foundationNormal
vox-gamifyNormal
vox-gitNormal
vox-grammar-exportNormal
vox-graph-readerNormal
vox-http-clientNormal
vox-identityNormal
vox-jsonschema-utilNormal
vox-llm-egressNormal
vox-mcp-registryNormal
vox-mesh-typesNormal
vox-oauth-pkceNormal
vox-openclaw-runtimeNormal
vox-orchestratorNormal
vox-orchestrator-driverNormal
vox-orchestrator-mcpNormal
vox-packageNormal
vox-plugin-apiNormal
vox-plugin-catalogNormal
vox-plugin-hostNormal
vox-plugin-typesNormal
vox-populiNormal
vox-project-scaffoldNormal
vox-publisherNormal
vox-repositoryNormal
vox-research-eventsNormal
vox-research-shimNormal
vox-rn-codegenNormal
vox-rule-packNormal
vox-scaling-policyNormal
vox-scientiaNormal
vox-searchNormal
vox-secretsNormal
vox-skill-discoveryNormal
vox-skillsNormal
vox-sqlNormal
vox-tauri-codegenNormal
vox-telemetryNormal
vox-telemetry-otlpNormal
vox-termNormal
vox-workflow-runtimeNormal
vox-dbDevelopment
vox-orchestratorDevelopment
vox-sqlDevelopment
vox-build-metaBuild
ModuleDescription
cli_actions—
cli_args—
command_catalog—
commands—
compilerd—
config—
contributor_modeSpec §9.1 contributor-mode detector — see module docs for the exemption it implements.
dei_daemonExternal vox-orchestrator-d RPC boundary (method id SSOT).
diagnosticsColored CLI output helpers (print_info, print_success, …).
dispatchDaemon newline-JSON IPC (call_daemon, …) — SSOT in vox-cli-core::daemon_ipc.
dispatch_protocol—
freshnessBinary-freshness self-check (stale installed vox detection for vox ci * / vox doctor).
frontendVite/React scaffold helpers and shared pnpm executable resolution (pnpm_executable).
fs_utils—
fuzzyFuzzy ranking for command catalog, MCP tool picker, and dashboard palette. Gated behind the fuzzy-search feature; falls back to identity ordering when disabled.
pipeline—
process_supervision—
telemetry_corpus_feedback_sink—
telemetry_sink—
telemetry_spool—
templates—
workflow_journal_codex—
workspace_dbWorkspace journey VoxDb connect for repo-scoped CLI subcommands.
v0Legacy v0 integration helpers (external codegen API).
utils—
StructDescription
VoxCliRoot—
EnumDescription
CliCollection of subcommands exposing all features of the vox binary.
FunctionDescription
init_telemetry_sinksRegister the process-wide telemetry sinks. db is Some when the workspace journey DB opened successfully at startup.
run_vox_cliRun the vox CLI (parsed from std::env::args).
run_vox_cli_from_parsedRun after parsing a [VoxCliRoot]: global env hints (VOX_CLI_*, RUST_LOG), [init_tracing_for_cli], then dispatch.
ConstantDescription
VOX_VERSIONBuild version string: 0.x.y+build.N (githash)