Help

The help RPC lists all available public RPC commands, or gets help for the specified RPC. Commands which are unavailable will not be listed, such as wallet RPCs if wallet support is disabled.

Parameter—the name of the RPC to get help for

Name Type Presence Description
RPC string Optional
(0 or 1)
The name of the RPC to get help for.

Result—a list of RPCs or detailed help for a specific RPC

Name Type Presence Description
result string Required
(exactly 1)
The help text for the specified RPC or the list of commands. The pai-cli command will parse this text and format it as human-readable text

Example

Command to get help about the help RPC:

pai-cli -testnet help help

Result:

help ( "command" )

List all commands, or get help for a specified command.

Arguments:
1. "command"     (string, optional) The command to get help on

Result:
"text"     (string) The help text

See also

  • The RPC Quick Reference