@raintree-technology/docpull-sdk

Active TypeScript SDK for Node and Bun developers consuming DocPull packs.

TypeScript SDK for DocPull. It reads local context packs (the v3 pack contract) and runs the docpull CLI from Node or Bun. Reading a pack never touches the network; fetching requires the docpull CLI on PATH.

Install

bun add @raintree-technology/docpull-sdk   # or: npm install @raintree-technology/docpull-sdk

Read a pack

import { readCorpusManifest, readDocuments, readPack } from "@raintree-technology/docpull-sdk";

const manifest = await readCorpusManifest("./packs/example");
console.log(manifest.record_count, manifest.records[0]?.url);

// Stream records one line at a time.
for await (const record of readDocuments("./packs/example")) {
  console.log(record.document_id, record.token_count);
}

// Or load everything at once.
const pack = await readPack("./packs/example");
console.log(pack.documents.length);

Expected result: the SDK returns the manifest and document records from the local pack without making a network request.

readDocuments prefers documents.ndjson and falls back to documents.jsonl. Types (CorpusManifest, ManifestRecord, DocumentRecord) mirror the field names written by the Python side and keep unknown fields as forward-compatible metadata.

Run the CLI

import { fetchToPack, runDocpull } from "@raintree-technology/docpull-sdk";

// docpull https://example.com/docs -o ./packs/example --budget 0
await fetchToPack("https://example.com/docs", "./packs/example", { budget: 0 });

// Any other subcommand.
const result = await runDocpull(["pack", "validate", "./packs/example"]);
console.log(result.stdout);

Commands are spawned with an argument array and shell: false. A non-zero exit rejects with a DocpullCliError that carries exitCode and stderr.

Compatibility and boundaries

• Runs on Node 20+ and Bun.
• Reads the v3 pack contract and preserves unknown fields as metadata.
• Pack reads are local. fetchToPack requires a compatible docpull CLI on PATH and can make the network requests requested by that command.
• The SDK does not validate the truth or completeness of source content.

See the DocPull README and security policy for the broader boundary.

Maintainer checks

bun install        # from the repo root
bun test           # from sdk/js
bun run typecheck  # tsc --noEmit

License

MIT