@treeship/sdk

npm install @treeship/sdk

import { ship } from '@treeship/sdk';

const s = ship();

// Attest an action
const { artifactId } = await s.attest.action({
  actor: 'agent://my-agent',
  action: 'tool.call',
});

// Verify it
const result = await s.verify.verify(artifactId);
console.log(result.outcome); // "pass"

// Push to Hub
const { hubUrl } = await s.hub.push(artifactId);
console.log(hubUrl); // https://treeship.dev/verify/art_xxx

import { Ship } from '@treeship/sdk';

const version = await Ship.checkCli();
console.log(`Treeship CLI version: ${version}`);

const { artifactId } = await s.attest.action({
  actor: 'agent://my-agent',
  action: 'tool.call',
  meta: { model: 'gpt-4o', tokens: 1247 },
});

await s.attest.decision({
  actor: 'agent://analyst',
  model: 'claude-opus-4',
  tokensIn: 8432,
  tokensOut: 1247,
  summary: 'Contract looks standard.',
  confidence: 0.91,
});

const { artifactId, nonce } = await s.attest.approval({
  approver: 'human://alice',
  description: 'approve payment max $500',
});

await s.attest.handoff({
  from: 'agent://researcher',
  to: 'agent://executor',
  artifacts: ['art_abc123'],
});

const result = await s.verify.verify('art_abc123');
// { outcome: 'pass', chain: 3, target: 'art_abc123' }

const { hubUrl } = await s.hub.push('art_abc123');
// https://treeship.dev/verify/art_abc123

await s.hub.pull('art_abc123');

const status = await s.hub.status();
if (status.attached) {
  console.log(`Connected to ${status.endpoint}`);
}

interface ActionParams {
  actor: string;
  action: string;
  parentId?: string;
  approvalNonce?: string;
  meta?: Record<string, unknown>;
}

interface ApprovalParams {
  approver: string;
  description: string;
  expires?: string;   // ISO-8601 timestamp
  subject?: string;   // artifact ID being approved
}

interface HandoffParams {
  from: string;
  to: string;
  artifacts: string[];
  approvals?: string[];
  obligations?: string[];
}

interface DecisionParams {
  actor: string;
  model?: string;
  modelVersion?: string;
  tokensIn?: number;
  tokensOut?: number;
  promptDigest?: string;
  summary?: string;
  confidence?: number;
  parentId?: string;
}

interface ActionResult {
  artifactId: string;
}

interface ApprovalResult {
  artifactId: string;
  nonce: string;
}

interface VerifyResult {
  outcome: "pass" | "fail" | "error";
  chain: number;
  target: string;
}

interface PushResult {
  hubUrl: string;
  rekorIndex?: number;
}

class TreeshipError extends Error {
  readonly args: string[];  // the CLI arguments that were passed
  readonly name: "TreeshipError";
}

import { TreeshipError } from '@treeship/sdk';

try {
  await s.attest.action({ actor: 'agent://x', action: 'test' });
} catch (e) {
  if (e instanceof TreeshipError) {
    console.error('CLI failed:', e.message);
    console.error('Args:', e.args);
  }
}