Skip to main content

Strongly typed, zero-effort CLI interfaces

Project description


tyro logo

Documentation   •   pip install tyro

build mypy pyright ruff codecov codecov


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.
  • Completion script generation for bash, zsh, and tcsh.
  • Fine-grained configuration via PEP 529 runtime 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
GitHub star count
Open-source tools for neural radiance fields.
Sea-Snell/JAXSeq
GitHub star count
Library for distributed training of large language models in JAX.
kevinzakka/obj2mjcf
GitHub star count
Interface for processing composite Wavefront OBJ files for Mujoco.
blurgyy/jaxngp
GitHub star count
CUDA-accelerated implementation of instant-ngp, in JAX.
NVIDIAGameWorks/kaolin-wisp
GitHub star count
PyTorch library for neural fields.
autonomousvision/sdfstudio
GitHub star count
Unified framework for surface reconstruction.
openrlbenchmark/openrlbenchmark
GitHub star count
Collection of tracked experiments for reinforcement learning.

Alternatives

tyro bakes many opinions into its design decisions. If any of them 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.

Project details


Download files

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

Source Distribution

tyro-0.6.1.tar.gz (103.9 kB view details)

Uploaded Source

Built Distribution

tyro-0.6.1-py3-none-any.whl (78.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tyro-0.6.1.tar.gz
  • Upload date:
  • Size: 103.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.18

File hashes

Hashes for tyro-0.6.1.tar.gz
Algorithm Hash digest
SHA256 7211a94f0b09b8a8a803d5702578106ce6bc859b4f18ca9480af15b1fcf76617
MD5 49ebc5002f2f4adc351474974b33eea9
BLAKE2b-256 06985cc227737c90634e5832fec41224abec056c68a1b6743ca5bf56d03e4abf

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tyro-0.6.1-py3-none-any.whl
  • Upload date:
  • Size: 78.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.18

File hashes

Hashes for tyro-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bf0389e14a3c68830bd018b315adfe6f2ffacc1bad45d2903c087f9037bdc0cc
MD5 80129778fc7656da5ffe4d79d1100786
BLAKE2b-256 f62b8d97a3d2273c55a48ffe73f5cf737a621a356eef8d499101ac6b44240aba

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page