Skip to main content

Homebrew Distribution

gummyworm is distributed via a Homebrew tap at oddurs/homebrew-gummyworm.

For Users​

Install​

brew install oddurs/gummyworm/gummyworm

This installs:

  • The gummyworm executable
  • ImageMagick dependency
  • Shell completions for bash and zsh

Upgrade​

brew update && brew upgrade gummyworm

Uninstall​

brew uninstall gummyworm
brew untap oddurs/gummyworm  # optional

For Maintainers​

Release Workflow​

When releasing a new version:

  1. Tag the release in the main repo:

    git tag -a v2.1.1 -m "Release v2.1.1"
    git push origin v2.1.1

  2. Get the SHA256 of the tarball:

    curl -sL https://github.com/oddurs/gummyworm/archive/refs/tags/v2.1.1.tar.gz | shasum -a 256

  3. Update the formula:

    Edit Formula/gummyworm.rb:

    url "https://github.com/oddurs/gummyworm/archive/refs/tags/v2.1.1.tar.gz"
    sha256 "<new-sha256>"
    version "2.1.1"

  4. Update the tap repository:

    # Copy formula to tap (uses brew to find correct path)
    TAP_DIR=$(brew --repository oddurs/homebrew-gummyworm)
    cp Formula/gummyworm.rb "$TAP_DIR/Formula/"

    # Commit and push
    cd "$TAP_DIR"
    git add Formula/gummyworm.rb
    git commit -m "Update gummyworm to v2.1.1"
    git push

    Note: Homebrew paths differ by architecture:

    • Apple Silicon (M1/M2/M3): /opt/homebrew/...
    • Intel Macs: /usr/local/...

    Using $(brew --repository) ensures the correct path on any system.

  5. Don't forget to update version in lib/config.sh

Testing​

# Test from HEAD (latest git)
brew install oddurs/gummyworm/gummyworm --HEAD

# Run formula tests
brew test gummyworm

# Reinstall from release tarball
brew uninstall gummyworm
brew install oddurs/gummyworm/gummyworm

Formula Details​

The formula (Formula/gummyworm.rb):

  • Downloads the release tarball from GitHub
  • Installs bin/gummyworm to Homebrew's bin directory
  • Installs library files to libexec/lib/
  • Installs palette files to libexec/palettes/
  • Installs shell completions for bash and zsh
  • Injects GUMMYWORM_ROOT path for Homebrew's directory structure
  • Declares ImageMagick as a dependency

Tap Repository​

The tap lives at: https://github.com/oddurs/homebrew-gummyworm

Structure:

homebrew-gummyworm/
├── Formula/
│   └── gummyworm.rb
└── README.md