DOCUMENTATION / GETTING STARTED

From a component
to your next great interface.

Cavemio installs editable React source into your project through shadcn. Start with a React and Tailwind CSS v4 project, then initialize shadcn.

npx shadcn@4.21.5 init

Configure the @cavemio namespace

Add the registry to your existing components.json once. This is a shadcn registry namespace; it does not install an npm package named @cavemio/text-morph.

First install? Configure @cavemio once

Run npx shadcn@4.21.5 init if shadcn is not set up, then merge this entry into the registries field in your existing components.json. Keep your other settings and registries.

components.json
{
  "registries": {
    "@cavemio": "https://registry.cavemio.dev/r/cavemio-{name}.json"
  }
}

Install the complete component

npx shadcn@4.21.5 add @cavemio/text-morph

Browse the component collection and copy the installation command for your component. The installer includes its source files, shared helpers, packages, and required CSS. Inspect every file through the Registry JSON link. Review existing files before overwriting; you can keep your customized components.

Make it yours

Each component lives in your project. Change the typography, colors, content, and motion to fit your product. There is no Cavemio runtime subscription or account to maintain.

Contribute a component

Canonical component code and registry metadata belong in cavemio-components. Follow its CONTRIBUTING.md: add a composition, declare its helpers, CSS, and dependencies, build, validate, and test keyboard behavior plus a real consumer installation. Website contributions belong in cavemio-web.

MCP & agent skills

MCP and agent skills are part of the Cavemio platform roadmap. The MCP integration is being prepared for component discovery and implementation context; skills will provide reusable guidance for composing and customizing components.

Public connection details and skill installation commands are not available yet. Until then, use the component’s registry JSON to inspect the source and share its props table with your coding agent.

License

Cavemio is free and open source under the MIT license. You can use, modify, and distribute the components in personal and commercial projects. Retain the applicable copyright and license notices with the source.

What comes next

Context menus, blocks, animation examples, templates, and the visual builder are deferred. Components are distributed as editable source through shadcn.