Skip to main content

A tiny, typed, signature-driven CLI runner.

Project description

yeetr

yeetr, build tiny CLIs. Easy to code. Based on Python type hints.

Build Release Coverage Package version Supported Python versions License

yeetr

A tiny, typed, signature-driven CLI runner. Supports Python 3.13 and 3.14.

No decorators. No command classes. No ceremony. Just yeet the function.

Write a plain function, run it from the command line — yeetr turns the signature into args and options for you:

# app.py
def main(thing: int, *, n: float = 0.1) -> None:
    print(thing, n)
yeet app.py 5 -n 0.2

No if __name__ == "__main__" block, no yeetr.run(...) call, no decorators. Parameters before the bare * become positional args, parameters after it become --options.

Install

uv add yeetr

Highlights

  • Zero boilerplateyeet app.py finds and runs main, and scaffolds the file if it doesn't exist yet.
  • Executable shebangs#!yeet makes a script runnable on its own.
  • Fully typedstr, int, float, bool, Path, Literal, Enum, T | None, list[T], tuples, and structured dataclass/NamedTuple args, all Pyright-strict clean.
  • Async-nativeasync def main just works, with automatic uvloop if it's installed.
  • Rich output — formatted logging and help/error tables out of the box.

yeetr help output

Docs

The full guide — parameter metadata, env var fallback, path validators, runtime behavior, a yeetr vs. typer comparison, and the API reference — lives at rogerthomas.github.io/yeetr.

Contributing

See CONTRIBUTING.md for how to set up a dev environment, run the test suite, and submit changes.

License

MIT

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

yeetr-2026.7.2.tar.gz (15.2 kB view details)

Uploaded Source

Built Distribution

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

yeetr-2026.7.2-py3-none-any.whl (16.3 kB view details)

Uploaded Python 3

File details

Details for the file yeetr-2026.7.2.tar.gz.

File metadata

  • Download URL: yeetr-2026.7.2.tar.gz
  • Upload date:
  • Size: 15.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for yeetr-2026.7.2.tar.gz
Algorithm Hash digest
SHA256 ae9b7a2443456b99daf9a1babd3aeb3e3b4f7fc36e78514918e7822ee4f500aa
MD5 ca600956c78f26fc3764abbf726c45f3
BLAKE2b-256 01850bf7ff997d95c58d302758d30cbe14060177c574c2ca8528a08fcc0aca28

See more details on using hashes here.

File details

Details for the file yeetr-2026.7.2-py3-none-any.whl.

File metadata

  • Download URL: yeetr-2026.7.2-py3-none-any.whl
  • Upload date:
  • Size: 16.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for yeetr-2026.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8aada2ac3c31b4040269459b0167dfd23c1e09da08815392ff494a6e8bf32672
MD5 eb3cc601c57c47172fac8a4c989370fe
BLAKE2b-256 a2220c59bf186de333f96ef8ee1184d2b787f1f40e28f373aabb47a8fc7049d4

See more details on using hashes here.

Supported by

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