🍭 CLI
Built-in Commands
Included with your setup is a comprehensive collection of built-in commands to cover your basic needs. All of these commands use Taskipy to simplify commands and give you one simple path to interacting with your app.
# run src/project_name/project_name.py
task run
# run all tests
task tests
# run tests with multiple python versions (3.13,3.12,3.11,3.10)
task nox
# run test coverage and generate report
task coverage
# typechecking with Ty or Mypy
task type
# ruff linting
task lint
# format with ruff
task format
# generate docs & serve
task docs
# serve docs
task serve
# generate static HTML docs (outputs to ./site/)
task html
Also you can use the command task --list to see a complete list with helper text.
Adding Your Own Commands
To add your own commands goto the [tool.taskipy.tasks] section in your pyproject.toml file. Heres an example of adding a task to run Black:
[tool.taskipy.tasks]
black = "black path/to/my_module"
# Alternatively you can add some helper text but its optional
black = { cmd = "black path/to/my_module", help = "Format my_module with Black" }
To execute that command simply run:
task black