> ## Documentation Index
> Fetch the complete documentation index at: https://gump.build/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> You should see something like `gump v0.1.0`.

# Installation

## Install Gump

### Homebrew (macOS, Linux)

```bash theme={null}
brew install isomorphx/tap/gump
```

### Shell script

```bash theme={null}
curl -fsSL https://get.gump.build | sh
```

## Verify the installation

```bash theme={null}
gump --version
```

You should see something like `gump v0.1.0`.

## Check your environment

Gump needs Git and at least one agent CLI installed. Run the doctor to check:

```bash theme={null}
gump doctor
```

```
Gump Doctor

  git          ✓  git version 2.43.0
  config       ✓  gump.toml found
  workflows    ✓  7 built-in workflows loaded

  Agents:
  claude       ✓  claude-code 1.0.12
  codex        ✓  codex 0.1.0
  gemini       ✓  gemini 2.5.0
  qwen         ✗  not found
  opencode     ✗  not found
  cursor       ✗  not found
```

You need at least one agent with a ✓ to run workflows. Install the agent CLIs you want to use — Gump works with whichever ones are available.

Gump is not responsible for installing or configuring agents. Make sure the CLIs are installed, authenticated, and in your PATH.

## Project configuration (optional)

Create a `gump.toml` at the root of your repo to customize validation commands:

```toml theme={null}
default_agent = "claude-sonnet"

[validation]
compile_cmd = "make build"
test_cmd = "make test-unit"
lint_cmd = "golangci-lint run"
```

Without a config file, Gump auto-detects your project type (Go, Node, Rust) and uses the standard commands. The config file overrides auto-detection.