gummyworm Documentation
Welcome to the gummyworm documentation! This index provides quick access to all guides and references.
Quick Links
| Document | Description |
|---|---|
| Installation | How to install gummyworm on any platform |
| CLI Reference | Complete command-line options reference |
| Palettes Guide | Built-in palettes and creating custom ones |
| Export Formats | HTML, SVG, PNG export documentation |
| Examples | Practical usage examples and recipes |
| Troubleshooting | Common issues and solutions |
| Architecture | Internal design and extending gummyworm |
| Testing | Test infrastructure, writing and running tests |
| Homebrew Distribution | Publishing via Homebrew tap |
Getting Started
New to gummyworm? Start here:
- Installation — Get gummyworm running on your system
- Examples — See common use cases and commands
- CLI Reference — Learn all available options
Guides by Topic
Converting Images
- Basic usage — Simple image conversion
- Color output — Enable 256-color mode
- Dimension control — Width, height, aspect ratio
Palettes & Appearance
- Built-in palettes — All 12 included palettes
- Custom palettes — Create your own
- Palette selection guide — Choosing the right palette
Exporting
- Format overview — Text, ANSI, HTML, SVG, PNG
- HTML export — Web-ready output
- PNG for social media — Shareable images
- Background colors — Customizing backgrounds
Batch Processing
- Multiple files — Process many images
- Recursive directories — Process folder trees
- Output directories — Auto-named outputs
Scripting & Integration
- URL input — Download and convert
- Stdin piping — Pipe image data
- Using as a library — Embed in scripts
Development
- Architecture overview — How gummyworm works
- Module reference — All library modules
- Testing guide — Writing and running tests
- Extending gummyworm — Add features
- Homebrew distribution — Publishing releases
Version
This documentation is for gummyworm v2.1.1.