Installation

The SDK lives at go.postgrip.io/sdk. The repo is on GitHub at postgrip-io/agent-sdk-go; the vanity import path resolves to it.

go get go.postgrip.io/sdk@latest

To pin a specific version:

go get go.postgrip.io/sdk@v0.11.0

Requirements

Go 1.25 or newer (the module’s go.mod declares 1.25).
A reachable PostGrip Agent runtime service. The default address is https://agentorchestrator.postgrip.app.

What gets imported

The module declares one top-level Go package per sub-directory. You import only what you use:

import (
    "go.postgrip.io/sdk/client"   // Connection + Client + sub-clients
    "go.postgrip.io/sdk/worker"   // Worker (only if you run one)
    "go.postgrip.io/sdk/workflow" // workflow.Context (only if you write workflows)
    "go.postgrip.io/sdk/activity" // activity helpers (only if you write activities)
    "go.postgrip.io/sdk/failure"  // structured failure types
)

A program that submits a managed workflow.runtime task — no workflow code, no runtime worker — needs only client.

Fetching from the GitHub URL directly

If the vanity path isn’t yet routable from your environment for any reason, you can fetch via the GitHub URL:

go get github.com/postgrip-io/agent-sdk-go@v0.11.0

The package import paths in your code stay go.postgrip.io/sdk/... — Go resolves the vanity path through the repo’s go-import meta tag. Both URLs reach the same module.

Once a release tag is fetched once, it’s cached by Go’s module proxy (proxy.golang.org). Subsequent fetches across machines are fast.

Running against a local agent

For local development, point the SDK at a runtime service running on your machine:

conn, _ := client.NewConnection(client.ConnectionOptions{
    Address: "http://127.0.0.1:4100",
})

Address defaults to PostGrip Cloud if empty. For local or self-hosted development, pass Address explicitly or set POSTGRIP_AGENTORCHESTRATOR_URL.