Class RpcCommandOptions

alias is an array of aliases that can be used instead of the first word in Use.

Generated

from field: repeated string alias = 6;

deprecated defines, if this command is deprecated and should print this string when used.

Generated

from field: string deprecated = 8;

example is examples of how to use the command.

Generated

from field: string example = 5;

flag_options are options for flags generated from rpc request fields. By default all request fields are configured as flags. They can also be configured as positional args instead using positional_args.

Generated

from field: map<string, cosmos.autocli.v1.FlagOptions> flag_options = 10;

long is the long message shown in the 'help ' output.

Generated

from field: string long = 3;

positional_args specifies positional arguments for the command.

Generated

from field: repeated cosmos.autocli.v1.PositionalArgDescriptor positional_args = 11;

rpc_method is short name of the protobuf rpc method that this command is generated from.

Generated

from field: string rpc_method = 1;

short is the short description shown in the 'help' output.

Generated

from field: string short = 4;

skip specifies whether to skip this rpc method when generating commands.

Generated

from field: bool skip = 12;

suggest_for is an array of command names for which this command will be suggested - similar to aliases but only suggests.

Generated

from field: repeated string suggest_for = 7;

use is the one-line usage method. It also allows specifying an alternate name for the command as the first word of the usage text.

By default the name of an rpc command is the kebab-case short name of the rpc method.

Generated

from field: string use = 2;

version defines the version for this command. If this value is non-empty and the command does not define a "version" flag, a "version" boolean flag will be added to the command and, if specified, will print content of the "Version" variable. A shorthand "v" flag will also be added if the command does not define one.

Generated

from field: string version = 9;