Command::visible_long_flag_aliases

visible_long_flag_aliases

since 0.1.0

Add aliases, which function as visible long flag subcommands.

Examples

Example 1

Spec

TOML

name = "myprog"
[[subcommands]]
name = "test"
long-flag = "test"
visible-long-flag-aliases = ["testing", "testall", "test_all"]
[subcommands.args]
input = { required = false, help = "the file to add" }

YAML

name: myprog
subcommands:
- name: test
  long-flag: test
  visible-long-flag-aliases:
  - testing
  - testall
  - test_all
  args:
    input:
      required: false
      help: the file to add

JSON

{
  "name": "myprog",
  "subcommands": [
    {
      "name": "test",
      "long-flag": "test",
      "visible-long-flag-aliases": [
        "testing",
        "testall",
        "test_all"
      ],
      "args": {
        "input": {
          "required": false,
          "help": "the file to add"
        }
      }
    }
  ]
}

Input

prog --testing file.txt

Output

claptrap__subcommand='test'
claptrap_test_input='file.txt'

Example 2

Spec

TOML

name = "myprog"
[[subcommands]]
name = "test"
long-flag = "test"
visible-long-flag-aliases = ["testing", "testall", "test_all"]
[subcommands.args]
input = { required = false, help = "the file to add" }

YAML

name: myprog
subcommands:
- name: test
  long-flag: test
  visible-long-flag-aliases:
  - testing
  - testall
  - test_all
  args:
    input:
      required: false
      help: the file to add

JSON

{
  "name": "myprog",
  "subcommands": [
    {
      "name": "test",
      "long-flag": "test",
      "visible-long-flag-aliases": [
        "testing",
        "testall",
        "test_all"
      ],
      "args": {
        "input": {
          "required": false,
          "help": "the file to add"
        }
      }
    }
  ]
}

Input

prog --help

Output

Usage: prog [COMMAND]

Commands:
  test, --test  [aliases: --testing, --testall, --test_all]
  help          Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help