Project docsneobrutal-ui

How installation works

Direct URLs, optional short names, and the files installed by the shadcn CLI.

On this page5 sectionsBack to top

You do not need to understand the registry format to use neobrutal-ui. The recommended beginner flow is to copy the direct install command from a component page.

#What happens when you install

The shadcn CLI downloads source files, installs required packages, and places the code inside your project. There is no neobrutal-ui runtime package to keep in sync. The installed files become normal application code that you can edit.

#Direct URLs

Direct URLs work immediately and require no components.json changes:

npx shadcn@latest add https://neobrutal-ui.andongmin.com/r/dialog.json

The full catalog is available at neobrutal-ui.andongmin.com/r/registry.json.

#Optional short names

Add the namespace once if you prefer shorter commands:

{
  "registries": {
    "@neobrutal-ui": "https://neobrutal-ui.andongmin.com/r/{name}.json"
  }
}

The {name} placeholder maps @neobrutal-ui/button to the direct URL for button.json. You can then run:

npx shadcn@latest add @neobrutal-ui/dialog

#What you can install

  • Shared base provides the colors, borders, shadows, utilities, and core dependencies.
  • Components provide individual UI building blocks such as Button or Dialog.
  • Recipes combine multiple components into patterns such as a Combobox or Date Picker.
  • Templates add focused pages and supporting components for common starting points.
  • Themes replace the shared light and dark color tokens.

#Inspect before installing

Use view when you want to inspect files and packages without changing your project:

npx shadcn@latest view https://neobrutal-ui.andongmin.com/r/dialog.json

Use this especially before adding the shared base or a template to an existing application. Continue with Installation for the recommended setup order.