Set up your coding agent
Teach Claude Code, Cursor, or Copilot to write Appica UI correctly.
Coding agents are good at React and bad at guessing a design system's rules. Left
to itself, an agent writes bg-gray-100 instead of bg-background-muted, forgets
the @source directive and then writes CSS to "fix" the unstyled components, and
rebuilds a Dialog it never noticed the library already ships.
None of that is a knowledge problem. Everything an agent needs is published - it just isn't in the one place agents reliably read: your project's own agent instructions file. Two minutes of setup fixes it.
Add the rules to your project
Paste this into your AGENTS.md. Most agents load it automatically at the start
of every session - Claude Code, Cursor, Copilot, Codex, Zed and Windsurf all read
AGENTS.md, and Claude Code also reads CLAUDE.md.
Already have an AGENTS.md?
Append it under a heading of its own, like ## Appica UI. Agents read the whole file, and a named
section keeps the rules attributable when you later add rules for something else.
If your agent reads CLAUDE.md rather than AGENTS.md, a one-line pointer keeps
a single copy:
Point it at the docs
The rules cover how to write Appica UI. For what the library contains - every component, its props, its examples - add one more line so your agent fetches pages on demand instead of guessing:
That file is an llms.txt index: the rules above, then a linked list of every documentation page. Each link points at clean markdown, so an agent that follows one gets roughly 8 KB of prose and tables rather than a rendered HTML page.
Don't paste the whole documentation into context
Every page on this site is available as markdown by appending .md to its URL - the
Button page is also
button.md. Let your agent fetch the one page it needs. There is
deliberately no bulk llms-full.txt: at ~92 pages it would consume most of a context window and
crowd out your actual code.
What the agent reads
Three sources, in the order an agent tends to reach them:
The copy inside node_modules is the authoritative one - the block on this page
and the rules in llms.txt are both generated from it. If you upgrade Appica UI
and the rules change, the package tells you before this site does.
Verify it worked
Ask your agent to build something small that exercises the two rules that fail silently:
Build a settings card with a heading, a description, a labeled text input, and a save button. Use Appica UI.
Check the result for three things:
- Imports use subpaths -
@appica/ui-react/button, not@appica/ui-react. - No hue-based classes - no
bg-gray-100,text-slate-600, or hex colors. Colors should be roles:bg-background-muted,text-foreground-intense. - It renders styled. If everything is unstyled, the
@sourceline is missing or its path is wrong - see Installation.
If the agent hand-rolled a card or an input instead of importing one, it didn't load the rules. Confirm the file is at your repo root and that your agent reads that filename.