centoui-cli 1.0.0-alpha.29 → 1.0.0-alpha.30

package/README.md

@@ -1,32 +1,91 @@
-# centoui-cli
+<div align="center">
+  <h1>centoui-cli</h1>
+  <p><strong>Manage CentoUI components from the terminal.</strong></p>
+  <p>
+    <a href="https://npmx.dev/package/centoui-cli"><img src="https://img.shields.io/npm/v/centoui-cli.svg?style=plastic&label=NPM Version&color=blue" alt="npm version"></a>
+    <a href="https://npmx.dev/package/centoui-cli"><img src="https://img.shields.io/npm/dw/centoui-cli.svg?style=plastic&label=NPM Downloads&color=blue" alt="npm downloads"></a>
+    <a href="https://npmx.dev/package/centoui-cli"><img src="https://img.shields.io/npm/unpacked-size/centoui-cli?style=plastic&label=NPM Unpacked Size&color=blue" alt="NPM Unpacked Size"></a>
+  </p>
+</div>
 
-[![npm version](https://img.shields.io/npm/v/centoui-cli.svg?style=plastic)](https://npmx.dev/package/centoui-cli)
-[![npm downloads](https://img.shields.io/npm/dm/centoui-cli.svg?style=plastic)](https://npmx.dev/package/centoui-cli)
-[![NPM Unpacked Size](https://img.shields.io/npm/unpacked-size/centoui-cli?style=plastic)](https://npmx.dev/package/centoui-cli)
+<br>
 
-**Manage CentoUI Components with Ease.**
-
-`centoui-cli` is the official command-line interface for [CentoUI](../core). It allows you to initialize CentoUI in your project, add new components, and manage their versions directly from your terminal.
+`centoui-cli` is the command-line interface for [CentoUI](../core). It initializes projects, pulls component source files from the registry into your codebase, resolves dependency trees automatically, and cleans up when you remove components.
 
 ## Commands
 
-- **`init`**: Set up a new CentoUI project (generates `centoui.config.ts` and `centoui.css`).
-- **`add [component]`**: Add specific components to your project. Peer dependencies install automatically.
-- **`remove [component]`**: Cleanly remove components and their dependencies.
+### `centoui init`
 
-## Usage
+Scaffolds a new CentoUI project in your current directory.
 
 ```bash
-# Initialize CentoUI in your project
 pnpm dlx centoui init
+```
+
+**What it does:**
+
+1. Prompts you for a component directory (default: `src/components/centoui`) and theme CSS path (default: `src/assets/css/centoui.css`).
+2. Writes `centoui.config.ts` with your chosen paths and default icon mappings.
+3. Fetches and writes the `centoui.css` theme file with all light/dark color tokens.
+4. Creates the component directory.
+5. Installs global peer dependencies (`vue`, `reka-ui`, `tailwindcss`, etc.).
+
+---
+
+### `centoui add <component> [component...]`
+
+Adds one or more components to your project.
+
+```bash
+pnpm dlx centoui add button accordion select
+```
+
+**What it does:**
+
+1. Fetches the component registry from GitHub.
+2. Resolves the full dependency tree — if `select` depends on `popover`, both are installed.
+3. Asks before overwriting any component that already exists.
+4. Downloads `.vue` and `index.ts` files for each component into your configured directory.
+5. Installs any npm packages required by the added components.
+
+---
+
+### `centoui remove <component>`
+
+Removes an installed component and cleans up orphaned packages.
 
-# Add components
-pnpm dlx centoui add button dialog input select
+```bash
+pnpm dlx centoui remove accordion
 ```
 
+**What it does:**
+
+1. Checks that the component is actually installed.
+2. Blocks removal if other installed components depend on it (e.g., you can't remove `popover` while `select` is installed).
+3. Deletes the component's directory.
+4. Uninstalls npm packages that are no longer needed by any remaining component.
+
+## Version-Locked Asset Fetching
+
+Every network request the CLI makes — the registry index, individual component files, the theme CSS, and the default config — is resolved against the **exact git tag that matches the installed version of `centoui-cli`**.
+
+The base URL for all assets is derived directly from the CLI's own `package.json` version at build time:
+
+```
+https://raw.githubusercontent.com/favorodera/centoui/refs/tags/v<VERSION>/packages/core/src
+```
+
+This means:
+
+- If you have `centoui-cli@1.2.3` installed, all fetched assets come from the `v1.2.3` tag of the `centoui` repository — never from `main` or any other release.
+- The registry, component source files, CSS theme, and config defaults are always in sync with each other and with the CLI you are running.
+- Upgrading the CLI upgrades the version tag automatically — no separate step needed.
+
+This design eliminates an entire class of version mismatch bugs where the CLI and the component source could drift out of sync.
+
 ## Configuration
 
-The CLI generates a `centoui.config.ts` file in your root directory. You can customize the component directory, theme directory, and utility directory here.
+After running `centoui init`, your project root will contain a `centoui.config.ts`:
 
 ```ts
 import { defineConfig } from "centoui"
@@ -37,7 +96,19 @@ export default defineConfig({
   icons: {
     check: "lucide:check",
     close: "lucide:x",
-    menu: "lucide:menu",
+    chevronDown: "lucide:chevron-down",
+    chevronUp: "lucide:chevron-up",
+    chevronLeft: "lucide:chevron-left",
+    chevronRight: "lucide:chevron-right",
+    chevronDoubleLeft: "lucide:chevrons-left",
+    chevronDoubleRight: "lucide:chevrons-right",
+    ellipsis: "lucide:ellipsis",
   },
 })
 ```
+
+The `icons` map lets you swap icon libraries without touching component code. Components reference icons by their slot name (e.g., `check`, `close`), and the config resolves them to [Iconify](https://iconify.design/) IDs.
+
+## License
+
+[MIT](../../LICENSE) &copy; [Favour Emeka](https://github.com/favorodera)

package/dist/index.mjs

@@ -8,7 +8,7 @@ import { loadConfig } from "c12";
 //#endregion
 //#region src/constants.ts
 /** CentoUI current package version, sourced directly from package.json. */
-const VERSION = "1.0.0-alpha.29";
+const VERSION = "1.0.0-alpha.30";
 /** File name for the user-side CentoUI config (created by `centoui init`). */
 const CONFIG_FILE_NAME = "centoui.config.ts";
 /**

package/package.json

@@ -1,9 +1,16 @@
 {
   "name": "centoui-cli",
   "type": "module",
-  "version": "1.0.0-alpha.29",
+  "version": "1.0.0-alpha.30",
   "private": false,
   "description": "Official CLI for CentoUI.",
+  "keywords": [
+    "cli",
+    "vue",
+    "ui",
+    "components",
+    "tailwindcss"
+  ],
   "author": "Favour Emeka <favorodera@gmail.com>",
   "license": "MIT",
   "homepage": "https://centoui.vercel.app",