Native Pipeline CLI Skill

Run QCut's built-in TypeScript pipeline CLI (qcut-pipeline / bun run pipeline).

Additional resources

• - For standalone CLI commands (generate, analyze, transcribe, models, help, output formats), see REFERENCE.md
• For YAML pipelines, API key management, project management, see reference-pipelines.md
• For ViMax commands (idea2video, script2video, novel2movie, portraits), see reference-vimax.md
• For editor core reference: connection, flags, batch limits, env vars, common workflows, see editor-core.md
• For editor media & project commands, project.json schema, see editor-media.md
• For editor timeline & editing commands, see editor-timeline.md
• For editor export, diagnostics, MCP, screen recording, UI, Moyin, screenshots, state control, see editor-output.md
• For editor AI commands: video analysis, transcription, AI generation, Remotion, navigator, see editor-ai.md
• For editor state automation: snapshots, event streams, correlation IDs, transactions, capabilities, and notification bridge endpoints, see editor-state-control.md

Step 1: Ensure QCut is Running

Before any editor:* command, check if QCut is running. If not, build and launch it.

CODEBLOCK0

If NOT_RUNNING:

CODEBLOCK1

Step 2: Find Project, Media & Timeline

Most editor commands need --project-id, --media-id, or --element-id. Run these to discover them.

CODEBLOCK2

Now you have the IDs needed for all other editor commands.

How to Run

CODEBLOCK3

Quick Commands

CODEBLOCK4

ViMax Quick Start

CODEBLOCK5

API Key Setup

Keys stored in ~/.qcut/.env (mode 0600).

CODEBLOCK6

Supported keys: FAL_KEY, GEMINI_API_KEY, GOOGLE_AI_API_KEY, OPENROUTER_API_KEY, ELEVENLABS_API_KEY, OPENAI_API_KEY, RUNWAY_API_KEY, HEYGEN_API_KEY, DID_API_KEY, INLINECODE17

Unified JSON Output

All commands support --json for machine-readable output using a consistent envelope:

CODEBLOCK7

Three possible envelope shapes:

Status	Shape	When
INLINECODE19	INLINECODE20	Command succeeded
INLINECODE21

{ "status": "error", "error": "msg", "code": "cmd:failed" } | Command failed |
| pending | { "status": "pending", "jobId": "abc-123" } | Async job started |

See REFERENCE.md for full envelope docs.

3-Level Progressive Help (JSON)

The CLI provides structured help at three levels when using --help --json:

CODEBLOCK8

Each level returns a JSON envelope ({ "status": "ok", "data": { ... } }).

project.json — Agent-Readable Project State

Two CLI commands export the full project state as structured JSON:

CODEBLOCK9

See editor-media.md for the full project.json schema.

Global Options

Flag	Short	Description
INLINECODE27	INLINECODE28	Output directory (default: ./output)
INLINECODE30

-m | Model key | | --json | | Output as JSON | | --quiet | -q | Suppress progress | | --verbose | -v | Debug logging | | --stream | | JSONL progress events on stderr | | --help | -h | Print help | | --session | | Session mode: read commands from stdin | | --skip-health | | Skip editor health check | | --no-capability-check | | Skip per-request capability warnings |

Key Source Files

Component	File
CLI entry point	INLINECODE43
Command router

electron/native-pipeline/cli/cli-runner/runner.ts | | Command registry (core) | electron/native-pipeline/cli/command-registry.ts | | Command registry (editor) | electron/native-pipeline/cli/command-registry-editor.ts | | Command registry types | electron/native-pipeline/cli/command-registry-types.ts | | JSON output helpers | electron/native-pipeline/cli/json-output.ts | | project.json types | electron/native-pipeline/cli/project-json-types.ts | | project.json builder | electron/native-pipeline/cli/project-json-builder.ts | | Editor dispatch | electron/native-pipeline/cli/cli-handlers-editor.ts | | Admin handlers | electron/native-pipeline/cli/cli-handlers-admin.ts | | Media handlers | electron/native-pipeline/cli/cli-handlers-media.ts | | ViMax handlers | electron/native-pipeline/cli/vimax-cli-handlers.ts | | Remotion handler | electron/native-pipeline/cli/cli-handlers-remotion.ts | | Moyin handler | electron/native-pipeline/cli/cli-handlers-moyin.ts | | Key manager | electron/native-pipeline/key-manager.ts |