DannyBen/bashly

name: cli
help: Sample application that requires environment variables
version: 0.1.0

# This option adds usage text to the help message in the generated script.
environment_variables:
- name: api_key
  help: Set your API key

commands:
- name: verify
  alias: v
  help: Verify your user

  # This option belongs to the `verify` command and will appear in its help
  # message.
  environment_variables:
  # Setting `required: true` will halt the script's execution with a
  # friendly error message, unless the variable is set.
  - name: my_secret
    help: Your secret
    required: true
  
  # Using the `default: value` option will cause the value to variable to be 
  # set if it is not provided by the user.
  - name: region
    help: Cloud region
    default: us-east-2

  # Using the `allowed: [value1, value2]` option will halt the script's
  # execution with a friendly error message, unless the variable matches one
  # of the defined values.
  - name: environment
    help: One of development, production or test
    allowed: [development, production, testing]
    default: development