Skip to Content
Getting Started

Getting Started

ShipCut ships in two local forms: a desktop app for the full GUI workflow, and a CLI for headless runs.

Prerequisites

  • Bun 
  • ffmpeg
  • ffprobe
  • yt-dlp
  • uv

The local transcription fallback installs faster-whisper on demand through uv.

Install the desktop app

brew tap shipshitdev/tap brew install --cask shipcut

Run the CLI

npx @shipshitdev/shipcut process --youtube-url "https://www.youtube.com/watch?v=..."

Install from source

git clone https://github.com/shipshitdev/shipcut.git cd shipcut bun install

Run the web app from source

bun run dev:web

The marketing/docs site runs on http://localhost:3001.

Run the desktop app from source

bun run dev:desktop

The desktop renderer is the main working surface for local jobs: overview, inbox, activity, costs, settings, skills, job details, and a terminal dock.

Run the CLI from source

bun run apps/cli/src/index.ts process --youtube-url "https://www.youtube.com/watch?v=..."

Output model

Each job gets a local workspace directory containing:

  • prepared source media
  • transcript artifacts
  • long-form edit plan
  • short-form edit plans
  • rendered outputs
  • publish metadata bundles

See Architecture for the package layout behind that flow.

Last updated on