pp-twelvelabs

What this skill does

<!-- GENERATED FILE — DO NOT EDIT.
     This file is a verbatim mirror of library/ai/twelvelabs/SKILL.md,
     regenerated post-merge by tools/generate-skills/. Hand-edits here are
     silently overwritten on the next regen. Edit the library/ source instead.
     See the repository agent guide, section "Generated artifacts: registry.json, cli-skills/". -->

# Twelvelabs — Printing Press CLI

## Prerequisites: Install the CLI

This skill drives the `twelvelabs-pp-cli` binary. **You must verify the CLI is installed before invoking any command from this skill.** If it is missing, install it first:

1. Install via the Printing Press installer. It defaults binaries to `$HOME/.local/bin` on macOS/Linux and `%LOCALAPPDATA%\Programs\PrintingPress\bin` on Windows:
   ```bash
   npx -y @mvanhorn/printing-press-library install twelvelabs --cli-only
   ```
2. Verify: `twelvelabs-pp-cli --version`
3. Ensure the reported install directory is on `$PATH` for the agent/runtime that will invoke this skill.

If the `npx` install fails (no Node, offline, etc.), fall back to a direct Go install (requires Go 1.26.4 or newer). This installs into `$GOPATH/bin` (default `$HOME/go/bin`), so add that directory to `$PATH` instead:

```bash
go install github.com/mvanhorn/printing-press-library/library/ai/twelvelabs/cmd/twelvelabs-pp-cli@latest
```

If `--version` reports "command not found" after install, the runtime cannot see the binary directory on `$PATH`. Do not proceed with skill commands until verification succeeds.

This CLI wraps the Twelve Labs API and adds workflow commands for video upload, indexing waits, structured briefs, embeddings, and local clip cutting. Agents can go from a long source video to JSON or Markdown editing guidance without manually watching the whole file.

## Editor Workflow

For long videos, prefer the workflow commands before falling back to raw endpoint mirrors:

```bash
twelvelabs-pp-cli upload-video --index-id IDX --file ./long-video.mp4 --wait --json
twelvelabs-pp-cli video-brief --video-id VIDEO_ID --format json --out edit-plan.json
twelvelabs-pp-cli video-brief --video-id VIDEO_ID --format markdown --out edit-plan.md
twelvelabs-pp-cli clips --input ./long-video.mp4 --plan edit-plan.json --out ./clips
```

Use `upload-video` for local files or public URLs, `video-brief` for editor-ready JSON/Markdown with chapters, highlights, and recommended cuts, `embed` for video embeddings with optional wait polling, and `clips` for local `ffmpeg` cuts from a generated plan.

## Unique Capabilities

These capabilities aren't available in any other tool for this API.

### Editor workflows
- **`upload-video`** — Upload a local video file or register a public URL, then poll Twelve Labs until indexing reaches a terminal status.

  _Use this before analysis when you need the CLI to wait until the video is usable._

  ```bash
  twelvelabs-pp-cli upload-video --index-id IDX --file ./long-video.mp4 --wait --json --dry-run
  ```
- **`video-brief`** — Generate a deterministic JSON or Markdown editing plan with title, topics, hashtags, chapters, highlights, and recommended cuts.

  _Use this when you want to avoid manually watching a long video just to find the strongest moments._

  ```bash
  twelvelabs-pp-cli video-brief --video-id VID --format json --json --dry-run
  ```
- **`embed`** — Create a video embedding task from a local file or public URL and optionally wait for ready results.

  _Use this when you need embeddings for deeper search, matching, or semantic workflows._

  ```bash
  twelvelabs-pp-cli embed --video-file ./long-video.mp4 --model marengo3.0 --wait --json --dry-run
  ```
- **`clips`** — Cut local clip files with ffmpeg from a video-brief JSON plan without inventing timestamps.

  _Use this after video-brief when you have the source video locally and want clip files immediately._

  ```bash
  twelvelabs-pp-cli clips --dry-run --json
  ```

## Command Reference

