About astryx
astryx is a design-system skill for agents building or changing application interfaces. It provides CLI access to component, template, theme, and documentation references, and requires pages to start from templates.
Key features
- 01Search design-system references
- 02Inspect components and props
- 03Scaffold pages from templates
- 04Use themes and documentation
- 05Build and review project output
Use cases
- 01Create a page in an existing project
- 02Choose components and styling for a UI
- 03Apply a template to a new page
Install
Copy the command and run it in a terminal.
npx skills add https:/ / github.com/ meta/ astryx --skill astryxAfter installing, type/astryxin Claude Code to confirm it loaded.
Details
From the project READMEAstryx, a design system and UI library, is available on this computer.
Use it when you build or change UI, pick components, or style or theme an app.
Its docs, components, templates, and themes are all reachable through astryx. Start with astryx search '<what you need>'.
Then read astryx component <Name> or astryx docs <topic>, not the package's files.
In a project, the project's version of Astryx answers automatically.
To build UI, work in a project folder (create one if there is none). Add @astryxdesign/core and @astryxdesign/cli to a new project or one without @astryxdesign/core; to a project that already has @astryxdesign/core, add @astryxdesign/cli at the same version. Run astryx init there and follow the agent docs it writes.
WORKFLOW — start every page from a template, never from scratch:
astryx build "<idea>"— names the template to scaffold from and the parts it lacks.astryx template <name> <path>— scaffold it; keep its frame, gap and padding; replace the content.astryx template <Block>for parts it lacks;astryx component <Name>to read props before using one. Before you deliver, re-read each file; replace any raw/, imported .css/@apply, or hardcoded #hex/px with the component or a token. Then build the project and deliver that build, not a description of it. Ifastryxis not found, runnpm i -g @astryxdesign/clifirst.