acton doc
Reference manual for the acton doc command
Synopsis
acton doc [options] command
Description
Look up built-in reference documentation from the terminal.
At the moment, acton doc provides TVM instruction lookup through the tvm
subcommand.
Subcommands
acton doc tvm
Lookup TVM instructions by exact name or fuzzy search query.
Synopsis
acton doc tvm [options] instruction...
Options
Instruction names or search queries.
Treat the input as a fuzzy search query instead of an exact instruction name.
Include descriptions in fuzzy matching.
Requires --find.
Emit JSON instead of formatted text.
Behavior
Without --find, each argument is treated as an instruction name.
- name matching is case-insensitive
-and#are normalized for convenience- JSON mode always returns an array of instruction objects
- at least one instruction name is required
With --find, each argument is treated as a search query.
- fuzzy matching uses instruction names by default
--descriptionalso matches instruction descriptions, tags, and operands- JSON mode returns query/matches objects
- at least one query is required
- queries with no matches return an error instead of an empty result set
Topics
Currently available documentation namespaces:
tvm
Additional namespaces may be added in future releases; acton doc tvm is the
current built-in reference surface.
Exit Status
0: The requested documentation was printed successfully.1: The namespace was unknown, arguments were invalid, or rendering failed.
Display Options
Control when to use colored output.
auto, always, never
Project Options
Accepted as a global Acton option for CLI consistency.
This command does not require an existing project manifest for its primary
workflow. It remains mutually exclusive with --project-root.
Accepted as a global Acton option for CLI consistency.
This command does not require an existing project root for its primary
workflow. It remains mutually exclusive with --manifest-path.
Examples
-
Exact lookup:
acton doc tvm ADD acton doc tvm ADD SUB -
JSON output:
acton doc tvm SENDRAWMSG --json -
Fuzzy search:
acton doc tvm SENRAWMSG --find acton doc tvm outcomng --find --description -
Compare exact lookup with fuzzy search:
acton doc tvm SENDRAWMSG acton doc tvm SENRAWMSG --find
See Also
Last updated on