Skip to content

An open source design system that's fully customizable and agent ready

TypeScript

docs: make Astryx CLI bootstrap shell-portable (#6119)

Cindy Zhanga8b08f399c19
diff --git a/AGENTS.md b/AGENTS.md
index f0369eca50..b38389c495 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -181,24 +181,24 @@ Documentation lives in two places:
<!-- ASTRYX-CLI:START -->
Astryx CLI|Run from repo root. Load agent docs before any component work.
-ASTRYX="node packages/cli/clients/cli/bin/astryx.mjs"
+astryx() { node packages/cli/clients/cli/bin/astryx.mjs "$@"; }
BOOTSTRAP (run every branch, <500ms):
-$ASTRYX help # discover all commands and options
-$ASTRYX docs # list available doc topics
-$ASTRYX docs principles --dense # design rules, anti-patterns, xstyle, tokens
-$ASTRYX docs tokens --dense # spacing, color, radius, typography, shadow
-$ASTRYX docs theme --dense # theme provider, light/dark, overrides
-$ASTRYX component --list # all components grouped by category
-$ASTRYX template --list # available page templates
+astryx help # discover all commands and options
+astryx docs # list available doc topics
+astryx docs principles --dense # design rules, anti-patterns, xstyle, tokens
+astryx docs tokens --dense # spacing, color, radius, typography, shadow
+astryx docs theme --dense # theme provider, light/dark, overrides
+astryx component --list # all components grouped by category
+astryx template --list # available page templates
ON DEMAND:
-$ASTRYX component <Name> --dense # props, variants, usage, anatomy for one component
-$ASTRYX template <name> # emit full page source
-$ASTRYX template <name> --skeleton # layout skeleton with spatial annotations
-$ASTRYX swizzle <Name> # eject component source for deep customization
-$ASTRYX upgrade --apply # run version migration codemods
+astryx component <Name> --dense # props, variants, usage, anatomy for one component
+astryx template <name> # emit full page source
+astryx template <name> --skeleton # layout skeleton with spatial annotations
+astryx swizzle <Name> # eject component source for deep customization
+astryx upgrade --apply # run version migration codemods
OPTIONS: --detail compact|brief less output | --dense token-efficient | --zh Chinese
RULE: always run bootstrap on each branch — docs reflect the branch's actual API
-RULE: always run $ASTRYX component <Name> --dense before modifying a component
-RULE: after @astryxdesign/core bump, always run $ASTRYX upgrade --apply
+RULE: always run astryx component <Name> --dense before modifying a component
+RULE: after @astryxdesign/core bump, always run astryx upgrade --apply
<!-- ASTRYX-CLI:END -->