@talocode/cliplane-sdk

@talocode/cliplane-sdk is the JavaScript and TypeScript interface for ClipLane’s local-first video workflow. It creates deterministic local scripts, storyboards, export copy, placeholder render jobs, and reviewable schedule plans without requiring credentials.

Why Use The SDK

Use the SDK when a product workflow needs ClipLane artifacts without shelling out to the CLI. Local methods keep their outputs inspectable and do not require a hosted account. The open workflow is the shipped product; a hosted worker is a separately planned architecture.

Install

Requires Node.js 18.18 or later.

npm install @talocode/cliplane-sdk

Local Quickstart

import { ClipLaneLocal } from "@talocode/cliplane-sdk";

const cliplane = new ClipLaneLocal();
const input = {
  update: "Shipped a faster export workflow",
  product: "My Product",
  audience: "builders",
  tone: "technical" as const,
};

const script = await cliplane.createScript(input);
const storyboard = await cliplane.createStoryboard(input);
const releaseCopy = await cliplane.exportForX(input);
const plan = await cliplane.createSchedule({
  runAt: "2027-01-01T12:00:00Z",
  title: "Review launch plan",
});

ClipLaneLocal writes schedules to .cliplane/schedules.json by default. Set scheduleStorePath to use a different local file.

const cliplane = new ClipLaneLocal({
  scheduleStorePath: ".cliplane/review-plans.json",
});

Local API Surface

| Method | Result | | --- | --- | | createScript(input) | A local ScriptResult with hook, problem, shipped change, rationale, CTA, and full script | | createStoryboard(input) | A local StoryboardResult with title, duration, and scenes | | exportForX(input) | Local release copy, hook, CTA, and tags | | createRenderJob(input) | A queued placeholder noting that local rendering requires an installed renderer | | getRenderJob(id) | A failed placeholder because local render jobs are not persisted by this SDK | | createSchedule({ runAt, contentId?, title? }) | Writes a future-dated local schedule plan | | listSchedules() | Returns local plans ordered by runAt | | cancelSchedule(id) | Marks a local plan cancelled |

createRenderJob is not a renderer and does not produce media. Use the ClipLane CLI for the shipped local FFmpeg render workflow, which writes the MP4 and a manifest under .cliplane/renders/.

Scheduling, Publishing, And Security

Local schedules are plans only. They do not start a background worker, execute at runAt, publish content, make network requests, or store secrets. The schedule file contains only job metadata such as IDs, optional titles and content IDs, status, and timestamps.

ClipLaneLocal has no API-key requirement. Keep any rendered media, scripts, and schedule data under the project access controls appropriate for your release material.

Hosted Target Architecture

The planned Talocode capability boundary is:

TALOCODE_BASE_URL=https://api.talocode.site
Authorization: Bearer $TALOCODE_API_KEY
/v1/cliplane/*

ClipLane uses TALOCODE_API_KEY (or its apiKey option) and calls the /v1/cliplane namespace. Hosted render, scheduling, and publishing availability depends on the Talocode API deployment.

Development And Testing

npm install
npm run build
npm run typecheck
npm test

Related Packages

| Package | Install | | --- | --- | | ClipLane CLI | npm i -g @talocode/cliplane-cli | | ClipLane SDK | npm i @talocode/cliplane-sdk (this package) | | ClipLane MCP | npm i -g @talocode/cliplane-mcp | | ClipLane Python | pip install talocode-cliplane |

Talocode Ecosystem

| Product | Package | | --- | --- | | ClipLane | npm i @talocode/cliplane-sdk (this package) | | Tera | pip install talocode-tera | | Codra | pip install talocode-codra | | SearchLane | pip install talocode-searchlane | | StackLane | pip install talocode | | GateLane | - | | ContextLane | pip install contextlane | | ScreenLane | pip install talocode-screenlane | | MemoryLane | - | | Tradia | pip install tradia | | DevTool | pip install talocode-devtool | | XProLane | pip install talocode-xprolane | | XSearchLane | npm i @talocode/xsearchlane | | Agent Browser | - | | InvoiceLane | - | | GeoLane | - |

More: github.com/talocode · talocode.site · docs.talocode.site

Links

Repository · Documentation · Talocode

License

MIT © Talocode.