Installation¶

Requirements¶

• Go 1.24 or later
• Module-aware project (go mod init)

traverse uses generics (Go 1.18+) and other features that require Go 1.24.

Core Module¶

go get github.com/jhonsferg/traverse

This installs the core traverse module and its only external dependency, relay, which is resolved automatically.

Verify Installation¶

package main

import (
    "fmt"
    "github.com/jhonsferg/traverse"
)

func main() {
    c, _ := traverse.New(traverse.WithBaseURL("https://example.com/odata"))
    defer c.Close()
    fmt.Println("traverse ready")
}

go run .
# traverse ready

Extension Modules¶

Each extension is a separate Go module with its own go get:

Extensions are optional - only add what you need.

Code Generator¶

Install traverse-gen to generate typed Go structs and query builders from OData $metadata:

go install github.com/jhonsferg/traverse/cmd/traverse-gen@latest

Verify:

traverse-gen --version

See Code Generation for usage details.

Using traverse in a Monorepo (go.work)¶

If your project uses a Go workspace (go.work), add traverse alongside your own modules:

go 1.24

use (
    .
    ./services/api
    ./services/worker
)

go work download github.com/jhonsferg/traverse

Or pin a specific version in your workspace:

go work edit -replace github.com/jhonsferg/traverse=../local-traverse