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.cli() generates command-line interfaces via Python type introspection. We can define configurable scripts using functions:

"""A command-line interface defined using a function signature.

Usage: python script_name.py --foo INT [--bar STR]
"""

import tyro

def main(
    foo: int,
    bar: str = "default",
) -> None:
    ...  # Main body of a script.

if __name__ == "__main__":
    # Generate a CLI and call `main` with its two arguments: `foo` and `bar`.
    tyro.cli(main)

Or instantiate configuration objects defined using tools like dataclasses, pydantic, and attrs:

"""A command-line interface defined using a class signature.

Usage: python script_name.py --foo INT [--bar STR]
"""

from dataclasses import dataclass
import tyro

@dataclass
class Config:
    foo: int
    bar: str = "default"

if __name__ == "__main__":
    # Generate a CLI and instantiate `Config` with its two arguments: `foo` and `bar`.
    config = tyro.cli(Config)

    # Rest of script.
    assert isinstance(config, Config)  # Should pass.

Other features include helptext generation, nested structures, shell completion, and subcommands. 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
Train very large language models in Jax.
kevinzakka/obj2mjcf
GitHub star count
Interface for processing 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.
vwxyzjn/cleanrl
GitHub star count
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.

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.8.8.tar.gz (133.0 kB view details)

Uploaded Source

Built Distribution

tyro-0.8.8-py3-none-any.whl (104.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tyro-0.8.8.tar.gz
  • Upload date:
  • Size: 133.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.14

File hashes

Hashes for tyro-0.8.8.tar.gz
Algorithm Hash digest
SHA256 dab62f6942d216c502d051daa9bacc9335e43e688b7abad64b563fb727b20a75
MD5 bf9d16e4c5351837d77419a548ea7d89
BLAKE2b-256 81862779135dc5c166be0980bb9046eaf0ca197c00bba7553d2036d67163d240

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tyro-0.8.8-py3-none-any.whl
  • Upload date:
  • Size: 104.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.14

File hashes

Hashes for tyro-0.8.8-py3-none-any.whl
Algorithm Hash digest
SHA256 1f1c85abd3ec28951bb5eaecfb4e9350c9b2dfe1dd57111d6c0830f8aadd392d
MD5 d09b656ce57942dcc209395013d96f1b
BLAKE2b-256 b20bddccd9da09d56f3ac895233a29c9bd9ebcad9d687a6c1445df8aea1ac568

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