brentyi / tyro

Zero-effort CLI interfaces & config objects, from types

Documentation   •   pip install tyro

tyro is a tool for generating command-line interfaces and configuration objects in Python.

Our core API, tyro.cli(),

• Generates CLI interfaces from Python type signatures.
• Populates helptext automatically from defaults, annotations, and docstrings.
• Understands nesting of dataclasses, pydantic, and attrs structures.
• Prioritizes static analysis for type checking and autocompletion with tools like Pylance, Pyright, and mypy.

For advanced users, it also supports:

• Subcommands, as well as choosing between and overriding values in configuration objects.
• Shell completion for bash, zsh, and tcsh.
• Fine-grained configuration via PEP 593 annotations (tyro.conf.*).

For examples and the API reference, see our documentation.

In the wild

tyro is designed to be lightweight enough for throwaway scripts, while facilitating type safety and modularity for larger projects. Examples:

nerfstudio-project/nerfstudio	Open-source tools for neural radiance fields.
Sea-Snell/JAXSeq	Train very large language models in Jax.
kevinzakka/obj2mjcf	Interface for processing OBJ files for Mujoco.
blurgyy/jaxngp	CUDA-accelerated implementation of instant-ngp, in JAX.
NVIDIAGameWorks/kaolin-wisp	PyTorch library for neural fields.
autonomousvision/sdfstudio	Unified framework for surface reconstruction.
openrlbenchmark/openrlbenchmark	Collection of tracked experiments for reinforcement learning.
vwxyzjn/cleanrl	Single-file implementation of deep RL algorithms.

Alternatives

tyro is an opinionated library. If any design decisions don't make sense, feel free to file an issue!

You might also consider one of many alternative libraries. Some that we particularly like:

• simple-parsing and jsonargparse, which provide deeper integration with configuration file formats like YAML and JSON.
• clipstick, which focuses on generating CLIs from Pydantic models.
• datargs, which provides a minimal API for dataclasses.
• fire and clize, which support arguments without type annotations.

We also have some notes on tyro's design goals and other alternatives in the docs here.