vidpipe 1.3.9 → 1.3.11

package/README.md

@@ -152,6 +152,7 @@ vidpipe doctor            # Check all prerequisites
 | `--no-git` | Skip git commit/push |
 | `--late-api-key <key>` | Override Late API key |
 | `-v, --verbose` | Debug-level logging |
+| `--progress` | Emit structured JSON progress events to stderr |
 | `--doctor` | Check that all prerequisites are installed |
 
 ### Ideate Options
@@ -357,6 +358,28 @@ graph LR
 
 Each stage can be independently skipped with `--no-*` flags. A stage failure does not abort the pipeline — subsequent stages proceed with whatever data is available.
 
+### Progress Events
+
+Pass `--progress` to emit structured JSONL progress events to stderr while normal logs continue on stdout:
+
+```bash
+vidpipe process video.mp4 --progress 2>progress.jsonl
+```
+
+Each line is a self-contained JSON object:
+
+```jsonl
+{"event":"pipeline:start","videoPath":"video.mp4","totalStages":16,"timestamp":"..."}
+{"event":"stage:start","stage":"ingestion","stageNumber":1,"totalStages":16,"name":"Ingestion","timestamp":"..."}
+{"event":"stage:complete","stage":"ingestion","stageNumber":1,"totalStages":16,"name":"Ingestion","duration":423,"success":true,"timestamp":"..."}
+{"event":"stage:skip","stage":"shorts","stageNumber":7,"totalStages":16,"name":"Shorts","reason":"SKIP_SHORTS","timestamp":"..."}
+{"event":"pipeline:complete","totalDuration":45000,"stagesCompleted":14,"stagesFailed":0,"stagesSkipped":2,"timestamp":"..."}
+```
+
+Event types: `pipeline:start`, `stage:start`, `stage:complete`, `stage:error`, `stage:skip`, `pipeline:complete`.
+
+Integrating tools can read stderr line-by-line to display a live progress UI (e.g., "Stage 3/16: Silence Removal").
+
 ---
 
 ## 🤖 LLM Providers
@@ -512,3 +535,36 @@ Run `vidpipe doctor` to verify your setup.
 
 ISC © [htekdev](https://github.com/htekdev)
 
+---
+
+## 🧩 SDK Usage
+
+VidPipe also ships as a Node.js ESM SDK for programmatic use:
+
+```ts
+import { createVidPipe } from 'vidpipe'
+
+const vidpipe = createVidPipe({
+  openaiApiKey: process.env.OPENAI_API_KEY,
+  outputDir: './recordings',
+})
+
+const result = await vidpipe.processVideo('./videos/demo.mp4', {
+  skipGit: true,
+})
+
+console.log(result.video.videoDir)
+console.log(result.shorts.length)
+```
+
+SDK features include:
+
+- `processVideo()` for the full pipeline
+- `ideate()` plus `ideas.*` CRUD helpers
+- `schedule.*` helpers for slots, calendar, and realignment
+- `video.*` helpers for clips, captions, silence detection, variants, and frames
+- `social.generatePosts()` for quick platform-specific drafts
+- `doctor()` and `config.*` for diagnostics and configuration access
+
+See [docs/sdk.md](./docs/sdk.md) for the full SDK guide.
+