Docs · Updated
Beamline documentation
The documentation that comes with the complete system, readable here before you buy. Your coding agent reads the same rules through Beamline's MCP server.
- Start hereWhat comes with Beamline (package, editable source, reference app, catalog, agent instructions) and the two ways to use it in a React app.
- InstallInstall Beamline into a React 19 app as compiled packages or editable source: the commands, the one stylesheet, UIRoot and Tailwind v4 setup.
- CustomiseChange how Beamline looks: one brand colour, light or dark, nine looks, custom styles by hand or by agent, tokens, fonts, motion, right-to-left.
- Connect your dataHow Beamline components take data and report actions: market data for trading, tables, streaming AI text and whole screens, your backend in charge.
- UpgradeMoving between Beamline releases: migration notes per version, managed source upgrades that keep your edits, recovery and compiled packages.
- Known limitationsWhat Beamline does not do or has not been checked to do: backends and services, environments, layouts and themes, particular parts, licences.
- ConventionsThe one API every Beamline component follows: files and imports, one props vocabulary (variant, size, tone, value), the rendering contract, styling.
- Design languageThe visual and motion rules behind every Beamline component: colour, type, density, radii, elevation, looks, focus, data states and motion.
- ChangelogWhat changed in each release, newest first.
- Connect your agentClaude Code, Codex, Cursor and any MCP client: one message or one click.