repeatable-flag

Repeatable Flag Example

Demonstrates the use of repeatable flags that allow users to run commands such as download -d one -d "two three" -vvv.

This example was generated with:

$ bashly init --minimal
# ... now edit src/bashly.yml to match the example ...
# ... now edit src/root_command.sh to match the example ...
$ bashly generate

---

bashly.yml

name: download
help: Sample application to demonstrate the use of repeatable flags
version: 0.1.0

flags:
- long: --data
  short: -d
  arg: data
  help: Provide data values

  # Setting this to true on a flag with an argument means the user can type it
  # multiple times, like --data a --data b.
  # The argument will be received as a quoted and space-delimited string which
  # needs to be converted to an array with `eval "data=(${args[--data]})"`.
  repeatable: true

- long: --path
  short: -p
  arg: location
  help: Specify one or more paths
  repeatable: true

  # Setting this to true will ignore repeating arguments that are not unique.
  unique: true

  # Setting default value(s) for a repeatable flag argument may be done in an
  # array form (or a string form if it is a single default value only).
  default:
  - file one
  - file-two

- long: --verbose
  short: -v
  help: Set verbosity level

  # Setting this to true on a regular flag means the user can type it multiple
  # times, in the form of -vvv or -v -v -v.
  # The argument's value will hold the number of times it was entered.
  repeatable: true

examples:
- download -d one -d "two three" -vvv
- download -d one -p /usr/bin -p /tmp

src/root_command.sh

# Convert the space delimited string to an array
eval "data=(${args[--data]:-})"

echo "Data elements:"
for i in "${data[@]}"; do
  echo "$i"
done

# The --verbose arg will contain the number of times it was used by the user
verbose=${args[--verbose]:-1}
echo ""
echo "Verbosity level: $verbose"
echo ""

inspect_args

Output

$ ./download -h

download - Sample application to demonstrate the use of repeatable flags

Usage:
  download [OPTIONS]
  download --help | -h
  download --version

Options:
  --data, -d DATA (repeatable)
    Provide data values

  --path, -p LOCATION (repeatable)
    Specify one or more paths
    Default: file one, file-two

  --verbose, -v (repeatable)
    Set verbosity level

  --help, -h
    Show this help

  --version
    Show version number

Examples:
  download -d one -d "two three" -vvv
  download -d one -p /usr/bin -p /tmp

$ ./download

Data elements:

Verbosity level: 1

args:
- ${args[--path]} = file\ one file-two

$ ./download -d one -d "two three" -vvv

Data elements:
one
two three

Verbosity level: 3

args:
- ${args[--data]} = one two\ three
- ${args[--path]} = file\ one file-two
- ${args[--verbose]} = 3

$ ./download -d one --path /bin --path /usr/lib --path /bin

Data elements:
one

Verbosity level: 1

args:
- ${args[--data]} = one
- ${args[--path]} = /bin /usr/lib