Oxy UI

A CLI tool to install UI components from custom registries, similar to shadcn/ui.

Installation

Global Installation

```bash npm install -g oxy-ui ```

Or use with npx (recommended)

```bash npx oxy-ui@latest init npx oxy-ui@latest add button ```

Usage

Initialize your project

```bash

Global installation

oxy-ui init

Or with npx

npx oxy-ui@latest init ```

Add components

Add components by name (from default registry): ```bash

Global installation

oxy-ui add button card

Or with npx (just like shadcn!)

npx oxy-ui@latest add button card ```

Add components from custom registry URL: ```bash

Global installation

oxy-ui add https://ui.aceternity.com/registry/3d-card.json

Or with npx

npx oxy-ui@latest add https://ui.aceternity.com/registry/3d-card.json ```

Add with options: ```bash npx oxy-ui@latest add button --overwrite --verbose npx oxy-ui@latest add card --registry https://custom-registry.com ```

Registry Format

Your registry should return JSON in this format:

```json { "name": "3d-card", "type": "registry:ui", "files": [ { "path": "components/ui/3d-card.tsx", "content": "// Component code here...", "type": "registry:ui", "target": "components/ui/3d-card.tsx" } ], "author": "Your Name [email protected]", "title": "3D Card", "dependencies": ["react", "react-dom"], "devDependencies": ["@types/react"], "registryDependencies": ["button", "card"] } ```

Configuration

The components.json file stores your project configuration:

```json { "style": "default", "rsc": true, "tsx": true, "tailwind": { "config": "tailwind.config.js", "css": "app/globals.css", "baseColor": "slate", "cssVariables": true }, "aliases": { "components": "@/components", "utils": "@/lib/utils" } } ```

Features

• ✅ Support for custom registries
• ✅ Automatic dependency installation
• ✅ TypeScript support
• ✅ Multiple package managers (npm, yarn, pnpm)
• ✅ File conflict detection
• ✅ Import alias transformation
• ✅ Framework detection (Next.js, Vite, Remix, Astro)
• ✅ Registry dependency resolution

Commands

oxy-ui init

Initialize your project with the required configuration and dependencies.

oxy-ui add <components...>

Add one or more components to your project.

Options:

• -o, --overwrite - Overwrite existing files
• -r, --registry <url> - Use custom registry URL
• -v, --verbose - Show detailed output

License

MIT