๐ PinViz v0.3.0
โ ๏ธ Breaking Changes
CLI Command Structure Updated
The CLI now requires an explicit render command for diagram generation:
# โ Old (no longer works)
pinviz diagram.yaml -o output.svg
# โ
New
pinviz render diagram.yaml -o output.svgWhy this change?
- Improved clarity and consistency with modern CLI tools (AWS CLI, kubectl, docker, etc.)
- Better command structure for future extensibility
- Clearer help output and user experience
Migration Guide:
Simply add render before your config file path in any scripts or commands.
โจ Improvements
Professional CLI Help Output
The help system has been completely redesigned for better readability:
Before:
Usage: pinviz [-h] [-v] {render,example,list} ...
Examples: # Generate diagram from YAML config pinviz diagram.yaml # Specify
output path pinviz diagram.yaml -o output/wiring.svg ...
After:
Usage: pinviz [-h] [-v] COMMAND ...
Commands:
COMMAND
render Render a diagram from a configuration file
example Generate a built-in example diagram
list List available board and device templates
Examples:
pinviz render diagram.yaml # Generate diagram
pinviz render diagram.yaml -o out/wiring.svg # Specify output path
pinviz example bh1750 # Use built-in example
pinviz list # List templates
Enhanced CLI Features
- โ
Removed confusing
{render,example,list}syntax from help - โ Examples section now displays properly with line breaks
- โ
Default values shown for all options (
--gpio/--no-gpio) - โ Mutually exclusive option groups
- โ
Better parameter naming (
CONFIG_FILE,PATH,NAME) - โ Custom help formatter preserves formatting
- โ Improved command descriptions
๐ Fixes
- Fixed CLI help examples wrapping into single line
- Updated MCP server documentation with correct commands
- Synchronized all documentation with new CLI format
๐ Documentation Updates
- Updated
docs/guide/cli.mdwith new command syntax - Updated MCP server docstrings
- All examples now use
pinviz renderformat
๐งช Testing
- โ 23/23 CLI tests passing
- โ 5/5 MCP tests passing
- โ All code validated with ruff
- โ No functionality changes beyond command structure
๐ฆ Installation
# CLI tool (recommended)
uv tool install pinviz
# Or with pip
pip install pinviz==0.3.0Full Changelog: v0.2.2...v0.3.0