**analyze** — Manage analyze

- `twelvelabs-pp-cli analyze` — This endpoint analyzes your videos and creates fully customizable text based on your prompts

**editor workflows** — High-level video editing helpers

- `twelvelabs-pp-cli upload-video` — Upload or register a video and optionally wait for indexing.
- `twelvelabs-pp-cli video-brief` — Create a deterministic editor-ready JSON or Markdown plan.
- `twelvelabs-pp-cli embed` — Create video embeddings from a local file or URL and optionally wait for readiness.
- `twelvelabs-pp-cli clips` — Cut local clips from a `video-brief` JSON plan using `ffmpeg`.

**assets** — Manage assets

- `twelvelabs-pp-cli assets create` — This method creates an asset by uploading a file to the platform.
- `twelvelabs-pp-cli assets create-multipart-upload` — This method creates a multipart upload session. **Supported content**: Video and audio **File size**: 4GB maximum.
- `twelvelabs-pp-cli assets delete` — This method deletes the specified asset. This action cannot be undone.
- `twelvelabs-pp-cli assets get-upload-status` — This method provides information about an upload session, including its current status, chunk-level progress
- `twelvelabs-pp-cli assets list` — This method returns a list of assets in your account.
- `twelvelabs-pp-cli assets list-incomplete-uploads` — This method returns a list of all incomplete multipart upload sessions in your account.
- `twelvelabs-pp-cli assets report-chunk-batch` — This method reports successfully uploaded chunks to the platform.
- `twelvelabs-pp-cli assets request-additional-presigned-urls` — This method generates new presigned URLs for specific chunks that require uploading.
- `twelvelabs-pp-cli assets retrieve` — This method retrieves details about the specified asset.

**embed** — Manage embed

- `twelvelabs-pp-cli embed create-text-image-audio-embedding` — <Note title='Note'> This endpoint will be deprecated in a future version. Migrate to the [Embed API v2](/v1.
- `twelvelabs-pp-cli embed create-video-embedding-task` — <Note title='Note'> This endpoint will be deprecated in a future version. Migrate to the [Embed API v2](/v1.
- `twelvelabs-pp-cli embed list-video-embedding-tasks` — <Note title='Note'> This method will be deprecated in a future version. Migrate to the [Embed API v2](/v1.
- `twelvelabs-pp-cli embed retrieve-video-embedding` — This method retrieves embeddings for a specific video embedding task.
- `twelvelabs-pp-cli embed retrieve-video-embedding-task` — <Note title='Note'> This endpoint will be deprecated in a future version. Migrate to the [Embed API v2](/v1.

**embed-v2** — Manage embed v2

- `twelvelabs-pp-cli embed-v2 create-async-embedding-task` — This endpoint creates embeddings for audio and video content asynchronously.
- `twelvelabs-pp-cli embed-v2 create-embeddings` — This endpoint synchronously creates embeddings for multimodal content and returns the results immediately in the
- `twelvelabs-pp-cli embed-v2 list-async-embedding-tasks` — This method returns a list of the async embedding tasks in your account.
- `twelvelabs-pp-cli embed-v2 retrieve-embeddings` — This method retrieves the status and the results of an async embedding task.

**entity-collections** — Manage entity collections

- `twelvelabs-pp-cli entity-collections create` — This method creates an entity collection.
- `twelvelabs-pp-cli entity-collections delete` — This method deletes the specified entity collection. This action cannot be undone.
- `twelvelabs-pp-cli entity-collections list` — This method returns a list of the entity collections in your account.
- `twelvelabs-pp-cli entity-collections retrieve` — This method retrieves details about the specified entity collection.
- `twelvelabs-pp-cli entity-collections update` — This method updates the specified entity collection.

**gist** — Manage gist

- `twelvelabs-pp-cli gist` — <Note title='Deprecation notice'> This endpoint will be sunset and removed on February 15, 2026.

**indexes** — Manage indexes

- `twelvelabs-pp-cli indexes create-index` — This meth