Skip to content

vox-plugin-catalog API Reference (generated)

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

SSOT catalog of all first-party Vox plugins and distribution bundles.

SSOT catalog of all first-party Vox plugins and distribution bundles.

See docs/src/architecture/plugin-system-redesign-2026.md.

ModuleDescription
docs—
schema—
EnumDescription
ResolveError—
FunctionDescription
all_pluginsAll first-party plugins declared in catalog.toml.
all_bundlesAll distribution bundles declared in catalog.toml.
all_componentsAll optional first-party components (companion binaries such as the GUI) declared in catalog.toml. Components are not cdylib plugins; they are standalone executables installed on demand and never built for CLI-only users.
all_skill_bundlesAll bundled interop skills declared in catalog.toml ([[skill-bundle]]).
bundle_resolvedResolve a bundle id to its full plugin set, walking the extends chain and deduplicating by plugin id. Order: parent plugins first, then child additions. First-occurrence wins for duplicates.
bundle_profilesDefault capability profile ids declared directly on bundle id (not inherited).
Dependency Topology, diagram 16 nodes, 5 edges: vox-cli → vox-plugin-catalog; vox-cli-ci → vox-plugin-catalog; vox-cli-research → vox-plugin-catalog; vox-orchestrator-mcp → vox-plugin-catalog; voxup → vox-plugin-catalogvox-plugin-catalogvox-clivox-cli-civox-cli-researchvox-orchestrator-mcpvoxup
Diagram source
graph {
direction: right
node vox_plugin_catalog: "vox-plugin-catalog"
node vox_cli: "vox-cli"
vox_cli -> vox_plugin_catalog
node vox_cli_ci: "vox-cli-ci"
vox_cli_ci -> vox_plugin_catalog
node vox_cli_research: "vox-cli-research"
vox_cli_research -> vox_plugin_catalog
node vox_orchestrator_mcp: "vox-orchestrator-mcp"
vox_orchestrator_mcp -> vox_plugin_catalog
node voxup: "voxup"
voxup -> vox_plugin_catalog
}
Consumer CrateRole
vox-cliDirect workspace dependent
vox-cli-ciDirect workspace dependent
vox-cli-researchDirect workspace dependent
vox-orchestrator-mcpDirect workspace dependent
voxupDirect workspace dependent
KindSymbolSignatureSourceDescription
fnall_pluginspub fn all_plugins() -> &'static [PluginCatalogEntry]crates/vox-plugin-catalog/src/lib.rs#L36-L38All first-party plugins declared in catalog.toml.
fnall_bundlespub fn all_bundles() -> &'static [BundleEntry]crates/vox-plugin-catalog/src/lib.rs#L41-L43All distribution bundles declared in catalog.toml.
fnall_componentspub fn all_components() -> &'static [Component]crates/vox-plugin-catalog/src/lib.rs#L48-L50All optional first-party components (companion binaries such as the GUI) declared in catalog.toml. Components are not cdylib plugins; they are standalone executables installed on demand and never built for CLI-only users.
fnall_skill_bundlespub fn all_skill_bundles() -> &'static [SkillBundleEntry]crates/vox-plugin-catalog/src/lib.rs#L53-L55All bundled interop skills declared in catalog.toml ([[skill-bundle]]).
enumResolveErrorpub enum ResolveErrorcrates/vox-plugin-catalog/src/lib.rs#L60-L67—
fnbundle_resolvedpub fn bundle_resolved(id: &str) -> Result<Vec<&'static PluginCatalogEntry>, ResolveError>crates/vox-plugin-catalog/src/lib.rs#L72-L108Resolve a bundle id to its full plugin set, walking the extends chain and deduplicating by plugin id. Order: parent plugins first, then child additions. First-occurrence wins for duplicates.
fnbundle_profilespub fn bundle_profiles(id: &str) -> Result<&'static [String], ResolveError>crates/vox-plugin-catalog/src/lib.rs#L111-L117Default capability profile ids declared directly on bundle id (not inherited).
fndocs::render_catalog_mdpub fn render_catalog_md() -> Stringcrates/vox-plugin-catalog/src/docs.rs#L26-L71—
fndocs::render_bundles_mdpub fn render_bundles_md() -> Stringcrates/vox-plugin-catalog/src/docs.rs#L73-L137—
enumschema::CatalogStatuspub enum CatalogStatuscrates/vox-plugin-catalog/src/schema.rs#L8-L18Lifecycle status of a catalog entry.
structschema::PluginCatalogEntrypub struct PluginCatalogEntrycrates/vox-plugin-catalog/src/schema.rs#L23-L84One entry in the plugin catalog.
enumschema::PayloadKindpub enum PayloadKindcrates/vox-plugin-catalog/src/schema.rs#L89-L93Discriminator for plugin payload kind.
structschema::BundleEntrypub struct BundleEntrycrates/vox-plugin-catalog/src/schema.rs#L98-L118One distribution-bundle entry in the catalog.
structschema::SkillBundleEntrypub struct SkillBundleEntrycrates/vox-plugin-catalog/src/schema.rs#L127-L149One bundled interop skill directory under assets/skills/<id>/SKILL.md. These are agentskills.io-native YAML skills (not TOML plugin skills). Provenance is recorded in assets/skills/SOURCES.toml; this table is the catalog SSOT for license, upstream pin, and on-disk path parity.
structschema::Componentpub struct Componentcrates/vox-plugin-catalog/src/schema.rs#L159-L181One installable component: a first-party Vox binary that is NOT a cdylib plugin (it implements no extension-point trait and is not loaded by the plugin host). Components are optional companion executables — currently just the Tauri GUI — that ship alongside the host binary and are installed on demand via vox plugin install <id> / vox gui install-if-absent. CLI-only users never fetch them.
structschema::ComponentRequirespub struct ComponentRequirescrates/vox-plugin-catalog/src/schema.rs#L187-L197Platform gating for a [Component]. The host OS must appear in os (when non-empty) AND host arch in arch (when non-empty).