BUX with AI Coding Assistants
AI coding assistants such as Claude Code, GitHub Copilot and Cursor do not know BUX on their own. Left alone, they write custom markup and hardcoded colors instead of using BUX components and design tokens. BUX publishes a guide written for these tools that explains how to install BUX, find the right component, and style with BUX tokens.
The guide
The guide always matches the current BUX version.
- On this site: bux.osu.edu/llms.txt
- In the npm and Composer packages:
dist/ai/SKILL.md
The packages also include a component reference in dist/ai/: an index of every component, plus
one file per component with its properties, allowed values and examples. The guide tells the
assistant how to use it.
Using it
Claude Code
Install the guide as a skill in your project. Claude will use it whenever you work on BUX markup.
mkdir -p .claude/skills/bux
curl -o .claude/skills/bux/SKILL.md https://bux.osu.edu/ai/SKILL.md
If BUX is already installed with npm, you can copy it from
node_modules/@osu/bux-source/dist/ai/SKILL.md instead.
Other assistants
Point the assistant at the guide in your project's instructions file (such as AGENTS.md,
.github/copilot-instructions.md or .cursor/rules):
This project uses the Buckeye UX (BUX) design system. Before writing markup or CSS, read
https://bux.osu.edu/llms.txt and follow it.
Review the output
The guide makes the assistant much more likely to use BUX correctly, but it does not guarantee it. Check the result against the component pages on this site, and in both light and dark mode.