Skip to content

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
CompletionShell—
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)
Dependency Topology, diagram 116 nodes, 15 edges: vox-cli → vox-actor-runtime; vox-cli → vox-audit; vox-cli → vox-bounded-fs; vox-cli → vox-build-meta; vox-cli → vox-capability-registry; vox-cli → vox-cli-ci; vox-cli → vox-cli-contracts; vox-cli → vox-cli-core; vox-cli → vox-cli-research; vox-cli → vox-cli-review; vox-cli → vox…vox-clivox-actor-runtimevox-auditvox-bounded-fsvox-build-metavox-capability-registryvox-cli-civox-cli-contractsvox-cli-corevox-cli-researchvox-cli-reviewvox-cli-sharevox-code-auditvox-cli-testsvox-guivox-integration-tests
Diagram source
graph {
direction: right
node vox_cli: "vox-cli"
node vox_actor_runtime: "vox-actor-runtime"
vox_cli -> vox_actor_runtime
node vox_audit: "vox-audit"
vox_cli -> vox_audit
node vox_bounded_fs: "vox-bounded-fs"
vox_cli -> vox_bounded_fs
node vox_build_meta: "vox-build-meta"
vox_cli -> vox_build_meta
node vox_capability_registry: "vox-capability-registry"
vox_cli -> vox_capability_registry
node vox_cli_ci: "vox-cli-ci"
vox_cli -> vox_cli_ci
node vox_cli_contracts: "vox-cli-contracts"
vox_cli -> vox_cli_contracts
node vox_cli_core: "vox-cli-core"
vox_cli -> vox_cli_core
node vox_cli_research: "vox-cli-research"
vox_cli -> vox_cli_research
node vox_cli_review: "vox-cli-review"
vox_cli -> vox_cli_review
node vox_cli_share: "vox-cli-share"
vox_cli -> vox_cli_share
node vox_code_audit: "vox-code-audit"
vox_cli -> vox_code_audit
node vox_cli_tests: "vox-cli-tests"
vox_cli_tests -> vox_cli
node vox_gui: "vox-gui"
vox_gui -> vox_cli
node vox_integration_tests: "vox-integration-tests"
vox_integration_tests -> vox_cli
}
Consumer CrateRole
vox-cli-testsDirect workspace dependent
vox-guiDirect workspace dependent
vox-integration-testsDirect workspace dependent
KindSymbolSignatureSourceDescription
enumCompletionShellpub enum CompletionShellcrates/vox-cli/src/lib.rs#L90-L99—
structVoxCliRootpub struct VoxCliRootcrates/vox-cli/src/lib.rs#L123-L130—
enumClipub enum Clicrates/vox-cli/src/lib.rs#L135Collection of subcommands exposing all features of the vox binary.
fninit_telemetry_sinkspub fn init_telemetry_sinks(db: Option<vox_db::VoxDb>)crates/vox-cli/src/lib.rs#L742-L745Register the process-wide telemetry sinks. db is Some when the workspace journey DB opened successfully at startup.
fnrun_vox_clipub async fn run_vox_cli() -> anyhow::Result<()>crates/vox-cli/src/lib.rs#L825-L828Run the vox CLI (parsed from std::env::args).
fnrun_vox_cli_from_parsedpub async fn run_vox_cli_from_parsed(root: VoxCliRoot) -> anyhow::Result<()>crates/vox-cli/src/lib.rs#L832-L856Run after parsing a [VoxCliRoot]: global env hints (VOX_CLI_*, RUST_LOG), [init_tracing_for_cli], then dispatch.
enumcli_actions::ArchitectActionpub enum ArchitectActioncrates/vox-cli/src/cli_actions.rs#L5-L20Subcommands for vox architect (requires --features codex or stub-check).
enumcli_actions::WorkflowActionpub enum WorkflowActioncrates/vox-cli/src/cli_actions.rs#L23-L64—
enumcli_args::BuildTargetArgpub enum BuildTargetArgcrates/vox-cli/src/cli_args.rs#L16-L28Build target for vox build / vox dev. See vox_config::BuildTarget for semantics. fullstack is the default build mode. Use --target=server for Rust-only (no dist/ TS), or --target=client for Library-shaped TS (vox-client.ts, openapi.json, …; no target/generated/), or --target=mobile for React Native + Expo TS that runs through @vox/runtime-rn.
structcli_args::BuildArgspub struct BuildArgscrates/vox-cli/src/cli_args.rs#L43-L80vox build / vox fabrica build
structcli_args::CheckArgspub struct CheckArgscrates/vox-cli/src/cli_args.rs#L84-L117vox check / vox fabrica check
structcli_args::TestArgspub struct TestArgscrates/vox-cli/src/cli_args.rs#L121-L139vox test / vox fabrica test
structcli_args::RunArgspub struct RunArgscrates/vox-cli/src/cli_args.rs#L143-L181vox run / vox fabrica run
structcli_args::ScriptArgspub struct ScriptArgscrates/vox-cli/src/cli_args.rs#L186-L200vox script / vox fabrica script
structcli_args::DevArgspub struct DevArgscrates/vox-cli/src/cli_args.rs#L204-L216vox dev / vox fabrica dev
structcli_args::EmitOpenapiArgspub struct EmitOpenapiArgscrates/vox-cli/src/cli_args.rs#L220-L233vox emit openapi — standalone OpenAPI 3.1 JSON from a Vox source file.
structcli_args::EmitClientArgspub struct EmitClientArgscrates/vox-cli/src/cli_args.rs#L237-L246vox emit client — Library-shaped TypeScript SDK only.
structcli_args::BundleArgspub struct BundleArgscrates/vox-cli/src/cli_args.rs#L250-L262vox bundle / vox fabrica bundle
structcli_args::CompileArgspub struct CompileArgscrates/vox-cli/src/cli_args.rs#L266-L286vox compile / vox fabrica compile
structcli_args::FmtArgspub struct FmtArgscrates/vox-cli/src/cli_args.rs#L323-L329vox fmt / vox fabrica fmt
structcli_args::PlayArgspub struct PlayArgscrates/vox-cli/src/cli_args.rs#L333-L339vox play / vox fabrica play
structcli_args::DoctorArgspub struct DoctorArgscrates/vox-cli/src/cli_args.rs#L345-L380vox doctor / vox mens doctor
structcli_args::StubCheckArgspub struct StubCheckArgscrates/vox-cli/src/cli_args.rs#L385-L437vox stub-check / vox mens stub-check
structcli_args::AddDependencyArgspub struct AddDependencyArgscrates/vox-cli/src/cli_args.rs#L441-L451vox add — manifest dependency declaration.
structcli_args::RemoveDependencyArgspub struct RemoveDependencyArgscrates/vox-cli/src/cli_args.rs#L455-L458vox remove
structcli_args::LockArgspub struct LockArgscrates/vox-cli/src/cli_args.rs#L462-L466vox lock
structcli_args::SyncArgspub struct SyncArgscrates/vox-cli/src/cli_args.rs#L470-L476vox sync
structcli_args::DeployArgspub struct DeployArgscrates/vox-cli/src/cli_args.rs#L480-L499vox deploy — apply Vox.toml [deploy] via container / compose / Kubernetes / bare-metal.
enumcli_args::UpgradeReleaseProviderpub enum UpgradeReleaseProvidercrates/vox-cli/src/cli_args.rs#L503-L511Binary release host for vox upgrade --source release (VOX_UPGRADE_PROVIDER).
structcli_args::UpgradeToolchainArgspub struct UpgradeToolchainArgscrates/vox-cli/src/cli_args.rs#L515-L564vox upgrade — toolchain only (never Vox.toml / vox.lock).
structcli_args::GenerateArgspub struct GenerateArgscrates/vox-cli/src/cli_args.rs#L568-L588vox generate — generate Vox code from a natural-language prompt.
enumcommand_catalog::CatalogFormatpub enum CatalogFormatcrates/vox-cli/src/command_catalog.rs#L10-L13—
enumcommand_catalog::ArgValueKindpub enum ArgValueKindcrates/vox-cli/src/command_catalog.rs#L20-L27Typed argument kind for GUI form generation, derived from the clap action.
structcommand_catalog::CommandCatalogArgumentpub struct CommandCatalogArgumentcrates/vox-cli/src/command_catalog.rs#L30-L45—
structcommand_catalog::CommandCatalogEntrypub struct CommandCatalogEntrycrates/vox-cli/src/command_catalog.rs#L48-L63—
structcommand_catalog::CommandCatalogpub struct CommandCatalogcrates/vox-cli/src/command_catalog.rs#L66-L69—
fncommand_catalog::feature_gated_group_namespub fn feature_gated_group_names() -> Vec<(&'static str, &'static str)>crates/vox-cli/src/command_catalog.rs#L82-L94Top-level command groups that exist only behind a compile-time feature gate and are therefore absent from a default (non-dei) binary’s clap command tree. build_catalog() reflects over VoxCliRoot::command(), which is built at compile time, so #[cfg(feature = "dei")] clap variants (crates/vox-cli/src/lib.rs) are invisible to any consumer derived from the catalog (e.g. the GUI surface-registry gate). Callers that must reason about the full command surface — not just what this build compiled in — should union these (group, feature) pairs with the compiled groups. Returns (group_name, feature_flag) pairs. The names are the clap-derived (lowercased) top-level command names.
fncommand_catalog::build_catalogpub fn build_catalog() -> CommandCatalogcrates/vox-cli/src/command_catalog.rs#L96-L124—
fncommand_catalog::render_textpub fn render_text(entries: &[CommandCatalogEntry]) -> Stringcrates/vox-cli/src/command_catalog.rs#L144-L163—
fncommand_catalog::render_nushell_completionspub fn render_nushell_completions(catalog: &CommandCatalog) -> Stringcrates/vox-cli/src/command_catalog.rs#L166-L226Renders dynamic Nushell completion signatures (extern "vox" [...] and extern "vox <subcommand>" [...]).
fncommand_catalog::select_entriespub fn select_entries(crates/vox-cli/src/command_catalog.rs#L228—
fncommand_catalog::search_entriespub fn search_entries(crates/vox-cli/src/command_catalog.rs#L267Filter and rank entries by fuzzy match against pattern. Candidates are built from command, all aliases, and about so that alias-only matches (e.g. "fab" → vox fabrica) are surfaced. Returns entries sorted by descending score; zero-score entries excluded. Falls back to case-insensitive substring filter when fuzzy-search is disabled.
structcommand_catalog::SearchResultpub struct SearchResultcrates/vox-cli/src/command_catalog.rs#L283-L291A search hit carrying both the matched entry and its match score. score is non-zero when the fuzzy-search feature is enabled (nucleo score; higher = better match) and 0 for the substring-fallback path (where ordering is preserved from the input).
fncommand_catalog::search_entries_scoredpub fn search_entries_scored(crates/vox-cli/src/command_catalog.rs#L295Same as [search_entries] but returns scores and match attribution for JSON output and richer rendering.
structcommand_catalog::SearchOutputpub struct SearchOutputcrates/vox-cli/src/command_catalog.rs#L356-L361JSON wrapper for search-mode output (richer than [CommandCatalog]).