API reference
The Rust API documentation is generated by rustdoc and published with this book. Open it from the links below. If you’re reading the book from a plain mdbook build without the rustdoc step, these links won’t resolve; see Building the documentation.
| Crate | What it holds |
|---|---|
xianyun_core | Configuration loading, merging and validation, variable expansion, naming, ordered maps, topological sort |
xianyun_pki | The dev CA and the trust store integrations |
xianyun_executor | The CommandRunner trait, logging, the log-filter TUI, small file and data-directory helpers |
xianyun_backends | Wrappers for docker, git, helm, /etc/hosts, kubectl, and kustomize |
xianyun_cluster | Cluster drivers, DNS zone discovery, kubeconfig handling |
xianyun_deploy | Deployers, reloaders, the orchestrator, the registry cache, diagnostics |
xianyun_update | Repository updates and lifecycle hooks |
xianyun_infra | Embedded Kubernetes overlays (dev CA, Traefik TLS store) |
xianyun_cli | The xianyun command tree and its wiring |
xianyun_mcp | The MCP server’s allowlist and gating |
xianyun_testutil | The shared mock CommandRunner used by tests |
Many module headers say “Ported from” followed by a Go file name. That points at the original implementation each piece mirrors, which is useful when you’re comparing behaviour. Some headers still say “Not yet implemented” on modules that now are; the source is authoritative.