Command::hide

hide

since 0.1.0

Specifies that this subcommand should be hidden from help messages.

Example

Spec

TOML

name = "myprog"
[[subcommands]]
name = "beta"
about = "Some help and text"
[[subcommands]]
name = "alpha"
about = "I should be hidden!"
hide = true

YAML

name: myprog
subcommands:
- name: beta
  about: Some help and text
- name: alpha
  about: I should be hidden!
  hide: true

JSON

{
  "name": "myprog",
  "subcommands": [
    {
      "name": "beta",
      "about": "Some help and text"
    },
    {
      "name": "alpha",
      "about": "I should be hidden!",
      "hide": true
    }
  ]
}

Input

myprog --help

Output

Usage: myprog [COMMAND]

Commands:
  beta  Some help and text
  help  Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help