Skip to content

vox-orchestrator-driver API Reference (generated)

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

Thin L3 driver for embedding vox-orchestrator in CLI and MCP hosts.

Thin driver surface for embedding [vox_orchestrator::Orchestrator] in CLI/MCP hosts.

Extracted from vox-cli-core::orchestrator_driver to invert the CLI ↔ orchestrator dependency over time (see docs/src/architecture/layers.toml).

T2.3: [EmbeddedOrchestratorDriver] is daemon-bootstrap-only

Section titled “T2.3: [EmbeddedOrchestratorDriver] is daemon-bootstrap-only”

As of T2.3 (CLI converges on the daemon), every vox-cli command that previously used [EmbeddedOrchestratorDriver] (or the bare build_repo_scoped_orchestrator* functions) to get a private, throwaway Orchestrator handle has been migrated to talk to the shared, long-lived vox-orchestrator-d TCP daemon instead — via vox_cli_core::daemon_ipc::orchestrator_daemon_ensure::OrchestratorDaemonEnsure (T2.2) + vox_orchestrator::orch_daemon::OrchDaemonClient. A private in-process orchestrator per CLI invocation is a split-brain source: its task queue, approvals, and event bus are invisible to the daemon (and thus to the GUI, vox mcp, and every other daemon client), and vice versa.

[EmbeddedOrchestratorDriver] itself is still correct and required — but only as the daemon’s own bootstrap mechanism (see crates/vox-orchestrator-d/src/bin/vox_orchestrator_d.rs, which builds an Orchestrator via build_repo_scoped_orchestrator directly — the single process that legitimately owns “the” orchestrator instance). Do not add new client-side callers of this driver (or of build_repo_scoped_orchestrator*) from vox-cli or vox-gui — route through the daemon instead, as dei.rs/visus/mod.rs/live.rs/ extras/ludus/hud.rs now do.

DependencyKind
vox-orchestratorNormal
vox-repositoryNormal
StructDescription
EmbeddedOrchestratorDriverIn-process orchestrator built from discovered Vox.toml + repo-scoped bootstrap.
TraitDescription
OrchestratorDriverHost-facing trait for spawning and querying an embedded orchestrator.
FunctionDescription
load_and_buildDiscover config from the workspace, then build a repo-scoped orchestrator.
from_configBuild from an already-loaded config (tests / callers with custom config).
build_embedded_orchestrator_configLoad orchestrator config from the nearest readable Vox.toml, then apply env overrides. Discovery order matches the MCP stdio server: manifest-root Vox.toml first, then cwd Vox.toml, then defaults.
Dependency Topology, diagram 17 nodes, 6 edges: vox-orchestrator-driver → vox-orchestrator; vox-orchestrator-driver → vox-repository; vox-cli → vox-orchestrator-driver; vox-cli-core → vox-orchestrator-driver; vox-cli-research → vox-orchestrator-driver; vox-orchestrator-mcp → vox-orchestrator-drivervox-orchestrator-drivervox-orchestratorvox-repositoryvox-clivox-cli-corevox-cli-researchvox-orchestrator-mcp
Diagram source
graph {
direction: right
node vox_orchestrator_driver: "vox-orchestrator-driver"
node vox_orchestrator: "vox-orchestrator"
vox_orchestrator_driver -> vox_orchestrator
node vox_repository: "vox-repository"
vox_orchestrator_driver -> vox_repository
node vox_cli: "vox-cli"
vox_cli -> vox_orchestrator_driver
node vox_cli_core: "vox-cli-core"
vox_cli_core -> vox_orchestrator_driver
node vox_cli_research: "vox-cli-research"
vox_cli_research -> vox_orchestrator_driver
node vox_orchestrator_mcp: "vox-orchestrator-mcp"
vox_orchestrator_mcp -> vox_orchestrator_driver
}
Consumer CrateRole
vox-cliDirect workspace dependent
vox-cli-coreDirect workspace dependent
vox-cli-researchDirect workspace dependent
vox-orchestrator-mcpDirect workspace dependent
KindSymbolSignatureSourceDescription
traitOrchestratorDriverpub trait OrchestratorDrivercrates/vox-orchestrator-driver/src/lib.rs#L37-L49Host-facing trait for spawning and querying an embedded orchestrator.
structEmbeddedOrchestratorDriverpub struct EmbeddedOrchestratorDrivercrates/vox-orchestrator-driver/src/lib.rs#L52-L55In-process orchestrator built from discovered Vox.toml + repo-scoped bootstrap.
fnload_and_buildpub fn load_and_build() -> Selfcrates/vox-orchestrator-driver/src/lib.rs#L60-L63Discover config from the workspace, then build a repo-scoped orchestrator.
fnfrom_configpub fn from_config(config: OrchestratorConfig) -> Selfcrates/vox-orchestrator-driver/src/lib.rs#L67-L74Build from an already-loaded config (tests / callers with custom config).
fnbuild_embedded_orchestrator_configpub fn build_embedded_orchestrator_config() -> OrchestratorConfigcrates/vox-orchestrator-driver/src/lib.rs#L100-L138Load orchestrator config from the nearest readable Vox.toml, then apply env overrides. Discovery order matches the MCP stdio server: manifest-root Vox.toml first, then cwd Vox.toml, then defaults.