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.1.post1.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.1.post1-py3-none-any.whl (16.4 kB view details)

Uploaded Python 3

File details

Details for the file yeetr-2026.7.1.post1.tar.gz.

File metadata

  • Download URL: yeetr-2026.7.1.post1.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.1.post1.tar.gz
Algorithm Hash digest
SHA256 e282f59e9e31794cb88250d23ea5917f0c9ebdeb723365473a6ad7688b91f9cc
MD5 a20974c2364af8815a9cc592361e79cc
BLAKE2b-256 0e1108835afb41e1551f5fdabcb15e118fc21ba20145d4d622d582c6abdc4a56

See more details on using hashes here.

File details

Details for the file yeetr-2026.7.1.post1-py3-none-any.whl.

File metadata

  • Download URL: yeetr-2026.7.1.post1-py3-none-any.whl
  • Upload date:
  • Size: 16.4 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.1.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 ce73dc84b0afc1ccf49a631c5616bf0f9424294b1b12affb274cc235dbb9d902
MD5 80e2d1adb2865045ba50bc3f03bf4e0c
BLAKE2b-256 e68ff0800757384dd86867e8255ab83e6c06198303db1299e065d647eb37e64d

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