boolean_true

An argument of the boolean_true type acts like a boolean flag with a default value of false. When called as an argument it sets the boolean to true.

Example:

arguments:
  - name: --silent
    type: boolean_true
    description: Ignore console output
    alternatives: ["-s"]

alternatives

Type: String / List of String

List of alternative format variations for this argument.

description

Type: String

A description of the argument. This will be displayed with --help.

info

Type: Json

Structured information. Can be any shape: a string, vector, map or even nested map.

Example:

info:
  category: cat1
  labels: [one, two, three]

name

Type: String

The name of the argument. Can be in the formats --silent, -s or silent. The number of dashes determines how values can be passed:

  • --silent is a long option, which can be passed with executable_name --silent
  • -s is a short option, which can be passed with executable_name -s
  • silent is an argument, which can be passed with executable_name silent

type

Type: String

Specifies the type of the argument.