help

Provides help for any command in the application. Type memsqlctl help [command] for full details.

Usage

memsqlctl help [command] [flags]

Flags:
  -h, --help   help for help

Global Flags:
  -c, --config FILE_PATH                     Path to the memsqctl config file
      --default-install-dir DIRECTORY_PATH   Path to the default install directory
  -j, --json                                 Print output in JSON format
      --node-metadata-file FILE_PATH         Path to the node metadata file
      --parallelism int                      Maximum amount of operations to be run in parallel
      --ssl-ca FILE_PATH                     Path to the CA certificate file in PEM format to authenticate the MemSQL server certificate
      --timeout duration                     Maximum time for operation to complete (e.g., 30s, 10m, 1.5h)
  -v, --verbosity count                      Increase logging verbosity
  -y, --yes                                  Enable non-interactive mode and assume the user would like to move forward with the proposed actions by default

Remarks

You can also retrieve help for any command by typing memsqlctl [command] --help.

This command is interactive unless you use either the --yes or --json flags to override interactive behavior.

Output

The following is the standard output for the help command.

$ memsqlctl help show-license
Show license information for a node on this host

Usage:
  memsqlctl show-license [flags]

Flags:
  -h, --help               help for show-license
      --memsql-id string   the MemSQL ID of the node

Global Flags:
  -c, --config FILE_PATH                     Path to the memsqctl config file
      --default-install-dir DIRECTORY_PATH   Path to the default install directory
  -j, --json                                 Print output in JSON format
      --node-metadata-file FILE_PATH         Path to the node metadata file
      --ssl-ca FILE_PATH                     Path to the CA certificate file in PEM format to authenticate theMemSQL server certificate
      --timeout duration                     Maximum time for operation to complete (e.g., 30s, 10m, 1.5h)
  -v, --verbosity count[=-1]                 Increase logging verbosity
  -y, --yes                                  Enable non-interactive mode and assume the user would like to move forward with the proposed actions by default
Was this article useful?