Skip to content

docs: copy-paste setup block for AI coding agents #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Co-Messi merged 1 commit into from
Jun 14, 2026
Merged

docs: copy-paste setup block for AI coding agents #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,36 @@ node dist/cli/index.js doctor # check Chromium + ffmpeg are installed

> Browser + video need Chromium and ffmpeg: `npx playwright install chromium` and an `ffmpeg` on your PATH.

### 🤖 Or: let your coding agent set it up

Already living in **Claude Code, Codex, opencode, Cursor, or Cline**? Don't run the
steps by hand — paste the block below in as your task, fill in the two `<...>`
placeholders, and let the agent clone, build, install Chromium/ffmpeg, and film your app:

```text
Set up and run supercut (https://github.com/Co-Messi/supercut) to make a launch
video of my app. Steps:

1. git clone https://github.com/Co-Messi/supercut && cd supercut
2. npm install && npm run build
3. npx playwright install chromium
4. Ensure ffmpeg is on PATH (install it if missing), then run:
node dist/cli/index.js doctor
5. Ask me which LLM provider to use, then create a .env:
- DeepSeek: SUPERCUT_PROVIDER=deepseek + DEEPSEEK_API_KEY=...
- OpenRouter: SUPERCUT_PROVIDER=openrouter + OPENROUTER_API_KEY=...
6. Film it (my app is running locally — fill these in):
node dist/cli/index.js generate --url <MY_APP_URL> --repo <MY_APP_SOURCE_DIR> --yes
7. When it finishes, open out/final.mp4 and show me the result.

@chatgpt-codex-connector chatgpt-codex-connector Bot Jun 14, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Open generate's actual output path

In the agent workflow, the preceding generate command does not pass --out, and the CLI defaults generate to out/generate (src/cli/index.ts:170) before writing final.mp4 inside that directory (src/director/generate.ts:238). Following this instruction after a successful generate run will therefore try to open a missing out/final.mp4 (or a stale file from another render); use out/generate/final.mp4 here or pass --out out in the generate command.

Useful? React with 👍 / 👎.


No API key handy? Skip the .env and use the no-LLM path instead:
node dist/cli/index.js record --recipe examples/demo.recipe.json --out out/take

@chatgpt-codex-connector chatgpt-codex-connector Bot Jun 14, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Don’t send no-key agents to the demo recipe

In this pasted-agent workflow for filming “my app”, the no-LLM fallback stops using <MY_APP_URL> and records examples/demo.recipe.json, which hardcodes http://127.0.0.1:4173 (examples/demo.recipe.json:3). For users whose app is running on any other URL, the agent will either fail during recording or film the demo target instead of their app, so this should be labeled demo-only/start-the-demo first or ask for a user-provided recipe.

Useful? React with 👍 / 👎.

node dist/cli/index.js render --take out/take --out out/final.mp4
```

Same block works in any agent — they all take a pasted task. `--repo` is optional but
makes the director read your routes so it films real panels, not just the landing page.

Help the director understand a deeper, multi-page app by pointing it at the source:

```bash
Expand Down
Loading