Component Registry
@cloudflare/kumo

Overview

The component registry is a machine-readable JSON file that describes all Kumo components, their props, variants, examples, and semantic tokens. It’s designed for AI agents, code generators, and other tooling.

View JSON API

Accessing the Registry

Via CLI

# List all components
npx @cloudflare/kumo ls

# Get docs for a specific component

npx @cloudflare/kumo doc Button

Via HTTP API

# JSON endpoint
curl https://kumo-ui.com/api/component-registry

Via jq (Local)

# Get Button props
jq '.components.Button.props' packages/kumo/ai/component-registry.json

# List components by category

jq '.search.byCategory' packages/kumo/ai/component-registry.json

Registry Contents

The registry includes: component props with types and defaults, variant options with descriptions, real code examples from stories, semantic color tokens used, and sub-components for compound patterns.

39components
8categories
v1.0.0