github nordstad/PinViz v0.3.0

one hour ago

๐Ÿš€ 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.svg

Why 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.md with new command syntax
  • Updated MCP server docstrings
  • All examples now use pinviz render format

๐Ÿงช 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.0

Full Changelog: v0.2.2...v0.3.0

Don't miss a new PinViz release

NewReleases is sending notifications on new releases.