Variables

set

Set a variable to a literal value.

- set:
    name: greeting
    value: "Hello!"

- set:
    name: count
    value: 0

Copy one variable's value to another.

- copy_var:
    from: source_var
    to: destination_var

Get the current date/time as a formatted string.

- get_datetime:
    format: "%Y%m%d"      # → "20241215"
    save_as: today

- get_datetime:
    format: "%Y-%m-%d %H:%M:%S"
    save_as: timestamp

Format follows chrono strftime.

Get the current OS user name.

- get_username:
    save_as: user

Evaluate an arithmetic expression.

- calc:
    expr: "price * quantity"
    save_as: total

- calc:
    expr: "index + 1"
    save_as: next_index

Increment a numeric variable by 1 (or a custom step).

- increment:
    name: counter

- increment:
    name: counter
    by: 5

Convert between full-width and half-width characters (Japanese text handling).

- to_fullwidth:
    value: "{{ text }}"
    save_as: full

- to_halfwidth:
    value: "{{ text }}"
    save_as: half

Load a row from a CSV or Excel file as variables.

- import_vars:
    file: data.xlsx
    sheet: Sheet1         # optional, default: first sheet
    row: 0                # 0-based row index

Each column value is stored as a list in __rows__, or as named variables if the first row is a header.

Persist variables to / restore from a JSON file.

- save_vars:
    file: state.json

- load_vars:
    file: state.json