package cosmos.autocli.v1

Get desktop application:
View/edit binary Protocol Buffers messages

RemoteInfoService provides clients with the information they need to build dynamically CLI clients for remote chains.

• rpc AppOptions (AppOptionsRequest, AppOptionsResponse)

  query.proto:14

  AppOptions returns the autocli options for all of the modules in an app.

  message AppOptionsRequest

  query.proto:22

  AppOptionsRequest is the RemoteInfoService/AppOptions request type.

  (message has no fields)

  message AppOptionsResponse

  query.proto:25

  AppOptionsResponse is the RemoteInfoService/AppOptions response type.

  • map<string, ModuleOptions> module_options = 1

    module_options is a map of module name to autocli module options.

FlagOptions are options for flags generated from rpc request fields. By default, all request fields are configured as flags based on the kebab-case name of the field. Fields can be turned into positional arguments instead by using RpcCommandOptions.positional_args.

Used in: RpcCommandOptions

• string name = 1

  name is an alternate name to use for the field flag.

• string shorthand = 2

  shorthand is a one-letter abbreviated flag.

• string usage = 3

  usage is the help message.

• string default_value = 4

  default_value is the default value as text.

• string no_opt_default_value = 5

  default value is the default value as text if the flag is used without any value.

• string deprecated = 6

  deprecated is the usage text to show if this flag is deprecated.

• string shorthand_deprecated = 7

  shorthand_deprecated is the usage text to show if the shorthand of this flag is deprecated.

• bool hidden = 8

  hidden hides the flag from help/usage text

ModuleOptions describes the CLI options for a Cosmos SDK module.

Used in: AppOptionsResponse

• optional ServiceCommandDescriptor tx = 1

  tx describes the tx command for the module.

• optional ServiceCommandDescriptor query = 2

  query describes the tx command for the module.

PositionalArgDescriptor describes a positional argument.

Used in: RpcCommandOptions

• string proto_field = 1

  proto_field specifies the proto field to use as the positional arg. Any fields used as positional args will not have a flag generated.

• bool varargs = 2

  varargs makes a positional parameter a varargs parameter. This can only be applied to last positional parameter and the proto_field must a repeated field.

RpcCommandOptions specifies options for commands generated from protobuf rpc methods.

Used in: ServiceCommandDescriptor

• string rpc_method = 1

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

• string use = 2

  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.

• string long = 3

  long is the long message shown in the 'help <this-command>' output.

• string short = 4

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

• string example = 5

  example is examples of how to use the command.

• repeated string alias = 6

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

• repeated string suggest_for = 7

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

• string deprecated = 8

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

• string version = 9

  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.

• map<string, FlagOptions> flag_options = 10

  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.

• repeated PositionalArgDescriptor positional_args = 11

  positional_args specifies positional arguments for the command.

• bool skip = 12

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

ServiceCommandDescriptor describes a CLI command based on a protobuf service.

Used in: ModuleOptions

• string service = 1

  service is the fully qualified name of the protobuf service to build the command from. It can be left empty if sub_commands are used instead which may be the case if a module provides multiple tx and/or query services.

• repeated RpcCommandOptions rpc_command_options = 2

  rpc_command_options are options for commands generated from rpc methods. If no options are specified for a given rpc method on the service, a command will be generated for that method with the default options.

• map<string, ServiceCommandDescriptor> sub_commands = 3

  sub_commands is a map of optional sub-commands for this command based on different protobuf services. The map key is used as the name of the sub-command.