# Argument

Specify positional arguments (required or optional) used by your script.

The argument's value will be available to you as ${args[name]} in your bash function (even if it was provided using the short syntax).

bashly.yml
args:
  - name: user
    help: AWS Username.

  - name: role
    help: User role.
    allowed:
      - admin
      - guest

# name

The name of the argument. Use lowercase letters, since it serves multiple purposes:

  • It will be capitalized in the help text.
  • It will be used as the hash key in the ${args[...]} associative bash array.

# help

The message to display when using --help. Can have multiple lines.

# required

Specify that this argument is required.

# default

The value to use in case it is not provided by the user. Implies that this argument is optional.

Default Values Example

# allowed

Limit the allowed values. Can be used in conjunction with default and required.

Whitelist Example