rafa pages
- rafa
- rafa describe
rafa describe
The whole command roster as data: every subject, action, argument and flag, for a script or an agent to read.
rafa describe --output=json prints the same roster the help shows, as data, with the 🪙 marks.
Spends: nothing. Changes: nothing.
In the target layout's cut table this code counts toward the command-line package, @open-tomato/rafa, at the root of the repository, which is where it lives in 0.47.0 too (Repository layout). [verify: its final placement]
Reference: rafa describe
Print every command rafa dispatches as one JSON document.
rafa describePrints the roster of every command this invocation can dispatch as one JSON document, schema 2: each subject with its summary and its actions, then the top-level commands, each with its summary, description, arguments, flags, examples, outputs, aliases, deprecation and the module it comes from. A hidden command is left out, and an action a module provides is listed after the actions of the subject whose exec action reaches it. With --output=json the document is the data of the terminal result event; otherwise it is printed as indented JSON.
Examples:
rafa describe --output=json: Writes a start event, then a result event whose data is the document.rafa describe: Prints the document as JSON indented by two spaces.
Output formats: text, json.