Skip to content

vox-cli-core API Reference (generated)

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

Shared internals for the vox CLI binary (argv parsing helpers, exit-code policy).

Shared library for CLI primitives.

FeatureDefault / Enables
dbdep:vox-db, dep:vox-gamify, dep:vox-repository
defaultdb, orchestrator
orchestratordep:vox-orchestrator, dep:vox-orchestrator-driver
DependencyKind
vox-configNormal
vox-dbNormal
vox-foundationNormal
vox-gamifyNormal
vox-orchestratorNormal
vox-orchestrator-driverNormal
vox-repositoryNormal
vox-secretsNormal
vox-bounded-fsDevelopment
vox-jsonschema-utilDevelopment
ModuleDescription
artifact_policy—
benchmark_telemetry—
build_service—
catalog_tier—
cli_actions—
cli_args—
command_contract—
command_registry_model—
contributor_mode—
constants—
daemon_ipc—
db_types—
diagnostics—
fs_utils—
gamify_shim—
market—
ml_cli_handshake—
orchestrator_driver—
scientia—
workflow_journal_codex—
StructDescription
GlobalOptsGlobal flags available before every subcommand.
FunctionDescription
init_tracing_for_cliInitialize [tracing] for CLI tools.
apply_global_optsApply global opts to the environment.
Dependency Topology, diagram 118 nodes, 17 edges: vox-cli-core → vox-bounded-fs; vox-cli-core → vox-config; vox-cli-core → vox-db; vox-cli-core → vox-foundation; vox-cli-core → vox-gamify; vox-cli-core → vox-jsonschema-util; vox-cli-core → vox-orchestrator; vox-cli-core → vox-orchestrator-driver; vox-cli-core → vox-repository; …vox-cli-corevox-bounded-fsvox-configvox-dbvox-foundationvox-gamifyvox-jsonschema-utilvox-orchestratorvox-orchestrator-drivervox-repositoryvox-secretsvox-clivox-cli-civox-cli-researchvox-guivox-langtoolvox-ml-clivox-orchestrator-mcp
Diagram source
graph {
direction: right
node vox_cli_core: "vox-cli-core"
node vox_bounded_fs: "vox-bounded-fs"
vox_cli_core -> vox_bounded_fs
node vox_config: "vox-config"
vox_cli_core -> vox_config
node vox_db: "vox-db"
vox_cli_core -> vox_db
node vox_foundation: "vox-foundation"
vox_cli_core -> vox_foundation
node vox_gamify: "vox-gamify"
vox_cli_core -> vox_gamify
node vox_jsonschema_util: "vox-jsonschema-util"
vox_cli_core -> vox_jsonschema_util
node vox_orchestrator: "vox-orchestrator"
vox_cli_core -> vox_orchestrator
node vox_orchestrator_driver: "vox-orchestrator-driver"
vox_cli_core -> vox_orchestrator_driver
node vox_repository: "vox-repository"
vox_cli_core -> vox_repository
node vox_secrets: "vox-secrets"
vox_cli_core -> vox_secrets
node vox_cli: "vox-cli"
vox_cli -> vox_cli_core
node vox_cli_ci: "vox-cli-ci"
vox_cli_ci -> vox_cli_core
node vox_cli_research: "vox-cli-research"
vox_cli_research -> vox_cli_core
node vox_gui: "vox-gui"
vox_gui -> vox_cli_core
node vox_langtool: "vox-langtool"
vox_langtool -> vox_cli_core
node vox_ml_cli: "vox-ml-cli"
vox_ml_cli -> vox_cli_core
node vox_orchestrator_mcp: "vox-orchestrator-mcp"
vox_orchestrator_mcp -> vox_cli_core
}
Consumer CrateRole
vox-cliDirect workspace dependent
vox-cli-ciDirect workspace dependent
vox-cli-researchDirect workspace dependent
vox-guiDirect workspace dependent
vox-langtoolDirect workspace dependent
vox-ml-cliDirect workspace dependent
vox-orchestrator-mcpDirect workspace dependent
KindSymbolSignatureSourceDescription
structGlobalOptspub struct GlobalOptscrates/vox-cli-core/src/lib.rs#L36-L49Global flags available before every subcommand.
fninit_tracing_for_clipub fn init_tracing_for_cli()crates/vox-cli-core/src/lib.rs#L52-L54Initialize [tracing] for CLI tools.
fnapply_global_optspub fn apply_global_opts(opts: &GlobalOpts)crates/vox-cli-core/src/lib.rs#L58-L62Apply global opts to the environment.
enumartifact_policy::ArtifactClasspub enum ArtifactClasscrates/vox-cli-core/src/artifact_policy.rs#L5-L13—
enumartifact_policy::TargetLanepub enum TargetLanecrates/vox-cli-core/src/artifact_policy.rs#L16-L22—
fnartifact_policy::canonical_workspace_targetpub fn canonical_workspace_target(root: &Path) -> PathBufcrates/vox-cli-core/src/artifact_policy.rs#L24-L28—
fnartifact_policy::transient_lane_rootspub fn transient_lane_roots(root: &Path) -> [PathBuf; 2]crates/vox-cli-core/src/artifact_policy.rs#L43-L46Isolated Cargo target dirs for this repo under OS temp (…/vox-targets/<hash>/…).
fnartifact_policy::ci_nested_targetpub fn ci_nested_target(root: &Path) -> PathBufcrates/vox-cli-core/src/artifact_policy.rs#L48-L52—
fnartifact_policy::gate_isolated_targetpub fn gate_isolated_target(root: &Path) -> PathBufcrates/vox-cli-core/src/artifact_policy.rs#L54-L58—
fnartifact_policy::is_allowed_artifact_pathpub fn is_allowed_artifact_path(path: &Path, root: &Path) -> boolcrates/vox-cli-core/src/artifact_policy.rs#L61-L102True when path may be used as CARGO_TARGET_DIR (or similar) for this workspace.
fnbenchmark_telemetry::record_optpub async fn record_opt(name: &str, metric_value: Option<f64>, details: Option<serde_json::Value>)crates/vox-cli-core/src/benchmark_telemetry.rs#L40-L53Async: connect and write one benchmark row.
fnbenchmark_telemetry::record_opt_blockingpub fn record_opt_blocking(crates/vox-cli-core/src/benchmark_telemetry.rs#L56Blocking variant for sync CLI paths.
fnbuild_service::set_correlation_idpub fn set_correlation_id(id: String)crates/vox-cli-core/src/build_service.rs#L14-L16—
structbuild_service::PeriodicWaitLoggerpub struct PeriodicWaitLoggercrates/vox-cli-core/src/build_service.rs#L18—
fnbuild_service::startpub fn start() -> Selfcrates/vox-cli-core/src/build_service.rs#L21-L23—
fnbuild_service::log_spawn_startpub fn log_spawn_start(crates/vox-cli-core/src/build_service.rs#L26—
fnbuild_service::log_spawn_completepub fn log_spawn_complete(crates/vox-cli-core/src/build_service.rs#L44—
structbuild_service::CargoRequestpub struct CargoRequestcrates/vox-cli-core/src/build_service.rs#L82-L95Request for a Cargo invocation (BL064).
fnbuild_service::buildpub fn build(cwd: PathBuf, target_dir: Option<PathBuf>, args: impl Into<Vec<String>>) -> Selfcrates/vox-cli-core/src/build_service.rs#L99-L109Create a build request.
fnbuild_service::checkpub fn check(cwd: PathBuf, target_dir: Option<PathBuf>) -> Selfcrates/vox-cli-core/src/build_service.rs#L112-L122Create a check request.
fnbuild_service::testpub fn test(cwd: PathBuf, target_dir: Option<PathBuf>, args: impl Into<Vec<String>>) -> Selfcrates/vox-cli-core/src/build_service.rs#L125-L135Create a test request.
fnbuild_service::runpub fn run(crates/vox-cli-core/src/build_service.rs#L138Create a run request.
fnbuild_service::run_cargopub fn run_cargo(req: &CargoRequest) -> Result<Output>crates/vox-cli-core/src/build_service.rs#L157-L222Run a Cargo command with telemetry and return output (BL060).
fnbuild_service::run_cargo_statuspub fn run_cargo_status(req: &CargoRequest) -> Result<std::process::ExitStatus>crates/vox-cli-core/src/build_service.rs#L225-L227Run cargo and return status (for fire-and-forget or status-only callers).
fnbuild_service::run_cargo_inheritpub fn run_cargo_inherit(req: &CargoRequest) -> Result<std::process::ExitStatus>crates/vox-cli-core/src/build_service.rs#L230-L295Run cargo with inherited stdout/stderr (for bundle UX). No stderr capture for telemetry.
structbuild_service::MonitoredCargoChildSyncpub struct MonitoredCargoChildSynccrates/vox-cli-core/src/build_service.rs#L298-L313Sync wrapper that logs spawn completion when the child exits (Wave 3).
fnbuild_service::waitpub fn wait(&mut self) -> std::io::Result<std::process::ExitStatus>crates/vox-cli-core/src/build_service.rs#L317-L331Wait for the child and log completion.
fnbuild_service::run_cargo_spawnpub fn run_cargo_spawn(req: &CargoRequest) -> Result<MonitoredCargoChildSync>crates/vox-cli-core/src/build_service.rs#L360-L420Spawn cargo and return monitored std child (sync). Logs completion on exit (Wave 3).
structbuild_service::MonitoredCargoChildpub struct MonitoredCargoChildcrates/vox-cli-core/src/build_service.rs#L423-L438Wrapper that logs spawn completion when the child exits (Wave 3).
fnbuild_service::killpub async fn kill(&mut self) -> std::io::Result<()>crates/vox-cli-core/src/build_service.rs#L442-L460Kill the child, wait for exit, and log completion.
fnbuild_service::waitpub async fn wait(&mut self) -> Result<std::process::ExitStatus>crates/vox-cli-core/src/build_service.rs#L463-L481Wait for the child and log completion.
fnbuild_service::run_cargo_spawn_asyncpub async fn run_cargo_spawn_async(req: &CargoRequest) -> Result<MonitoredCargoChild>crates/vox-cli-core/src/build_service.rs#L511-L571Spawn cargo and return monitored tokio child (async, for dev/watch). Logs completion on exit (Wave 3).
fnbuild_service::run_vox_buildpub async fn run_vox_build(file: &std::path::Path, out_dir: &std::path::Path) -> Result<()>crates/vox-cli-core/src/build_service.rs#L574-L586Build a Vox project (equivalent to vox build <file> -o <out_dir>) for workflow execution.
enumcatalog_tier::CatalogTierpub enum CatalogTiercrates/vox-cli-core/src/catalog_tier.rs#L5-L9—
fncatalog_tier::tier_for_pathpub fn tier_for_path(path: &[String], feature_gated: bool) -> CatalogTiercrates/vox-cli-core/src/catalog_tier.rs#L11-L25—
enumcli_actions::ArchitectActionpub enum ArchitectActioncrates/vox-cli-core/src/cli_actions.rs#L6-L19—
enumcli_actions::WorkflowActionpub enum WorkflowActioncrates/vox-cli-core/src/cli_actions.rs#L22-L53—
enumcli_args::BuildModepub enum BuildModecrates/vox-cli-core/src/cli_args.rs#L8-L14Build mode (app or library).
enumcli_args::BundleModepub enum BundleModecrates/vox-cli-core/src/cli_args.rs#L18-L24Bundling mode: app (web + backend) or script (binary only).
enumcli_args::CompileKindpub enum CompileKindcrates/vox-cli-core/src/cli_args.rs#L29-L45vox compile --target … packaging lane.
enumcli_args::UpgradeLanepub enum UpgradeLanecrates/vox-cli-core/src/cli_args.rs#L49-L55vox upgrade lane: release binary vs local repository checkout.
fncommand_contract::merged_feature_gate_from_vox_cli_opspub fn merged_feature_gate_from_vox_cli_ops(crates/vox-cli-core/src/command_contract.rs#L30Merge feature_gate from all vox-cli registry rows sharing this path (stable dedupe).
fncommand_contract::merged_feature_gatepub fn merged_feature_gate(path: &[String]) -> Option<String>crates/vox-cli-core/src/command_contract.rs#L64-L66Merge feature_gate from all registry rows sharing this path (stable dedupe).
fncommand_contract::catalog_source_grouppub fn catalog_source_group(path: &[String]) -> Stringcrates/vox-cli-core/src/command_contract.rs#L126-L134source_group for vox commands JSON/text (registry-first, then heuristic).
fncommand_contract::fallback_source_grouppub fn fallback_source_group(path: &[String]) -> Stringcrates/vox-cli-core/src/command_contract.rs#L150-L177When no registry row matches this exact path (e.g. fabrica build shim), infer lane from the first segment.