Skip to content

README.md

Latest commit

 

History

History
94 lines (62 loc) · 1.5 KB

README.md

File metadata and controls

94 lines (62 loc) · 1.5 KB

Conflicting Flags Example

Demonstrates the use of conflicting flags that cannot be executed together.

This example was generated with:

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

bashly.yml

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

flags:
- long: --cache
  help: Enable cache
  # Running --cache with --no-cache is not permitted
  conflicts: [--no-cache]
- long: --no-cache
  help: Disable cache
  # Running --no-cache with --cache or with --fast is not permitted
  conflicts: [--cache, --fast]
- long: --fast
  help: Run faster
  # Make sure to add the conflicting flags in both flags
  conflicts: [--no-cache]

Output

$ ./download -h

download - Sample application to demonstrate the use of conflicting flags

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

Options:
  --cache
    Enable cache
    Conflicts: --no-cache

  --no-cache
    Disable cache
    Conflicts: --cache, --fast

  --fast
    Run faster
    Conflicts: --no-cache

  --help, -h
    Show this help

  --version, -v
    Show version number

$ ./download --cache

# this file is located in 'src/root_command.sh'
# you can edit it freely and regenerate (it will not be overwritten)
args:
- ${args[--cache]} = 1

$ ./download --no-cache --fast

conflicting options: --fast cannot be used with --no-cache