Installation

How to install and configure Cortexcn in your project.

Cortexcn components are distributed through a shadcn registry. You add them with the shadcn CLI, and the component source is copied into your project.

Prerequisites

Before installing Cortexcn components, make sure you have shadcn/ui set up in your project. If you haven't already, run:

npx shadcn@latest init

Add the registry

Add the @cortexcn namespace to the registries field in your components.json:

{
  "registries": {
    "@cortexcn": "https://ui.cortexcn.dev/r/{name}.json"
  }
}

You only need to do this once per project.

Install components

Install any Cortexcn component using the CLI:

Cortexcn
pnpm dlx shadcn@latest add @cortexcn/area-chart

This will:

  • Download the component source code into your project
  • Install any npm packages the component needs
  • Install any other Cortexcn components it depends on

For example, @cortexcn/line-chart, @cortexcn/area-chart, and @cortexcn/heatmap-chart pull in @cortexcn/shimmering-text for their loading labels.

Next Steps

You're all set. Browse the Components section to start adding components to your project.