Skip to content

PostGrip Agent — TypeScript SDK

Run shell commands, container workloads, and durable workflows on the PostGrip Agent runtime service from your TypeScript code.

Current release: 0.11.0

Quick start → GitHub npm

What this is

A TypeScript library that lets you talk to the PostGrip Agent runtime service. You enqueue tasks (shell commands, containers, workflows, schedules) from a Client, or you run an Agent that picks up tasks and dispatches them to your registered workflow functions and activities.

The shape mirrors the Temporal TypeScript SDK on purpose: workflows are plain async functions, activities are plain async functions accessed through a typed proxyActivities<typeof activities>(...) stub, and the agent registers both and runs the polling loop. If you've used Temporal in TypeScript, the surface should feel immediate.

import { proxyActivities } from '@postgrip/agent';

const activities = {
  async greet(name: string): Promise<string> {
    return `hello, ${name}`;
  },
};

const { greet } = proxyActivities<typeof activities>({
  startToCloseTimeoutMs: 10_000,
  retry: { maximumAttempts: 3 },
});

export async function greetingWorkflow(name: string): Promise<string> {
  return greet(name);
}

Polyglot

This SDK is one of three. The Go and Python siblings implement the same model against the same wire protocol, so a workflow started by a TypeScript client can be picked up by a Go agent and vice versa.

Where to next

  • Installation — npm install and Node version requirements.
  • Quick start — copy-paste examples for enqueueing tasks and running an agent.
  • Workflow runtime — the durable replay model in depth: history cursor, suspension, determinism rules, sandbox, ContinueAsNew.
  • API — the public surface re-exported from @postgrip/agent.