Skip to content

vox-cli-research API Reference (generated)

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

Research commands (run/eval/infra/mesh-intake) extracted from vox-cli.

vox research subcommands, extracted from vox-cli.

[ResearchCmd] is the clap surface and [run] dispatches it. The commands cover:

  • the SearXNG sidecar (up / down / status, in [infra]);
  • research runs and their sessions (run, preview, history, show, watch, result, search, probe, flag, publish);
  • the research eval harness ([eval]).
FeatureDefault / Enables
completion-toestub—
ludus-hud—
runtimevox-research-shim/runtime
stub-check—
vox-gamifyvox-research-shim/gamify
DependencyKind
vox-actor-runtimeNormal
vox-auditNormal
vox-bounded-fsNormal
vox-capability-registryNormal
vox-cli-ciNormal
vox-cli-contractsNormal
vox-cli-coreNormal
vox-code-auditNormal
vox-codegenNormal
vox-compilerNormal
vox-configNormal
vox-containerNormal
vox-corpusNormal
vox-cryptoNormal
vox-dbNormal
vox-doc-pipelineNormal
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-kb-facetsNormal
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-sdkNormal
vox-plugin-typesNormal
vox-populiNormal
vox-publisherNormal
vox-repositoryNormal
vox-research-eventsNormal
vox-research-shimNormal
vox-scaling-policyNormal
vox-scientiaNormal
vox-searchNormal
vox-secretsNormal
vox-skill-discoveryNormal
vox-skillsNormal
vox-sqlNormal
vox-telemetryNormal
ModuleDescription
add_component—
attention—
audit—
audit_effort—
audit_research_parity—
audit_route—
chat—
check_terminal—
ci_helpers—
codex—
command_sync—
daemon_tool—
db—
db_cli—
db_research—
db_retention—
dei—
diagnostics_tools—
diagram—
doctor_build_broker—
doctor_build_health—
doctor_disk_footprint—
doctor_project_check—
doctor_toolchain—
eval—
extras—
generate—
gui—
harness—
infra—
kb—
live—
login_shared—
migrate—
model—
openclaw—
pipeline—
plugin—
policy—
policy_allowlist_parity—
py—
repair—
repl—
repo—
repo_init—
safety—
scientia—
scientia_nanopub—
scientia_phase_handlers—
scientia_worthiness_enrich—
scout—
secrets—
snapshot—
stub_check—
visus—
workflow—
workspace_db—
EnumDescription
ResearchCmd—
FunctionDescription
run—
research_history—
research_show—
research_preview—
research_result—
research_search—
research_probe—
research_flag—
research_publish—
research_watch—
run_research_queryCatalog handler anchor for research.run (contracts/operations/catalog.v1.yaml).
ConstantDescription
VOX_VERSION—
Dependency Topology, diagram 114 nodes, 13 edges: vox-cli-research → vox-actor-runtime; vox-cli-research → vox-audit; vox-cli-research → vox-bounded-fs; vox-cli-research → vox-capability-registry; vox-cli-research → vox-cli-ci; vox-cli-research → vox-cli-contracts; vox-cli-research → vox-cli-core; vox-cli-research → vox-code-au…vox-cli-researchvox-actor-runtimevox-auditvox-bounded-fsvox-capability-registryvox-cli-civox-cli-contractsvox-cli-corevox-code-auditvox-codegenvox-compilervox-configvox-containervox-cli
Diagram source
graph {
direction: right
node vox_cli_research: "vox-cli-research"
node vox_actor_runtime: "vox-actor-runtime"
vox_cli_research -> vox_actor_runtime
node vox_audit: "vox-audit"
vox_cli_research -> vox_audit
node vox_bounded_fs: "vox-bounded-fs"
vox_cli_research -> vox_bounded_fs
node vox_capability_registry: "vox-capability-registry"
vox_cli_research -> vox_capability_registry
node vox_cli_ci: "vox-cli-ci"
vox_cli_research -> vox_cli_ci
node vox_cli_contracts: "vox-cli-contracts"
vox_cli_research -> vox_cli_contracts
node vox_cli_core: "vox-cli-core"
vox_cli_research -> vox_cli_core
node vox_code_audit: "vox-code-audit"
vox_cli_research -> vox_code_audit
node vox_codegen: "vox-codegen"
vox_cli_research -> vox_codegen
node vox_compiler: "vox-compiler"
vox_cli_research -> vox_compiler
node vox_config: "vox-config"
vox_cli_research -> vox_config
node vox_container: "vox-container"
vox_cli_research -> vox_container
node vox_cli: "vox-cli"
vox_cli -> vox_cli_research
}
Consumer CrateRole
vox-cliDirect workspace dependent
KindSymbolSignatureSourceDescription
enumResearchCmdpub enum ResearchCmdcrates/vox-cli-research/src/lib.rs#L80—
fnrunpub async fn run(cmd: ResearchCmd) -> anyhow::Result<()>crates/vox-cli-research/src/lib.rs#L212-L275—
fnresearch_historypub async fn research_history(limit: u32) -> anyhow::Result<()>crates/vox-cli-research/src/lib.rs#L282-L296—
fnresearch_showpub async fn research_show(session_id: i64) -> anyhow::Result<()>crates/vox-cli-research/src/lib.rs#L298-L317—
fnresearch_previewpub async fn research_preview(query: String, json: bool) -> anyhow::Result<()>crates/vox-cli-research/src/lib.rs#L319-L339—
fnresearch_resultpub async fn research_result(crates/vox-cli-research/src/lib.rs#L341—
fnresearch_searchpub async fn research_search(query: String, limit: usize, json: bool) -> anyhow::Result<()>crates/vox-cli-research/src/lib.rs#L366-L383—
fnresearch_probepub async fn research_probe(crates/vox-cli-research/src/lib.rs#L434—
fnresearch_flagpub async fn research_flag(crates/vox-cli-research/src/lib.rs#L482—
fnresearch_publishpub async fn research_publish(session_id: i64, slug: Option<String>) -> anyhow::Result<()>crates/vox-cli-research/src/lib.rs#L532-L552—
fnresearch_watchpub async fn research_watch(session_id: i64) -> anyhow::Result<()>crates/vox-cli-research/src/lib.rs#L562-L576—
fnrun_research_querypub async fn run_research_query(crates/vox-cli-research/src/lib.rs#L580Catalog handler anchor for research.run (contracts/operations/catalog.v1.yaml).
structadd_component::RegistryItempub struct RegistryItemcrates/vox-cli-research/src/add_component.rs#L30-L43One registry item (<name>.json) returned by the shadcn registry.
structadd_component::RegistryFilepub struct RegistryFilecrates/vox-cli-research/src/add_component.rs#L47-L55One file inside a registry item.
structadd_component::ComponentsConfigpub struct ComponentsConfigcrates/vox-cli-research/src/add_component.rs#L59-L69Subset of components.json that drives placement and content transforms.
structadd_component::Aliasespub struct Aliasescrates/vox-cli-research/src/add_component.rs#L83-L92components.json aliases block (defaults match the Vox scaffold).
structadd_component::PlannedFilepub struct PlannedFilecrates/vox-cli-research/src/add_component.rs#L120-L125A file the command will write: project-relative path + final content.
fnadd_component::plan_filespub fn plan_files(item: &RegistryItem, cfg: &ComponentsConfig) -> Result<Vec<PlannedFile>>crates/vox-cli-research/src/add_component.rs#L200-L226Plan the on-disk writes for one registry item — network-free and deterministic. Honors components.json aliases (file placement + in-content rewrite), injects "use client" for client components when rsc is set, and keeps the file’s own extension. Returns an error when tsx: false (JS output requires type stripping, which is not implemented — an honest limitation, not a silent stub).
fnadd_component::runpub async fn run(name: &str) -> Result<()>crates/vox-cli-research/src/add_component.rs#L248-L307vox component <name> — fetch the named shadcn registry item (and its registry dependencies) and vendor the source into the current project.
enumattention::AttentionCommandpub enum AttentionCommandcrates/vox-cli-research/src/attention.rs#L7-L31Manage and inspect the Vox attention-budgeting system.
fnattention::handle_attention_commandpub async fn handle_attention_command(crates/vox-cli-research/src/attention.rs#L33—
enumaudit::AuditSubcommandpub enum AuditSubcommandcrates/vox-cli-research/src/audit.rs#L31-L55Nested subcommands under vox audit <thing>. Today this is just effort (F1). The intent is for additional umbrella gates to graduate here over time — see AGENTS.md §10.2 (“vox audit” umbrella SSOT) for the contract.
structaudit::DocsAuditArgspub struct DocsAuditArgscrates/vox-cli-research/src/audit.rs#L59-L147Arguments for vox audit docs.
structaudit::AuditArgspub struct AuditArgscrates/vox-cli-research/src/audit.rs#L169-L241Run quality-gate checks defined in contracts/ci/check-targets.v1.yaml, OR run a CR-L gate from the vox-audit umbrella registry. Two dispatch modes, mutually exclusive: • Default — iterates check-targets.v1.yaml and runs each entry. • --gate <NAME> / --list-gates — dispatches to vox_audit::registry() for the v1.0 LLM-target CR-L gates (CR-L0..L8).
fnaudit::runpub fn run(args: &AuditArgs) -> Result<()>crates/vox-cli-research/src/audit.rs#L248-L288Entry point called from the CLI dispatch (flag-based path; no nested subcommand).
fnaudit::run_audit_subcommandpub fn run_audit_subcommand(cmd: &AuditSubcommand) -> Result<()>crates/vox-cli-research/src/audit.rs#L295-L338Run a single core gate or the full trio (vox audit core / --gate core).
structaudit_effort::EffortArgspub struct EffortArgscrates/vox-cli-research/src/audit_effort.rs#L26-L58vox audit effort flags.
fnaudit_effort::runpub async fn run(args: EffortArgs) -> Result<()>crates/vox-cli-research/src/audit_effort.rs#L161-L238vox audit effort handler.
structaudit_research_parity::ResearchParityArgspub struct ResearchParityArgscrates/vox-cli-research/src/audit_research_parity.rs#L6-L11—
fnaudit_research_parity::extract_empirical_test_referencespub fn extract_empirical_test_references(doc_content: &str) -> Vec<String>crates/vox-cli-research/src/audit_research_parity.rs#L21-L40—
fnaudit_research_parity::run_research_parity_audit_syncpub fn run_research_parity_audit_sync(args: &ResearchParityArgs) -> anyhow::Result<usize>crates/vox-cli-research/src/audit_research_parity.rs#L42-L83—
structaudit_route::EffortRouteArgspub struct EffortRouteArgscrates/vox-cli-research/src/audit_route.rs#L31-L47vox audit effort-route flags.
fnaudit_route::runpub async fn run(args: EffortRouteArgs) -> Result<()>crates/vox-cli-research/src/audit_route.rs#L198-L282vox audit effort-route handler.
structchat::ChatArgspub struct ChatArgscrates/vox-cli-research/src/chat.rs#L19-L39vox chat arguments.
fnchat::build_chat_system_promptpub fn build_chat_system_prompt(user_system: Option<&str>, vox_mode: bool) -> Stringcrates/vox-cli-research/src/chat.rs#L51-L69Build the effective system prompt for vox chat, weaving in [ANTI_SYCOPHANCY_PREAMBLE] and (when vox_mode is active) the 2026 .vox Script Writer contract.
enumchat::SotaRoutingModepub enum SotaRoutingModecrates/vox-cli-research/src/chat.rs#L73-L79Canonical SOTA routing modes supported by vox chat --model <mode>.
fnchat::parsepub fn parse(raw: &str) -> Option<Self>crates/vox-cli-research/src/chat.rs#L82-L91—
fnchat::labelpub fn label(self) -> &'static strcrates/vox-cli-research/src/chat.rs#L93-L101—
fnchat::is_vox_script_requestpub fn is_vox_script_request(prompt: &str) -> boolcrates/vox-cli-research/src/chat.rs#L105-L118Detect whether the user prompt asks to author .vox code or a .vox automation script.
fnchat::extract_vox_code_blockspub fn extract_vox_code_blocks(reply: &str) -> Vec<String>crates/vox-cli-research/src/chat.rs#L121-L145Extract fenced vox ... blocks from an LLM reply.
fnchat::verify_vox_snippetpub fn verify_vox_snippet(source: &str) -> std::result::Result<(), String>crates/vox-cli-research/src/chat.rs#L149-L174Validate .vox source using the full compiler frontend (lex -> parse -> hir -> typeck). Returns Ok(()) if 0 errors, or Err(formatted_diagnostics) if errors exist.
fnchat::runpub async fn run(args: ChatArgs) -> Result<()>crates/vox-cli-research/src/chat.rs#L178Run vox chat: send args.message (with optional args.system prompt) to args.model via the shared llm_chat facade and print the reply.
fnchat::build_sota_selection_requestpub fn build_sota_selection_request(crates/vox-cli-research/src/chat.rs#L379Build the SOTA routing request for a given [SotaRoutingMode] and user prompt.
structcheck_terminal::ExecPolicyV1pub struct ExecPolicyV1crates/vox-cli-research/src/check_terminal.rs#L98-L108Terminal execution policy (mirrors exec-policy.v1.schema.json).
fncheck_terminal::validate_policy_yaml_against_schemapub fn validate_policy_yaml_against_schema(crates/vox-cli-research/src/check_terminal.rs#L130—