docs: copy-paste setup block for AI coding agents#6
Conversation
Add a Quick start subsection with a paste-in task block for Claude Code, Codex, opencode, Cursor, and Cline — clone, build, install Chromium/ffmpeg, and run generate, with the no-LLM record/render path as a fallback.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 465eba6a52
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| - 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. |
There was a problem hiding this comment.
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 👍 / 👎.
| 7. When it finishes, open out/final.mp4 and show me the result. | ||
|
|
||
| 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 |
There was a problem hiding this comment.
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 👍 / 👎.
Adds a Quick start subsection with a paste-in task block so users in Claude Code / Codex / opencode / Cursor / Cline can have their agent clone, build, install Chromium+ffmpeg, and run
generatefor them. Fill in two placeholders (<MY_APP_URL>,<MY_APP_SOURCE_DIR>) and go. Includes the no-LLMrecord/renderfallback.README-only change.