Circuit UI
Designcircuit-uiCircuit 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.
QUICK START
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/sumup-oss/circuit-ui/blob/HEAD/skills/circuit-ui/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/circuit-ui, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
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.mdfor the source-of-truth token inventory. - Read
references/components.mdfor the source-of-truth exported API inventory index for available components. - Read
references/hooks.mdfor the source-of-truth exported API inventory index for available hooks. - Open linked files in
references/components/andreferences/hooks/for usage guidance copied from MDX stories/docs.
Required Workflow
- Determine whether the request is token-focused, component-focused, hook-focused, or a mix.
- Use the generated references first.
- If the request needs deeper implementation details, then inspect component, hook, or token source files.
- 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/**/*.mdxandpackages/circuit-ui/hooks/**/*.mdx. - Treat generated references as the primary interface docs for this skill.