Skip to main content

Module cli

Module cli 

Source
Expand description

The astrs clap derive tree (blueprint §17): the full verb set, with a real argument schema on every subcommand — so --help, argument validation and shell completion (astrs completion) describe the whole surface, including the handful of verbs whose implementation belongs to a later wave and which report crate::error::CliError::NotImplementedYet when invoked (see crate::command::stub).

--json and --color are global flags (available on, and inherited by, every subcommand — blueprint §17: “All output has --json for scripting”) rather than repeated on each leaf args struct.

Structs§

BagConvertArgs
astrs bag convert arguments.
BagInfoArgs
astrs bag info arguments.
BuildArgs
astrs build arguments.
CleanArgs
astrs clean arguments.
Cli
The astrs command line: run, build, monitor, migrate and bridge robotic dataflows (blueprint §17).
CompletionCliArgs
astrs completion arguments.
ConnectArgs
Where a client verb finds the coordinator, and how it authenticates — flattened into every verb that talks to one so the four flags are spelled, parsed and documented exactly once (blueprint §16, §24.2).
CoordinatorArgs
astrs coordinator arguments (internal — the one process astrs up starts first).
DaemonArgs
astrs daemon arguments (internal — spawned by astrs up, never run by hand in ordinary use).
DestroyArgs
astrs destroy arguments.
DoctorCliArgs
astrs doctor arguments.
DownArgs
astrs down arguments.
ExpandCliArgs
astrs expand arguments.
FromDoraCliArgs
astrs migrate from-dora arguments.
FromRos2CliArgs
astrs migrate from-ros2 arguments.
GraphCliArgs
astrs graph arguments.
HubInfoArgs
astrs hub info arguments.
HubInitArgs
astrs hub init arguments.
HubSearchArgs
astrs hub search arguments.
HubUpdateArgs
astrs hub update arguments.
ListArgs
astrs list arguments.
LogsArgs
astrs logs arguments.
NewGraphArgs
astrs new graph arguments.
NewNodeArgs
astrs new node arguments.
NewOperatorArgs
astrs new operator arguments.
NewOperatorDylibArgs
astrs new operator-dylib arguments.
NodeAddArgs
astrs node add arguments.
NodeConnectArgs
astrs node connect arguments.
NodeDisconnectArgs
astrs node disconnect arguments.
NodeRemoveArgs
astrs node remove arguments.
NodeReplaceArgs
astrs node replace arguments.
ParamDeleteArgs
astrs param delete arguments.
ParamGetArgs
astrs param get arguments.
ParamListArgs
astrs param list arguments.
ParamSetArgs
astrs param set arguments.
RecordStartArgs
astrs record start arguments.
RecordStopArgs
astrs record stop arguments.
ReplayArgs
astrs replay arguments.
RestartArgs
astrs restart arguments.
Ros2DoctorArgs
astrs ros2 doctor arguments.
Ros2TopicsArgs
astrs ros2 topics arguments.
RunArgs
astrs run arguments.
RuntimeArgs
astrs runtime arguments (internal — spawned by a daemon for a manifest node whose source is operators:).
SchemaCliArgs
astrs schema arguments.
StartArgs
astrs start arguments.
StatusArgs
astrs status arguments.
StopArgs
astrs stop arguments.
TokenMintArgs
astrs token mint arguments.
TopArgs
astrs top arguments.
TopicEchoArgs
astrs topic echo arguments.
TopicHzArgs
astrs topic hz arguments.
TopicInfoArgs
astrs topic info arguments.
TopicPubArgs
astrs topic pub arguments.
TraceArgs
astrs trace arguments.
UpArgs
astrs up arguments.
ValidateCliArgs
astrs validate arguments.

Enums§

BagCommand
astrs bag subcommands.
ColorMode
When to colorize human-readable output with plain ANSI SGR codes.
Command
The full astrs verb set (blueprint §17).
GraphFormatArg
The --format values astrs graph accepts (a thin clap::ValueEnum wrapper over GraphFormat, which has no clap dependency of its own — keeping astrs-graph’s presentation-neutral emitters decoupled from this crate’s argument-parsing choices).
HubCommand
astrs hub subcommands.
MigrateCommand
astrs migrate subcommands.
NewCommand
astrs new subcommands.
NodeCommand
astrs node subcommands (blueprint §8, §17 dynamic topology).
ParamCommand
astrs param subcommands.
QueuePolicyArg
The queue eviction policy for a connected input (astrs node connect --queue-policy) — this crate’s own copy of astrs_wire::QueuePolicy (blueprint §11.2), which sits below clap in the layer stack and so cannot derive ValueEnum itself.
RecordCommand
astrs record subcommands.
ReplayTimingMode
How astrs replay’s generated astrs-replay-node instances pace their re-emitted entries.
Ros2Command
astrs ros2 subcommands.
TokenCommand
astrs token subcommands.
TokenScopeArg
The scope astrs token mint --scope accepts — this crate’s own copy of astrs_wire::RequestScope (blueprint §16), which sits below clap in the layer stack and so cannot derive ValueEnum itself.
TopicCommand
astrs topic subcommands.