Docs
Command reference

acton doc

Reference manual for the acton doc command

Synopsis

acton doc [options] command

Description

Look up reference documentation from the terminal.

acton doc provides contract ABI lookup through the abi subcommand and TVM instruction lookup through the tvm subcommand.

Subcommands

acton doc abi

Print compiler ABI JSON for a local or bundled contract.

Synopsis

acton doc abi contract

Options

<contract>

Contract name, local contract id, or bundled catalog name.

Behavior

acton doc abi first looks at local contracts from Acton.toml, then falls back to the bundled ABI catalog.

  • local lookup accepts the contract id, display name, or ABI contract name
  • bundled catalog lookup accepts the catalog display name or ABI contract name
  • output is always formatted compiler ABI JSON

acton doc tvm

Lookup TVM instructions by exact name or fuzzy search query.

Synopsis

acton doc tvm [options] instruction...

Options

<instruction>...

Instruction names or search queries.

Repeatable:

May be passed multiple times.

-f,--find

Treat the input as a fuzzy search query instead of an exact instruction name.

-d,--description

Include descriptions in fuzzy matching.

Requires:

--find.

--json

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
  • --description also 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:

  • abi
  • tvm

Additional namespaces may be added in future releases.

Exit Status

  • 0: The requested documentation was printed successfully.
  • 1: The namespace was unknown, arguments were invalid, or rendering failed.

Display Options

--color<when>

Control when to use colored output.

Possible values:

auto, always, never

Default:

auto

Project Options

--manifest-path<path>
Pass-through:

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.

Conflicts with:

--project-root

--project-root<path>
Pass-through:

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.

Conflicts with:

--manifest-path

Examples

  1. Exact lookup:

    acton doc tvm ADD
acton doc tvm ADD SUB

  2. JSON output:

    acton doc tvm SENDRAWMSG --json

  3. Fuzzy search:

    acton doc tvm SENRAWMSG --find
acton doc tvm outcomng --find --description

  4. Compare exact lookup with fuzzy search:

    acton doc tvm SENDRAWMSG
acton doc tvm SENRAWMSG --find

  5. Print contract ABI:

    acton doc abi WalletV4r2
acton doc abi counter

See Also

Last updated on

acton disasm

Reference manual for the acton disasm command

acton up

Reference manual for the acton up command

On this page

Synopsis
Description
Subcommands
acton doc abi
Synopsis
Options
Behavior
acton doc tvm
Synopsis
Options
Behavior
Topics
Exit Status
Display Options
Project Options
Examples
See Also