Work SDK documentation

Choose a path

Your first safe write

Provider adapters are separate subpath exports. Your application gets one normalized client without pulling unused provider code into the bundle.

npm install work-sdk

import { createWorkClient } from "work-sdk";
import { github } from "work-sdk/github";

const work = createWorkClient({
  adapter: github({
    owner: "acme",
    repo: "api",
    token: process.env.GITHUB_TOKEN!,
  }),
});

const change = await work.prepareUpdate("481", {
  state: "closed",
});

console.log(change.changes, change.warnings);

const result = await work.commit(change, {
  idempotencyKey: "merge:acme/api#481",
});

prepareUpdate reads the current item and creates an integrity-protected plan. No provider mutation occurs until commit.

The mental model

1. Prepare intent.Validate input, read current state, calculate an exact diff, and capture the expected revision.
2. Inspect consequences.Evaluate field changes and provider warnings in code, an approval UI, or an agent policy.
3. Commit once.Verify the plan fingerprint and revision, then write with a stable idempotency key.

Provider support