Skip to Content
Getting Started

Getting Started

ShipCut is currently a repo-first product. The web app is the public landing/docs surface, while the desktop app and CLI run from the monorepo.

Prerequisites

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

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

Install dependencies

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

Run the web app

bun run dev:web

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

Run the desktop app

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

# Process a YouTube source
bun run apps/cli/src/index.ts process --youtube-url "https://www.youtube.com/watch?v=..."
 
# Or process a local MP4
bun run apps/cli/src/index.ts process --file "/path/to/video.mp4"
 
# List known local jobs
bun run apps/cli/src/index.ts list

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
IntroductionArchitecture