Functions

In the simplest case, tyro.cli() can be used to run a function with arguments populated from the CLI.

import tyro


def main(
    field1: str,
    field2: int = 3,
) -> None:
    """Function, whose arguments will be populated from a CLI interface.

    Args:
        field1: A string field.
        field2: A numeric field, with a default value.
    """
    print(field1, field2)


if __name__ == "__main__":
    tyro.cli(main)

---

python 01_basics/01_functions.py --help

usage: 01_functions.py [-h] --field1 STR [--field2 INT]

Function, whose arguments will be populated from a CLI interface.

╭─ options ───────────────────────────────────────────────────────────────╮
│ -h, --help          show this help message and exit                     │
│ --field1 STR        A string field. (required)                          │
│ --field2 INT        A numeric field, with a default value. (default: 3) │
╰─────────────────────────────────────────────────────────────────────────╯

---

python 01_basics/01_functions.py --field1 hello

hello 3

---

python 01_basics/01_functions.py --field1 hello --field2 10

hello 10