Table of Contents

• Install
  • Homebrew
  • Cargo
  • Verify Installation
  • Post-Installation Setup
    • Marketplace Access
    • First Gpack Installation
    • Gpack Cache Location
    • Registry Configuration
    • Shell Completions (Optional)
  • Troubleshooting Installation
    • Command Not Found
    • Marketplace Access Issues
    • Permission Issues
  • Next Steps
  • Uninstallation
    • Homebrew
    • Cargo
    • Cleanup

Install

Homebrew

brew tap ggen-dev/tap
brew install ggen

Cargo

cargo install ggen

Verify Installation

ggen --version

Post-Installation Setup

Marketplace Access

The marketplace is available immediately after installation. No additional configuration is required.

First Gpack Installation

# Search for available gpacks
ggen search rust cli

# Install your first gpack
ggen add io.ggen.rust.cli-subcommand

# Verify installation
ggen packs

Gpack Cache Location

Gpacks are cached locally in your project directory:

# View cache location
ls -la .ggen/gpacks/

# Cache structure:
# .ggen/
# ├── gpacks/
# │   └── io.ggen.rust.cli-subcommand/
# │       └── 0.2.1/
# │           ├── templates/
# │           ├── macros/
# │           └── graphs/
# └── ggen.lock

Registry Configuration

By default, ggen uses the official registry. No configuration is needed for most users.

# Check registry status
ggen search --help

# Verify connectivity
ggen categories

Shell Completions (Optional)

# Generate completions for your shell
ggen completion bash > ~/.bash_completion.d/ggen
ggen completion zsh > ~/.zsh/completions/_ggen
ggen completion fish > ~/.config/fish/completions/ggen.fish

# Reload shell
source ~/.bashrc  # or ~/.zshrc

Troubleshooting Installation

Command Not Found

# Check if ggen is in PATH
which ggen

# If not found, add to PATH
export PATH="$HOME/.cargo/bin:$PATH"

# Or reinstall with explicit path
cargo install ggen --root ~/.local
export PATH="$HOME/.local/bin:$PATH"

Marketplace Access Issues

# Test marketplace connectivity
ggen search rust

# Check network connectivity
ping registry.ggen.io

# Verify DNS resolution
nslookup registry.ggen.io

Permission Issues

# Fix cache directory permissions
chmod -R 755 .ggen/

# Or use different cache location
export GGEN_CACHE_DIR="$HOME/.cache/ggen"

Next Steps

After installation:

1. Try the quickstart: Follow the quickstart guide
2. Explore gpacks: Browse the marketplace
3. Learn templates: Read the templates guide
4. Generate code: Use the CLI reference

Uninstallation

Homebrew

brew uninstall ggen
brew untap ggen-dev/tap

Cargo

cargo uninstall ggen

Cleanup

# Remove cache directories
rm -rf .ggen/
rm -rf ~/.cache/ggen/

# Remove completions
rm ~/.bash_completion.d/ggen
rm ~/.zsh/completions/_ggen
rm ~/.config/fish/completions/ggen.fish