BusDK module CLI reference

BusDK module CLI reference

This section is the end user reference for the BusDK module CLIs. Each page is structured like a man page so you can quickly find the command surface, data files, and how to discover flags and subcommands. Command names follow CLI command naming. In synopsis lines, [global flags] denotes the standard global flags accepted by most modules; run bus <module> --help for the full list for each module. For the design and implementation rationale behind each module, see the module SDDs in Modules (SDD).

If you need architectural background on why modules are independent and how they integrate, see Independent modules and Modularity.

For cross-module capability scanning, use the BusDK module feature table. It aggregates feature rows from each module repository FEATURES.md and shows user-visible capability, interface type, evidence, coverage, and maturity in one table.

Data files and path ownership

Each module that owns workspace data defines where its data files live. Today these are conventional names at the workspace root (for example accounts.csv, periods.csv, datapackage.json). Only the owning module may write to those files or apply business logic to them; other tools that need read-only access to another module’s data obtain the path from that module (see the Data path contract for read-only cross-module access in the module SDDs). The design allows future configuration of paths (for example in a data package) so that end users can customize where data is stored without breaking how other tools discover it.

Core entrypoints are bus, bus init, bus config, and bus data. Use these to dispatch commands, initialize workspaces, maintain datapackage.json, and inspect low-level datasets and schemas.

Local interfaces are bus api, bus sheets, and bus books. They expose workspace data through HTTP or browser-facing UIs.

Automation and developer tooling live in bus dev, bus agent, bus run, bus update, bus secrets, bus shell, and bus bfl. bus dev focuses on module-repository workflows, bus run focuses on user-defined prompts/scripts/pipelines, and bus shell provides an interactive or one-shot command shell that dispatches through bus. These modules rely on bus-agent where agent runtime execution is required. bus secrets provides deterministic secret reference storage and resolution for step-level environment configuration. From BusDK v0.0.26 onward, Codex runtime support is available through that shared layer.

Accounting domain modules are bus accounts, bus entities, bus period, bus attachments, bus invoices, bus journal, bus bank, bus reconcile, bus assets, bus loans, bus inventory, bus payroll, and bus budget.

Reporting, quality, and filing modules are bus reports, bus replay, bus validate, bus vat, bus pdf, bus filing, bus filing prh, and bus filing vero.