Skip to main content
cli

Command Line Interface

Add component source to your project, browse the catalog, and install from the public registry directly from your terminal.

1

Quick Installation via CLI

DevClub UI components can be installed directly into your local codebase using either the dedicated package runner or the universal shadcn CLI:

Official Package CLIRecommended
Terminal
1
npx @devclubnst/ui add noise
Universal Shadcn RegistryRemote JSON
Terminal
1
npx shadcn@latest add https://ui.devclubxnst.online/r/noise.json
2

Discover Components

List the available components, view CLI help, add several components in one command, or replace a component you already added with --overwrite.

Terminal
1
npx @devclubnst/ui@latest list
2
npx @devclubnst/ui@latest --help
3
npx @devclubnst/ui add noise orb
4
npx @devclubnst/ui add noise --overwrite
3

Component File Structure

The CLI uses an @/-based aliases.ui path from components.json when available. Otherwise, it selects src/components/ui or components/ui based on your project structure. Files that already exist are skipped; pass --overwrite to replace them. The cn() helper in lib/utils.ts must exist before you add components: run npx shadcn@latest init or follow the Project setup step in Installation.

Project Tree
1
src/
2
├── components/
3
│ └── ui/
4
│ ├── dotted-accordion.tsx
5
│ ├── ai-orb.tsx
6
│ ├── proximity-sidebar.tsx
7
│ └── noise.tsx
8
└── lib/
9
└── utils.ts

Zero Lock-In

Once a component is placed into your directory, it contains zero references to external runtime servers. It is 100% self-contained TypeScript and Tailwind CSS code under your git version control.