Docs

/

Reference

CLI

layr ships in @dynshift/layr. Run it with npx layr, or through your package manager's scripts.

CommandWhat it does
layr createCreate a project or an addon
layr devStart the dev server
layr buildBuild and prerender a static site into dist/
layr previewServe the built site
layr formatRewrite .layr files in canonical form
layr analyzeCheck the project; explain a feature's cascade
layr explainExplain a diagnostic code
layr testScreenshot every page at every design frame
layr addInstall addons
layr removeUninstall addons
layr updateUpdate addons
layr outdatedList addons with newer versions
layr searchSearch addons
layr infoShow an addon's details
layr packValidate and pack an addon
layr publishValidate and publish an addon to npm
layr ejectCopy an addon's source into your project
layr docsGenerate API docs for an addon's widgets
layr skillsInstall the LAYR Skill for AI agents
layr doctorCheck the environment and project
layr lspStart the language server (stdio)
layr mcpStart the MCP server for AI agents (stdio)

layr create

Create a project or an addon.

Terminal
layr create <name> [--template app|blank]
layr create addon <name>

layr dev

Start the dev server.

Terminal
layr dev [--port 5173] [--host]

layr build

Build and prerender a static site into dist/.

Terminal
layr build [--base /] [--out dist] [--no-prerender]

layr preview

Serve the built site.

Terminal
layr preview [--port 4173]

layr format

Rewrite .layr files in canonical form.

Terminal
layr format [--check] [paths...]

layr analyze

Check the project; explain a feature's cascade.

Terminal
layr analyze [--json] [--info] [--explain Page.id.feature]

layr explain

Explain a diagnostic code.

Terminal
layr explain [L3102]

layr test

Screenshot every page at every design frame.

Terminal
layr test [--frames m,t,w,uw] [--update]

layr add

Install addons.

Terminal
layr add <addon>[@range] ...

layr remove

Uninstall addons.

Terminal
layr remove <addon> ...

layr update

Update addons.

Terminal
layr update [addon ...]

layr outdated

List addons with newer versions.

Terminal
layr outdated

Search addons.

Terminal
layr search <query>

layr info

Show an addon's details.

Terminal
layr info <addon>

layr pack

Validate and pack an addon.

Terminal
layr pack [--dry-run]

layr publish

Validate and publish an addon to npm.

Terminal
layr publish [--dry-run] [--tag next]

layr eject

Copy an addon's source into your project.

Terminal
layr eject <addon>

layr docs

Generate API docs for an addon's widgets.

Terminal
layr docs

layr skills

Install the LAYR Skill for AI agents.

Terminal
layr skills [install|update|path]

layr doctor

Check the environment and project.

Terminal
layr doctor

layr lsp

Start the language server (stdio).

Terminal
layr lsp

layr mcp

Start the MCP server for AI agents (stdio).

Terminal
layr mcp