tyro

codecov PyPI Downloads codecov

Documentation   •   pip install tyro

tyro.cli() is a tool for generating CLI interfaces from type-annotated Python.

We can define configurable scripts using functions:
image

Or instantiate configs defined using tools like dataclasses, pydantic, and attrs:
image

Other features include helptext generation, nested structures, subcommands, and shell completion. For examples and the API reference, see our documentation.

Why tyro?

  1. Define things once. Standard Python type annotations, docstrings, and default values are parsed to automatically generate command-line interfaces with nice helptext.

  2. Static types. Unlike tools dependent on dictionaries, YAML, or dynamic namespaces, arguments populated by tyro are better undestood by IDEs and language servers, as well as static checking tools like pyright and mypy.

  3. Modularity. tyro supports hierarchical configurations, which make it easy to decentralize definitions, defaults, and documentation.

In the wild

tyro is designed to be lightweight for throwaway scripts, while improving maintainability for larger projects. Examples:

nerfstudio-project/nerfstudio
GitHub stars 		Open-source tools for neural radiance fields.
Sea-Snell/JAXSeq
GitHub stars 		Train very large language models in Jax.
kevinzakka/obj2mjcf
GitHub stars 		Interface for processing OBJ files for Mujoco.
blurgyy/jaxngp
GitHub stars 		CUDA-accelerated implementation of instant-ngp, in JAX.
NVIDIAGameWorks/kaolin-wisp
GitHub stars 		PyTorch library for neural fields.
autonomousvision/sdfstudio
GitHub stars 		Unified framework for surface reconstruction.
openrlbenchmark/openrlbenchmark
GitHub stars 		Collection of tracked experiments for reinforcement learning.
vwxyzjn/cleanrl
GitHub stars 		Single-file implementation of deep RL algorithms.
pytorch-labs/LeanRL
GitHub stars 		Fork of CleanRL, optimized using PyTorch 2 features.
pytorch/torchtitan
GitHub stars 		PyTorch-native platform for training generative AI models.
KwaiVGI/LivePortrait
GitHub stars 		Stitching and retargeting for portraits.
Physical-Intelligence/openpi
GitHub stars 		Open-source models for robotics.
NVIDIA/Isaac-GR00T
GitHub stars 		Foundation model for generalist robots.
haosulab/ManiSkill
GitHub stars 		GPU-parallelized simulation + learning for robot manipulation.
mujocolab/mjlab
GitHub stars 		Lightweight, modular abstractions for RL and sim-to-real robotics.
amazon-far/holosoma
GitHub stars 		Humanoid robotics framework for RL training and deployment.
MalcolmMielle/bark_monitor
GitHub stars 		Show your neighbor that your dog doesn't bark!

Alternatives

tyro is opinionated. 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 like:

  • cappa offers a similar core feature set but with very different ergonomics. It looks polished and well-maintained!
  • cyclopts and defopt has very comprehensive type annotation support and a heavier emphasis on subcommand generation.
  • simple-parsing and jsonargparse provide deeper integration with configuration file formats like YAML and JSON.
  • clipstick, which focuses on simplicity + generating CLIs from Pydantic models.
  • datargs provides a minimal API for dataclasses.
  • fire and clize support arguments without type annotations.

There are also some options that directly extend tyro:

  • mininterface simultaneously generates GUI, TUI, web, CLI, and file-based program configuration.
  • manuscript generates CLI interfaces from a simple block of configuration variables.

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

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for brentyi from gravatar.com brentyi

Credits

Author: brentyi

License

MIT License (MIT)

Requires

Python >=3.8

Provides Extra

