Installation

Installation

Homebrew (macOS / Linux)

brew install octopyid/tap/rune

Go Install

go install github.com/octopyid/rune/cmd/rune@latest

Build from Source

Ensure Go 1.26+ is installed:

git clone https://github.com/octopyid/rune.git
cd rune
go build -o /usr/local/bin/rune ./cmd/rune

---

Quick Start

Create a file named Runefile in the root of your project:

#[Build the application binary]
build target="dev" --race?:
    go build {{race}} -o ./bin/app ./...

#[Run unit and integration tests]
test: build
    go test ./...

#[Reset the database schema]
#[confirm: This will permanently delete all database data.]
db:fresh:
    dropdb --if-exists app_dev && createdb app_dev

#[Forward arbitrary commands to Docker Compose]
compose *args:
    docker compose {{args}}

Now interact with it via CLI:

# View available tasks and namespaces
rune

# Run a task with default parameters
rune build

# Pass arguments and flags
rune build production --race

# View task documentation
rune build --help

# Test a command safely without executing
rune --dry-run db:fresh