Expand description
Library-testable command implementations, one module per verb group.
Every function here takes a &mut dyn Write output sink and a typed
args struct, and returns a typed report (or Result<Report, CliError>
when the command can fail outright) — no println!, no
process::exit, so every verb is testable by constructing args by
hand and inspecting the returned report and the bytes written to an
in-memory Vec<u8> sink.
Modules§
- bag
astrs bag infoandastrs bag convert(blueprint §10.6, §14, §17).- build
astrs build— run a manifest’sbuild:lines, without running the graph (blueprint §17).- client
- The one connection every client verb shares: CLI → coordinator.
- cluster
astrs up,astrs downand the cluster half ofastrs status(blueprint §17’s Lifecycle row, §4.2’s process model, §16’s token, §24.2’s runtime directory).- completion
astrs completion(blueprint §17): shell completion scripts viaclap_complete, for bash, zsh and fish.- doctor
astrs doctor(blueprint §17): environment checks that need no live daemon or coordinator — port availability, SHM limits, multicast availability, real-time scheduling capability (§11.3/§22), toolchain versions, runtime directory writability.- expand
astrs expand(blueprint §8.5, §17): print a manifest with everymodule:-sourced node flattened, in stable YAML — the shapeastrs-graphand the runtime actually consume.- graph
astrs graph(blueprint §17): mermaid, DOT, or a self-contained HTML page embedding the mermaid source, for a manifest’s dataflow graph.- hub
astrs hub— the local client for the AstRS package index (blueprint §22’s “hub/package index”), pulled forward from the 0.2.0 roadmap into this release.- lifecycle
- The cluster-side lifecycle verbs:
start,stop,restart,destroy,clean(blueprint §17). - log_
stream - Streaming a running dataflow’s output to a terminal (blueprint §17:
astrs run“streams logs to the terminal”;astrs logs -fdoes the same over the coordinator link). - migrate
astrs migrate from-dora/from-ros2(blueprint §8.6, §17): delegates the actual mapping toastrs-migrate; this module is just the CLI-facing wiring (argument handling, output routing, human/JSON rendering).- monitor
astrs list,astrs logs [-f]and the dataflow half ofastrs status(blueprint §17’s Monitoring row).- new
astrs new(blueprint §17): scaffold a buildable node/operator crate, or a starter graph manifest, wired into a starter manifest.- node
astrs node add/remove/replace/connect/disconnect(blueprint §8, §17: dynamic topology) — closing the loopcrate::command::stubused to leave as a scheduled-later verb.- param
astrs param get/set/list/delete(blueprint §17’s Graph-ops row).- record
astrs record start/stop(blueprint §14, §17).- replay
astrs replay(blueprint §14, §17), in its two forms.- ros2
- The probe both
astrs ros2verbs are built on (blueprint §17). - ros2_
doctor astrs ros2 doctor(blueprint §17): the discovery probe.- ros2_
topics astrs ros2 topics(blueprint §17): the live DDS graph, listed.- run
astrs run— the single-process mode, and this binary’s flagship verb.- schema
astrs schema(blueprint §17): emit the manifest JSON schema.- serve
- The hidden verbs:
astrs coordinator,astrs daemon,astrs runtime(blueprint §17’s “Internal (hidden)” row). - signals
- The one place this binary decides what “stop” means when it arrives as a signal rather than as an argument.
- stub
- The verbs blueprint §17 lists that this build does not implement yet, and the one place that says which wave each of them belongs to.
- token
astrs token mint(blueprint §16, §22).- top
astrs top(blueprint §13, §17): the live TUI monitor, against a coordinator or (--replay) an.arecrecording.- topic
astrs topic echo/hz/info/pub(blueprint §13, §17).- trace
astrs trace(blueprint §13, §17): a minimal causal span listing.- validate
astrs validate [--prove](blueprint §17).