dev dev-nn

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tyro-1.0.16.tar.gz (603.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tyro-1.0.16-py3-none-any.whl (216.9 kB view details)

Uploaded Python 3

File details

Details for the file tyro-1.0.16.tar.gz.

File metadata

  • Download URL: tyro-1.0.16.tar.gz
  • Upload date:
  • Size: 603.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for tyro-1.0.16.tar.gz
Algorithm Hash digest
SHA256 edf23c9c3eecba5a2b5af152df8f34a723b689a001ff5b7311f93eff1893a636
MD5 469e27f7b5f2202dc5b37ed653532c42
BLAKE2b-256 3c834008dff806dc894fc0422017316982d3f14709046bcb0dfa720cb64501aa

See more details on using hashes here.

File details

Details for the file tyro-1.0.16-py3-none-any.whl.

File metadata

  • Download URL: tyro-1.0.16-py3-none-any.whl
  • Upload date:
  • Size: 216.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for tyro-1.0.16-py3-none-any.whl
Algorithm Hash digest
SHA256 2f9087196113699647190459a12b6b4f2784dd0703c50ab1f7bf0f85a3a794ea
MD5 9922f0e251c24d8715aa69e66118eb1e
BLAKE2b-256 23d9ea12ca0392c9eaeff7421efcc665f350dbc2ef30a113ee13c7afea21cf37

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

1.0.16 This release

2 files

1.0.15

2 files

1.0.14

2 files

1.0.13

2 files

1.0.12

2 files

1.0.11

2 files

1.0.10

2 files

1.0.9

2 files

1.0.8

2 files

1.0.7

2 files

1.0.6

2 files

1.0.5

2 files

1.0.4

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

Pre-release

0.10.0a6

2 files

Pre-release

0.10.0a5

2 files

Pre-release

0.10.0a4

2 files

Pre-release

0.10.0a3

2 files

Pre-release

0.10.0a2

2 files

Pre-release

0.10.0a1

2 files

Pre-release

0.10.0a0

2 files

0.9.35

2 files

0.9.34

2 files

0.9.33

2 files

0.9.32

2 files

0.9.31

2 files

0.9.30

2 files

0.9.29

2 files

0.9.28

2 files

0.9.27

2 files

0.9.26

2 files

0.9.25

2 files

0.9.24

2 files

0.9.23

2 files

0.9.22

2 files

0.9.21

2 files

0.9.20

2 files

0.9.19

2 files

0.9.18

2 files

0.9.17

2 files

0.9.16

2 files

0.9.15

2 files

0.9.14

2 files

0.9.13

2 files

0.9.12

2 files

0.9.11

2 files

0.9.10

2 files

0.9.9

2 files

0.9.8

2 files

0.9.7

2 files

0.9.6

2 files

0.9.5

2 files

0.9.4

2 files

0.9.3

2 files

0.9.2

2 files

0.9.1

2 files

Yanked

0.9.0

2 files

0.8.14

2 files

0.8.13

2 files

0.8.12

2 files

0.8.11

2 files

0.8.10

2 files

0.8.9

2 files

0.8.8

2 files

0.8.7

2 files

0.8.6

2 files

0.8.5

2 files

0.8.4

2 files

0.8.3

2 files

0.8.2

2 files

0.8.1

2 files

0.8.0

2 files

0.7.3

2 files

0.7.2

2 files

0.7.1

2 files

0.7.0

2 files

0.6.6

2 files

0.6.5

2 files

0.6.4

2 files

0.6.3

2 files

0.6.2

2 files

0.6.1

2 files

0.6.0

2 files

0.5.18

2 files

0.5.17

2 files

0.5.16

2 files

0.5.15

2 files

0.5.14

2 files

0.5.13

2 files

0.5.12

2 files

0.5.11

2 files

0.5.10

2 files

0.5.9

2 files

0.5.8

2 files

0.5.7

2 files

0.5.6

2 files

0.5.5

2 files

0.5.4

2 files

0.5.3

2 files

0.5.2

2 files

0.5.1

2 files

0.5.0

2 files

0.4.2

2 files

0.4.1

2 files

0.4.0

2 files

0.3.38

2 files

0.3.37

2 files

0.3.36

2 files

0.3.35

2 files

Yanked

0.3.34

2 files

0.3.33

2 files

0.3.32

2 files

0.3.31

2 files

0.3.30

2 files

0.3.29

2 files

Yanked

0.3.28

2 files

Yanked reason: https://github.com/nerfstudio-project/nerfstudio/issues/882#issuecomment-1301148363

0.3.27

2 files

0.3.26

2 files

0.3.25

2 files

0.3.24

2 files

0.3.23

2 files

0.3.22

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page