API Surface¶
The src/api module tree is the intentional Rust-facing surface for invoking
runtime behavior without importing deep internal module paths.
Visual Summary¶
flowchart LR
callers["callers and tests"] --> api_mod["api facade modules"]
api_mod --> runtime["runtime run_app run_cli_from_env"]
api_mod --> routing["parser and routing facade"]
api_mod --> diagnostics["diagnostics and install facade"]
api_mod --> repl["repl facade and contracts"]
Public API Modules¶
- runtime: process execution entrypoints
- parser/routing: clap intent parsing and route helpers
- output: renderer and emission helpers
- diagnostics: state and route inventory queries
- install/plugins/version/telemetry: runtime integration utilities
- repl: interactive execution contracts and utilities
Code Anchors¶
crates/bijux-cli/src/api/mod.rscrates/bijux-cli/src/api/runtime.rscrates/bijux-cli/src/api/routing.rscrates/bijux-cli/src/api/repl.rscrates/bijux-cli/src/api/diagnostics.rs
API Surface Rules¶
- prefer importing from
apimodules over internal implementation paths - API facades should stay thin and explicit about ownership boundaries
- when facade exports change, update this page and public import guidance