heyatomix
v1.0.2
Published
Atomix Design System CLI - sync tokens and AI rules
Maintainers
Readme
heyatomix
CLI for syncing Atomix design tokens and AI rules to your project.
Quick Start
# Sync tokens + AI rules (default)
npx heyatomix sync
# Sync tokens only (skip AI rules)
npx heyatomix sync --no-rules
# Create config file
npx heyatomix init
# Show help
npx heyatomix helpSetup
- Go to Atomix Studio and publish your design system
- Note your design system ID from the URL:
atomixstudio.eu/ds/[ds-id] - Run
npx heyatomix initto create a config file
Commands
sync
Sync design tokens and AI rules. Both sync by default since the AI guidance rules reference tokens.
npx heyatomix sync # Sync tokens + AI rules
npx heyatomix sync --no-rules # Sync tokens only
npx heyatomix sync -o src/tokens.css # Custom output
npx heyatomix sync --format scss # Output as SCSS
npx heyatomix sync -y # Auto-confirminit
Create a .atomixrc config file:
npx heyatomix initOptions
| Option | Description |
|--------|-------------|
| --ds-id | Design system ID |
| --output, -o | Output file [./tokens.css] |
| --format | css, scss, less, json, ts, js, swift, kotlin, dart |
| --no-rules | Skip AI rules (tokens + rules sync by default) |
| -y, --yes | Auto-confirm changes |
Output Formats
Web: css, scss, less, json, ts, js
Native: swift (iOS), kotlin (Android), dart (Flutter)
All formats include light + dark mode values.
AI Rules
By default, syncs rules for your AI coding tools:
.cursorrules(Cursor).windsurfrules(Windsurf).clinerules(Cline).github/copilot-instructions.md(Copilot)
Use --no-rules to skip AI rules sync.
Links
- Atomix Studio
- @atomixstudio/mcp (full package)
License
MIT
