Skip to main content

System requirements

Before installing Pumu, make sure you have:
  • Operating system: macOS, Linux, or Windows (WSL)
  • Go 1.24.0+ (only required if building from source)
  • Package managers: Installed and available in your PATH if you plan to use --reinstall or repair commands
    • Node.js: npm, yarn, pnpm, or bun
    • Rust: cargo
    • Python: pip
    • Go: go
    • Deno: deno
You don’t need all package managers installed. Pumu only uses the ones relevant to your projects.

Choose your installation method

1

Install Pumu

Choose the installation method that works best for you:
brew install carlosedujs/pumu/pumu
Homebrew is the recommended method for macOS users. It handles PATH configuration automatically.
When using Go install, ensure your $GOPATH/bin or $HOME/go/bin is in your PATH:
export PATH="$HOME/go/bin:$PATH"
2

Verify installation

Confirm Pumu is installed correctly by checking the version:
pumu --version
You should see output like:
pumu version v1.2.1-rc.1
If you get a “command not found” error, check that Pumu is in your PATH.
3

Test basic functionality

Run a quick test to ensure Pumu is working:
pumu list --path ~
This will scan your home directory for heavy dependency folders. You should see output showing any found folders with their sizes.
Don’t worry, list command is a dry-run and won’t delete anything.

Installation methods explained

Homebrew (macOS/Linux)

Homebrew is the easiest method for macOS and Linux users. It:
  • Automatically adds Pumu to your PATH
  • Handles updates via brew upgrade
  • Manages dependencies
brew install carlosedujs/pumu/pumu

Go install

Ideal for Go developers who already have Go installed:
  • Builds from source automatically
  • Always gets the latest version
  • Requires Go 1.24.0 or later
go install github.com/carlosedujs/pumu@latest
Make sure $GOPATH/bin (or $HOME/go/bin) is in your PATH. Add this to your .bashrc, .zshrc, or equivalent:
export PATH="$HOME/go/bin:$PATH"

From source

Best for contributors or users who want full control:
  • Clone the repository
  • Build with custom flags if needed
  • Useful for development
git clone https://github.com/carlosedujs/pumu.git
cd pumu
go build -o pumu
sudo mv pumu /usr/local/bin/
The sudo mv command places Pumu in a system directory. You can skip sudo and place it in ~/bin or another directory in your PATH if you prefer.

Shell completion (optional)

Pumu supports shell completion for bash, zsh, fish, and PowerShell.
pumu completion bash > /usr/local/etc/bash_completion.d/pumu
Restart your shell or source your config file to enable completions.

Troubleshooting

Command not found

If you see pumu: command not found after installation:
  1. Check PATH: Ensure the installation directory is in your PATH
    echo $PATH
    
  2. For Go install: Verify $GOPATH/bin or $HOME/go/bin is in PATH
    export PATH="$HOME/go/bin:$PATH"
    
  3. For manual install: Verify Pumu is in /usr/local/bin or another PATH directory
    which pumu
    

Permission denied

If you get permission errors:
  • On Linux/macOS: Ensure the binary is executable
    chmod +x /usr/local/bin/pumu
    
  • For system directories: Use sudo when moving to /usr/local/bin
    sudo mv pumu /usr/local/bin/
    

Go version mismatch

Pumu requires Go 1.24.0 or later. Check your Go version:
go version
If you need to upgrade, visit go.dev/dl.

Updating Pumu

brew upgrade pumu

Next steps

Now that Pumu is installed, let’s put it to work:

Quickstart Guide

Learn how to use Pumu with real-world examples and go from installation to your first cleanup in 5 minutes

Build docs developers (and LLMs) love