Command::groups

groups

since 0.1.0

Adds multiple ArgGroups to the Command at once.

Example

Spec

TOML

name = "cmd"
[groups]
vers = { args = ["set-ver", "major", "minor", "patch"], required = true }
input = { args = ["config", "iface"] }
[args]
set-ver = { long = "set-ver", help = "set the version manually", required = false }
major = { long = "major", help = "auto increase major" }
minor = { long = "minor", help = "auto increase minor" }
patch = { long = "patch", help = "auto increase patch" }
config = { short = 'c', help = "a config file", required = false }
iface = { short = 'i', help = "an interface", required = false }

YAML

name: cmd
groups:
  vers:
    args:
    - set-ver
    - major
    - minor
    - patch
    required: true
  input:
    args:
    - config
    - iface
args:
  set-ver:
    long: set-ver
    help: set the version manually
    required: false
  major:
    long: major
    help: auto increase major
  minor:
    long: minor
    help: auto increase minor
  patch:
    long: patch
    help: auto increase patch
  config:
    short: c
    help: a config file
    required: false
  iface:
    short: i
    help: an interface
    required: false

JSON

{
  "name": "cmd",
  "groups": {
    "vers": {
      "args": [
        "set-ver",
        "major",
        "minor",
        "patch"
      ],
      "required": true
    },
    "input": {
      "args": [
        "config",
        "iface"
      ]
    }
  },
  "args": {
    "set-ver": {
      "long": "set-ver",
      "help": "set the version manually",
      "required": false
    },
    "major": {
      "long": "major",
      "help": "auto increase major"
    },
    "minor": {
      "long": "minor",
      "help": "auto increase minor"
    },
    "patch": {
      "long": "patch",
      "help": "auto increase patch"
    },
    "config": {
      "short": "c",
      "help": "a config file",
      "required": false
    },
    "iface": {
      "short": "i",
      "help": "an interface",
      "required": false
    }
  }
}

Input

cmd --major 1 -i eth0

Output

claptrap_major='1'
claptrap_iface='eth0'