2.1 KiB
AGENTS.md
Project-specific guidance for AI coding agents.
Astryx v0.7.4 · 173 components
CLI: run every command as pnpm dlx @astryxdesign/cli@0.7.4 <cmd> (shown below as astryx ...).
SETUP (once, in app entry e.g. main.tsx) — without these, components render unstyled: import "@astryxdesign/core/reset.css"; import "@astryxdesign/core/astryx.css";
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. Changing an existing page? Keep it: skip step 2 and add blocks/components inside its sections.
RULES:
- No — components handle all layout and spacing.
- Read
astryx docs layoutbefore changing a template's frame. - Dense data = rows (Table, List/Item), not Card-wrapped lists. Badge = counts only.
- Style with component props first, then tokens (var(--color-|--spacing-|--radius-*)). No raw hex/px. No StyleX/Tailwind compiler here — don't use xstyle/utility classes directly. Some templates use StyleX and need a compiler plugin; see
astryx docs styling-overview. - Palettes and custom colors go through the theme, never :root overrides. Run
astryx theme add <slug>to import;theme eject <slug>only forks source. Seeastryx docs theme. - SELF-CHECK: re-read the file; replace any raw /, imported .css/@apply, or hardcoded #hex/px with the component or a token.
astryx help lists every command. Key ones beyond the workflow:
search "" find any component / hook / doc / template
discover integrations you could add
docs getting-started, principles, tokens, theme … (astryx docs lists all)
docs cli commands and API reference
docs authoring build an integration package, and every field it holds
upgrade --from --apply run after a dependency bump