github.com/facebookincubator/ttpforge@v1.0.13-0.20240405153150-5ae801628835/example-ttps/args/basic.yaml (about)

     1  ---
     2  api_version: 2.0
     3  uuid: 2ae7c2ae-39be-4114-8618-306a62eedec2
     4  name: Basic Command-Line Arguments
     5  description: |
     6    TTPForge allows users to configure their TTPs' expected command-line
     7    arguments in various ways. This TTP demonstrates the following
     8    basic command-line argument options:
     9      * Support for Various Argument Types (string, int, bool, etc)
    10      * Default Values for Arguments
    11  args:
    12    - name: str_to_print
    13      description: this argument is of the default type `string`
    14    - name: has_a_default_value
    15      description: |
    16        the default value will be used if the user does not explicitly
    17        specify a value
    18      default: this_is_the_default
    19    - name: run_second_step
    20      type: bool
    21      default: false
    22    - name: int_arg
    23      type: int
    24      default: 1337
    25  steps:
    26    - name: first_Step
    27      print_str: |
    28        Value of argument `str_to_print`: {{.Args.str_to_print}}
    29        Value of argument `has_a_default_value`: {{.Args.has_a_default_value}}
    30    {{ if .Args.run_second_step }}
    31    - name: second_step
    32      print_str: |
    33        You must have passed `--run_second_step=true`
    34        Doing some math : {{add .Args.int_arg 5}}
    35    {{ end }}