Skip to content

vox-config API Reference (generated)

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

Centralized configuration and env/default resolution for Vox tooling

Centralized configuration for Vox: env vars, defaults, and path resolution.

Precedence: CLI args > env > config file > defaults.

FeatureDefault / Enables
default—
llm-egressdep:vox-llm-egress
DependencyKind
vox-config-deriveNormal
vox-gitNormal
vox-llm-configNormal
vox-llm-egressNormal
vox-secretsNormal
vox-telemetryNormal
ModuleDescription
bootstrap_inference—
config—
config_field—
config_key—
config_registry—
config_watch—
env_parse—
graphify—
inference—
model_defaults—
model_routing—
operator_registry—
paths—
policy—
project_manifest—
resolve_egress—
rollout—
routing_migration—
routing_policy—
scholarly—
secrets—
serde_defaults—
snapshot—
timeouts—
toml_config—
TraitDescription
VoxConfigDomainImplemented by every #[derive(VoxConfig)] struct. The vox-cli aggregator collects config_keys() across domains; catalog() feeds the GUI.
ConstantDescription
VOX_MCP_MIN_VERSIONMinimum Vox MCP server version required for full agent capability.
STORAGE_URL_PREFIXURL path prefix for serving stored files.
WAL_FLUSH_BATCH_SIZEMaximum number of WAL entries to buffer before forcing a flush to disk.
Dependency Topology, diagram 119 nodes, 18 edges: vox-config → vox-config-derive; vox-config → vox-git; vox-config → vox-llm-config; vox-config → vox-llm-egress; vox-config → vox-secrets; vox-config → vox-telemetry; vox-actor-runtime → vox-config; vox-audit → vox-config; vox-cli → vox-config; vox-cli-ci → vox-config; vox-cli-co…vox-configvox-config-derivevox-gitvox-llm-configvox-llm-egressvox-secretsvox-telemetryvox-actor-runtimevox-auditvox-clivox-cli-civox-cli-contractsvox-cli-corevox-cli-researchvox-codegenvox-compilervox-dbvox-deploy-codegenvox-effort-audit
Diagram source
graph {
direction: right
node vox_config: "vox-config"
node vox_config_derive: "vox-config-derive"
vox_config -> vox_config_derive
node vox_git: "vox-git"
vox_config -> vox_git
node vox_llm_config: "vox-llm-config"
vox_config -> vox_llm_config
node vox_llm_egress: "vox-llm-egress"
vox_config -> vox_llm_egress
node vox_secrets: "vox-secrets"
vox_config -> vox_secrets
node vox_telemetry: "vox-telemetry"
vox_config -> vox_telemetry
node vox_actor_runtime: "vox-actor-runtime"
vox_actor_runtime -> vox_config
node vox_audit: "vox-audit"
vox_audit -> vox_config
node vox_cli: "vox-cli"
vox_cli -> vox_config
node vox_cli_ci: "vox-cli-ci"
vox_cli_ci -> vox_config
node vox_cli_contracts: "vox-cli-contracts"
vox_cli_contracts -> vox_config
node vox_cli_core: "vox-cli-core"
vox_cli_core -> vox_config
node vox_cli_research: "vox-cli-research"
vox_cli_research -> vox_config
node vox_codegen: "vox-codegen"
vox_codegen -> vox_config
node vox_compiler: "vox-compiler"
vox_compiler -> vox_config
node vox_db: "vox-db"
vox_db -> vox_config
node vox_deploy_codegen: "vox-deploy-codegen"
vox_deploy_codegen -> vox_config
node vox_effort_audit: "vox-effort-audit"
vox_effort_audit -> vox_config
}
Consumer CrateRole
vox-actor-runtimeDirect workspace dependent
vox-auditDirect workspace dependent
vox-cliDirect workspace dependent
vox-cli-ciDirect workspace dependent
vox-cli-contractsDirect workspace dependent
vox-cli-coreDirect workspace dependent
vox-cli-researchDirect workspace dependent
vox-codegenDirect workspace dependent
vox-compilerDirect workspace dependent
vox-dbDirect workspace dependent
vox-deploy-codegenDirect workspace dependent
vox-effort-auditDirect workspace dependent
vox-effort-routeDirect workspace dependent
vox-gamifyDirect workspace dependent
vox-guiDirect workspace dependent
vox-integration-testsDirect workspace dependent
vox-langtoolDirect workspace dependent
vox-ml-cliDirect workspace dependent
vox-openclaw-runtimeDirect workspace dependent
vox-orchestratorDirect workspace dependent
vox-orchestrator-dDirect workspace dependent
vox-orchestrator-mcpDirect workspace dependent
vox-orchestrator-modelsDirect workspace dependent
vox-orchestrator-queueDirect workspace dependent
vox-packageDirect workspace dependent
vox-plugin-browserDirect workspace dependent
vox-plugin-hostDirect workspace dependent
vox-plugin-mens-candle-cudaDirect workspace dependent
vox-plugin-mens-candle-metalDirect workspace dependent
vox-plugin-populi-meshDirect workspace dependent
vox-plugin-speechDirect workspace dependent
vox-plugin-webhookDirect workspace dependent
vox-populiDirect workspace dependent
vox-publisherDirect workspace dependent
vox-repositoryDirect workspace dependent
vox-research-shimDirect workspace dependent
vox-runtimeDirect workspace dependent
vox-scientiaDirect workspace dependent
vox-searchDirect workspace dependent
vox-speechDirect workspace dependent
vox-test-harnessDirect workspace dependent
vox-vcsDirect workspace dependent
vox-workflow-runtimeDirect workspace dependent
KindSymbolSignatureSourceDescription
traitVoxConfigDomainpub trait VoxConfigDomain: Sizedcrates/vox-config/src/lib.rs#L46-L50Implemented by every #[derive(VoxConfig)] struct. The vox-cli aggregator collects config_keys() across domains; catalog() feeds the GUI.
structconfig_field::ConfigFieldpub struct ConfigFieldcrates/vox-config/src/config_field.rs#L7-L15—
enumconfig_key::ConfigKindpub enum ConfigKindcrates/vox-config/src/config_key.rs#L8-L16Value kind for a config knob (superset of the GUI Kind and the planned LLM kinds).
enumconfig_key::DefaultValuepub enum DefaultValuecrates/vox-config/src/config_key.rs#L20-L25Where a knob’s DEFAULT comes from.
enumconfig_key::Grouppub enum Groupcrates/vox-config/src/config_key.rs#L29-L40Coarse UI/topic grouping (federated — domains extend this deliberately).
enumconfig_key::Homepub enum Homecrates/vox-config/src/config_key.rs#L44-L51Canonical home / value-SSOT pointer for the knob (the “ONE home” rule).
enumconfig_key::Statuspub enum Statuscrates/vox-config/src/config_key.rs#L55-L58Lifecycle: Active = read in code today; Declared = registered, not yet wired.
structconfig_key::GuiSurfacepub struct GuiSurfacecrates/vox-config/src/config_key.rs#L62-L66GUI surfacing directive. None on a ConfigKey = not surfaced.
structconfig_key::ConfigKeypub struct ConfigKeycrates/vox-config/src/config_key.rs#L70-L85One operational config knob. Reuses operator_registry::ConfigClass.
fnconfig_key::validate_numericpub fn validate_numeric(&self, v: f64) -> boolcrates/vox-config/src/config_key.rs#L90-L98A numeric value is valid iff finite and within bound (if any).
fnconfig_registry::registered_keyspub fn registered_keys() -> impl Iterator<Item = &'static str>crates/vox-config/src/config_registry.rs#L2197-L2199All registered keys (for the parity gate).
structconfig_watch::ConfigSnapshotpub struct ConfigSnapshotcrates/vox-config/src/config_watch.rs#L14-L19Point-in-time view of the config revision and the keys changed in the last bump.
structconfig_watch::ConfigWatchpub struct ConfigWatchcrates/vox-config/src/config_watch.rs#L23-L26Watch channel for config changes. Clone subscribe receivers to fan out to multiple consumers.
fnconfig_watch::newpub fn new() -> Selfcrates/vox-config/src/config_watch.rs#L31-L34Create a new watch channel at revision 0.
fnconfig_watch::subscribepub fn subscribe(&self) -> watch::Receiver<ConfigSnapshot>crates/vox-config/src/config_watch.rs#L38-L40Subscribe to config-change notifications.
fnconfig_watch::bumppub fn bump(&self, keys: &[&str])crates/vox-config/src/config_watch.rs#L43-L48Advance the revision and notify all subscribers.
fnconfig_watch::currentpub fn current(&self) -> ConfigSnapshotcrates/vox-config/src/config_watch.rs#L52-L54Current snapshot without subscribing.
fnconfig_watch::globalpub fn global() -> &'static ConfigWatchcrates/vox-config/src/config_watch.rs#L67-L69Process-wide config watch channel (lazy-init on first access).
fnenv_parse::parse_u64_optpub fn parse_u64_opt(raw: Option<&str>, default: u64) -> u64crates/vox-config/src/env_parse.rs#L14-L16—
fnenv_parse::resolve_config_strpub fn resolve_config_str(name: &str, default: &str) -> Stringcrates/vox-config/src/env_parse.rs#L26-L44Resolve a non-secret string config value with layered precedence: 1. env var (highest — CI/override) 2. ~/.vox/config.toml 3. compiled default Suitable for operator-tuning strings (base URLs, log levels, feature flags). For secrets such as API keys or tokens, use vox_secrets::resolve_secret instead.
fnenv_parse::resolve_config_u64pub fn resolve_config_u64(name: &str, default: u64) -> u64crates/vox-config/src/env_parse.rs#L48-L66Resolve a u64 config value using layered precedence.
fnenv_parse::resolve_config_usizepub fn resolve_config_usize(name: &str, default: usize) -> usizecrates/vox-config/src/env_parse.rs#L70-L88Resolve a usize config value using layered precedence.
fnenv_parse::resolve_config_boolpub fn resolve_config_bool(name: &str, default: bool) -> boolcrates/vox-config/src/env_parse.rs#L92-L114Resolve a bool config value using layered precedence.
fnenv_parse::resolve_config_f32pub fn resolve_config_f32(name: &str, default: f32) -> f32crates/vox-config/src/env_parse.rs#L118-L120Resolve an f32 config value using layered precedence (env → config.toml → default).
fnenv_parse::resolve_config_i32pub fn resolve_config_i32(name: &str, default: i32) -> i32crates/vox-config/src/env_parse.rs#L124-L126Resolve an i32 config value using layered precedence (env → config.toml → default).
fnenv_parse::resolve_config_opt_f32pub fn resolve_config_opt_f32(name: &str) -> Option<f32>crates/vox-config/src/env_parse.rs#L132-L150Resolve an optional f32 config value: env var → ~/.vox/config.toml → None. Accepts integer, float, or string-coerced TOML values.
fnenv_parse::resolve_config_opt_strpub fn resolve_config_opt_str(name: &str) -> Option<String>crates/vox-config/src/env_parse.rs#L155-L168Resolve an optional string config value: env var → ~/.vox/config.toml → None. Used by #[derive(VoxConfig)] for Option<T> and enum (FromStr) fields.
fnenv_parse::resolve_config_i64pub fn resolve_config_i64(name: &str, default: i64) -> i64crates/vox-config/src/env_parse.rs#L172-L188Resolve an i64 config value using layered precedence (env → ~/.vox/config.toml → default).
fnenv_parse::resolve_config_f64pub fn resolve_config_f64(name: &str, default: f64) -> f64crates/vox-config/src/env_parse.rs#L192-L210Resolve an f64 config value using layered precedence (env → ~/.vox/config.toml → default).
fnenv_parse::resolve_config_opt_i32pub fn resolve_config_opt_i32(name: &str) -> Option<i32>crates/vox-config/src/env_parse.rs#L216-L234Resolve an optional i32 config value: env var → ~/.vox/config.toml → None. Accepts integer, float (truncated), or string-coerced TOML values.
fnenv_parse::env_u64pub fn env_u64(name: &str, default: u64) -> u64crates/vox-config/src/env_parse.rs#L237-L239—
fnenv_parse::parse_usize_optpub fn parse_usize_opt(raw: Option<&str>, default: usize) -> usizecrates/vox-config/src/env_parse.rs#L242-L244—
fnenv_parse::env_usizepub fn env_usize(name: &str, default: usize) -> usizecrates/vox-config/src/env_parse.rs#L247-L249—
fnenv_parse::env_duration_from_mspub fn env_duration_from_ms(name: &str, default_ms: u64) -> Durationcrates/vox-config/src/env_parse.rs#L252-L254—
fngraphify::resolve_ttl_dayspub fn resolve_ttl_days(default_ttl: u64) -> u64crates/vox-config/src/graphify.rs#L34-L41Resolve the TTL (in days) using VOX_GRAPHIFY_TTL_DAYS if present, falling back to a default value.
fngraphify::ttl_env_override_activepub fn ttl_env_override_active(raw: Option<&str>) -> boolcrates/vox-config/src/graphify.rs#L50-L52True when raw (the value of VOX_GRAPHIFY_TTL_DAYS) is what resolve_ttl_days will return — i.e. the env var, not the contract, is in control. Keyed off presence, never off the resolved value differing from the contract: setting the env var to the same number is still an active override. Pure over the raw value so it is testable without mutating process-wide env.
fngraphify::ttl_env_override_active_nowpub fn ttl_env_override_active_now() -> boolcrates/vox-config/src/graphify.rs#L56-L58[ttl_env_override_active] applied to the current process environment.
fngraphify::cache_dir_env_override_activepub fn cache_dir_env_override_active(raw: Option<&str>) -> boolcrates/vox-config/src/graphify.rs#L76-L78True when raw (the value of VOX_GRAPHIFY_CACHE_DIR) overrides the cache base dir — i.e. [repo_graphify_cache_dir] uses it instead of the default <repo>/.vox/cache/graphify. [ttl_env_override_active]‘s shape: keyed off presence of a non-blank value, pure over the raw value so it is testable without mutating process-wide env.
fngraphify::cache_dir_env_override_active_nowpub fn cache_dir_env_override_active_now() -> boolcrates/vox-config/src/graphify.rs#L82-L84[cache_dir_env_override_active] applied to the current process environment.
fngraphify::graphify_disable_activepub fn graphify_disable_active(raw: Option<&str>) -> boolcrates/vox-config/src/graphify.rs#L92-L100True when raw (the value of VOX_GRAPHIFY_DISABLE) disables the graphify cache. Blank/absent, "0", "false", "no", and "off" (case-insensitive, surrounding whitespace ignored) are treated as not disabling; every other non-blank value disables — so a typo like VOX_GRAPHIFY_DISABLE=1 or =please still disables rather than being silently ignored.
fngraphify::graphify_disable_active_nowpub fn graphify_disable_active_now() -> boolcrates/vox-config/src/graphify.rs#L104-L106[graphify_disable_active] applied to the current process environment.
enumgraphify::GraphifyCacheDirpub enum GraphifyCacheDircrates/vox-config/src/graphify.rs#L116-L122Where a corpus’s on-disk graphify cache directory lives, or that the cache is disabled outright. Deliberately not a bare PathBuf: a disabled cache has no harmless path to point at, and a plain path return would let a caller skip checking VOX_GRAPHIFY_DISABLE and write anyway. Matching on this enum is required to get a directory out, so the disable switch cannot be silently ignored.
fngraphify::pathpub fn path(&self) -> Option<&Path>crates/vox-config/src/graphify.rs#L127-L132The directory, if the cache is enabled.
fngraphify::is_disabledpub fn is_disabled(&self) -> boolcrates/vox-config/src/graphify.rs#L136-L138True iff the cache is disabled.
structgraphify::GraphifyCorpuspub struct GraphifyCorpuscrates/vox-config/src/graphify.rs#L160-L178—