Quick Reference
Global Options
All pyrig commands support verbosity control through global flags:Verbosity Flags
Debug output with level prefix. Can be stacked for more detail.
Quiet mode - only show warnings and errors (WARNING level).
Logging Levels
| Flag | Level | Format | Use Case |
|---|---|---|---|
| (none) | INFO | Clean messages only | Default, production use |
-q | WARNING | Level prefix + message | Minimal output |
-v | DEBUG | Level prefix + message | Basic debugging |
-vv | DEBUG | Level + module + message | Module-level debugging |
-vvv | DEBUG | Timestamp + level + module + message | Full diagnostic output |
Command Categories
Project Setup
- init - Complete project initialization from scratch
- mkroot - Create/update configuration files
- mkinits - Generate missing
__init__.pyfiles
Development
- mktests - Generate test skeletons
- scratch - Execute temporary
.scratchfile - rmpyc - Clean up
__pycache__directories
Build & Deployment
- build - Build distributable artifacts
- protect-repo - Configure GitHub security
Utility Commands
- version - Display project version
Usage Patterns
First-Time Setup
Updating Configuration
Development Workflow
Building for Distribution
Command Discovery
pyrig’s CLI uses dynamic command discovery:- Project-specific commands - Functions in
<package>.rig.cli.subcommands - Shared commands - Functions in
<package>.rig.cli.shared_subcommandsacross the dependency chain - Main entry point -
main()function from<package>.main
All commands are idempotent and safe to run multiple times unless explicitly noted otherwise.
Next Steps
init Command
Initialize a complete pyrig project
mkroot Command
Generate configuration files
build Command
Build distributable artifacts
mktests Command
Generate test skeletons