Start with raea and your agent
Get the raea app, then give your coding agent the prompt below. It installs raea, learns how raea works and asks you what to make. Everything runs on your own computer.
- 1
Download the app
The raea app is where your projects, your feed and your agent live. The first time it opens, it links to your raea account.
- 2
Give your agent this prompt
Paste it into Claude Code, Codex, Kimi, Gemini or any coding agent, in the folder you want to work in.
Set up raea on this computer, then make something with me. 1. Check whether raea is installed with `raea --version`. If it isn't, install it: `curl -fsSL https://raea.io/install | sh` on macOS or Linux, or `irm https://raea.io/install.ps1 | iex` in PowerShell on Windows. 2. If you aren't Claude Code, install raea's skill where you read skills: `raea skills install --agent codex` (or kimi, or gemini). 3. Read the skill with `raea skill`, then https://raea.io/docs/start/agents.md for the order of work. https://raea.io/llms.txt lists every docs page. 4. Ask me what I want to make: a video, a motion graphic, a 3D scene, a game or an app. Then follow raea's loop: write it, check it, render stills and look at them before you show me.
Rather use the terminal alone? Install the raea command. Or read on: the rest of this page is the map of the docs.
raea is the Render Anything Engine. You describe a video, a motion graphic, a 3D scene, a game or an app in TypeScript and React, and raea draws it on the GPU with its own engine, built on the Bevy game engine. The same file renders to an MP4, plays live as a game, or renders single frames for you to look at. It runs on your own computer and needs no account.
These docs are written for coding agents first and for developers second. Every page is plain Markdown: add .md to
any page's address to get its source, or read llms.txt for the list of pages. Offline,
raea skill and raea guide print the skill and the craft guides that match the raea you have installed.
curl -fsSL https://raea.io/install | sh # macOS (Apple Silicon) or Linux (x86_64)
raea --version # the version these docs should matchIf you are an agent
Read How an agent should use raea first. It gives the order of work: read the project, write the
composition, check it in a second, render stills and look at them, render the export and check it, then hand it over.
The raea skill (raea skill prints it) is the short version of the same loop; these docs are the long version.
Start
- Install raea: install, update, pick a version, and what goes where.
- Your first video: a composition from an empty folder to an MP4, in five minutes.
- Your first game: a game that plays live and renders the same every time.
- How an agent should use raea: the loop, what runs headless, and what waits on a person.
Concepts
- Compositions and frames: a composition is a function of the frame, and why that matters.
- Rendering and checking: stills, exports, quality, and the checks that catch defects.
- Workspaces and projects: where work lives, and the spec files an agent reads first.
Guides
- Captions and cues on words: cue anything on the moment a phrase is said, and build captions.
- 3D scenes: cameras, lights, meshes and materials in TSX, drawn by Bevy.
- Apps on the web target or native: a React file that runs as a desktop app.
Reference
- The CLI: a page for each of the 43
raeaverbs, with its forms, where it runs and what each flag does. - The SDK: a page for each
raeaimport path, with every export's signature, props and examples. - Files and specs: a workspace's and a project's files, and each spec's fields.
- Settings: every setting raea reads from the environment or
~/.raea/env.
What's new
- What's new: every release, newest first, with what changed and what is still missing.