Docs
1. Set up
Open your invite link and enter your email. The page shows your API key once, with this command filled in. It installs the tool, saves your key and installs the agent instructions for Claude Code:
uv tool install https://codeflix.run/dist/codeflix-0.1.0-py3-none-any.whl && codeflix login --key <your key> && codeflix install-skill
No uv? Use pipx install with the same link. For Codex, run
codeflix install-skill --codex in your project to add the instructions to AGENTS.md.
Any other agent can read the instructions or /llms.txt.
2. Ask your agent for a film
You talk to your agent as usual. With the instructions installed it knows how to build a project that renders correctly, how to preview and quote it, and to ask you before spending. A good first prompt:
Using the codeflix skill: build a 10-second Blender Cycles animation of a paper boat crossing a pond at sunset in ./my-film. Check it and preview it with Codeflix and show me the preview. Then quote the full render and wait for my go-ahead before rendering.
You need Blender 5.0 or 5.2 on your machine: your agent builds the scene there, and Codeflix renders it.
3. Commands
| Command | What it does |
|---|---|
codeflix check DIR | Uploads the project and reports problems. Free. |
codeflix preview DIR | One frame per shot at half size, as one image. Free. |
codeflix quote DIR | Renders 3 frames; prints price, time and a suggested cap. Free. |
codeflix render DIR --max-spend USD | Renders every frame and returns an MP4 link. |
codeflix wait JOB / status JOB | Wait for, or show, a job. |
codeflix pull JOB [--frames] | Download the MP4, and every frame with --frames. |
codeflix logs JOB --frame N | Blender's own log for a frame that failed. |
codeflix cancel JOB | Stop; finished frames are kept. |
codeflix balance | Credit left, and a link to add more. |
Options: --frames A-B, --scale PERCENT, --samples N,
--max-gpus N, --wait SECONDS, and --json on every command.
4. What a project needs
- A folder with one
.blendat the top, saved with Blender 5.0 or 5.2, using Cycles. - Every texture and cache inside the folder, by relative path (
bpy.ops.file.make_paths_relative()). - Simulations baked. Frames render out of order on different machines.
- No Python drivers or startup scripts; they do not run on render machines.
- Up to 4K, 20,000 frames and 5 GB.
5. Exit codes
0 done · 1 cancelled · 2 the project needs a fix · 3 spending cap or credit · 4 still running · 5 our fault, not charged.
6. Your files
Projects, frames and videos are deleted after 7 days. Video links work until then.