Skip to Content
Install

Install

The Circle Health Registry distributes source through the shadcn CLI. The CLI downloads source into the consumer; it does not add a runtime package.

1. Start with a shadcn project

The consumer needs a valid components.json. If it does not have one yet, run:

pnpm dlx shadcn@latest init

2. Add the registries

Add the Circle Health namespaces to components.json:

{ "$schema": "https://ui.shadcn.com/schema.json", "registries": { "@circle-ui": "https://registry.circle.health/circle-ui/{name}.json", "@blocks": "https://registry.circle.health/blocks/{name}.json", "@utilities": "https://registry.circle.health/utilities/{name}.json", "@i18n": "https://registry.circle.health/i18n/{name}.json", "@skills": "https://registry.circle.health/skills/{name}.json" } }

@circle-ui contains primitives. @blocks contains product modules. @utilities contains behavior with no UI workflow attached. @i18n contains optional locale dictionaries referenced by those modules. @skills contains agent workflows installed under .agents/skills.

3. Install the base style

Install the shared tokens and defaults once per consumer:

pnpm dlx shadcn@latest add @circle-ui/circle

4. Add what the product needs

Install items by namespace and name:

pnpm dlx shadcn@latest add @circle-ui/button pnpm dlx shadcn@latest add @blocks/booking-timeline pnpm dlx shadcn@latest add @utilities/analytics

The CLI resolves registry dependencies and writes the files into the consumer. Review those files like any other source change.

Direct URL installation

When a consumer cannot edit components.json, install from the public JSON URL:

pnpm dlx shadcn@latest add https://registry.circle.health/circle-ui/button.json

Next

Use Components for primitives, Blocks for assembled product patterns, Utilities for behavior-only helpers, and Concepts for the ownership and dependency model.

Last updated on