Skip to Content
CLIOverview

CLI

shipcut exposes a small headless interface for running the local pipeline without opening the desktop app.

Commands

CommandDescription
shipcut processProcess a YouTube URL or local MP4 into long-form and shorts outputs
shipcut listList known local jobs from the local database

Process a YouTube source

bun run apps/cli/src/index.ts process \ --youtube-url "https://www.youtube.com/watch?v=..." \ --data-dir "$HOME/Library/Application Support/ShipCut/data"

Process a local file

bun run apps/cli/src/index.ts process \ --file "/absolute/path/to/video.mp4"

List jobs

bun run apps/cli/src/index.ts list

Output payload

process prints JSON describing the completed job, including:

  • jobId
  • stage
  • title
  • workspaceDir
  • renders
  • publishArtifacts
  • error

The CLI shares the same job store and pipeline engine as the desktop app, so both surfaces can inspect the same local history.

Last updated on