Skip to content

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

Merged
Co-Messi merged 1 commit into
mainfrom
docs/agent-setup
Jun 14, 2026
Merged

docs: copy-paste setup block for AI coding agents#6
Co-Messi merged 1 commit into
mainfrom
docs/agent-setup

Conversation

@Co-Messi

Copy link
Copy Markdown
Owner

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 generate for them. Fill in two placeholders (<MY_APP_URL>, <MY_APP_SOURCE_DIR>) and go. Includes the no-LLM record/render fallback.

README-only change.

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.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 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".

Comment thread README.md
- 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.

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 👍 / 👎.

Comment thread README.md
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

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 👍 / 👎.

@Co-Messi Co-Messi merged commit 5be578f into main Jun 14, 2026
2 checks passed
@Co-Messi Co-Messi deleted the docs/agent-setup branch June 14, 2026 07:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant