# Circuit UI

> Circuit UI is an Agent Skill for design published in the sumup-oss/circuit-ui repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Use this skill when working with the Circuit UI design system. It provides generated inventories of design tokens plus exported Circuit UI components and hooks from the source code, so you can answer usage and availability questions with current data.

- Skill name: `circuit-ui`
- Category: [Design](https://www.openparable.com/skill/design/1)
- Source: https://github.com/sumup-oss/circuit-ui/blob/HEAD/skills/circuit-ui/SKILL.md
- Repository: sumup-oss/circuit-ui (973 GitHub stars when collected)

## SKILL.md

# Circuit UI Design System

Use this skill for questions and implementation work related to Circuit UI tokens, components, and hooks.

## Entrypoint

- Read `references/design-tokens.md` for the source-of-truth token inventory.
- Read `references/components.md` for the source-of-truth exported API inventory index for available components.
- Read `references/hooks.md` for the source-of-truth exported API inventory index for available hooks.
- Open linked files in `references/components/` and `references/hooks/` for usage guidance copied from MDX stories/docs.

## Required Workflow

1. Determine whether the request is token-focused, component-focused, hook-focused, or a mix.
2. Use the generated references first.
3. If the request needs deeper implementation details, then inspect component, hook, or token source files.
4. Keep answers aligned with currently exported APIs, not internal modules.

## Notes

- Token inventory is generated from `packages/design-tokens/themes/schema.ts`.
- API inventory is generated from `packages/circuit-ui/index.ts`.
- Component and hook usage references are copied from `packages/circuit-ui/components/**/*.mdx` and `packages/circuit-ui/hooks/**/*.mdx`.
- Treat generated references as the primary interface docs for this skill.

---

Source: https://www.openparable.com/skill/design/circuit-ui (OpenParable). Cite the canonical URL above.
