โ— Shell
clean mode source โ†—

GitHub - remarkablemark/python-cli-template: ๐Ÿ Python CLI template

PyPI version codecov lint

๐Ÿ Python CLI Template

Quick Start

Greet a name:

pipx run python-cli-template --name world

Prerequisites

CLI

Install with pipx:

pipx install python-cli-template

Or install with uv:

uv tool install python-cli-template

--name

Optional: Name to greet. Defaults to World.

python-cli-template --name Alex

--version

Show the program's version number and exit:

python-cli-template --version # python-cli-template -v

Show the help message and exit:

python-cli-template --help # python-cli-template -h

Script

Install the package:

uv add python-cli-template

Greet a name:

# script.py
from python_cli_template import hello

print(hello("Bob"))

Run the script:

License

MIT