@cloudwick/astral-ui-cli 0.4.0 → 0.5.0

package/README.md

@@ -9,13 +9,9 @@ For most projects, we recommend using the CLI with `npx` or `yarn dlx` instead o
 ```bash
 # Using npx
 npx @cloudwick/astral-ui-cli init
-# or more simply:
-npx astral-ui init
 
 # Using yarn
 yarn dlx @cloudwick/astral-ui-cli init
-# or:
-yarn dlx astral-ui init
 ```
 
 If you frequently use the CLI in your workflow, you can install it globally:
@@ -32,13 +28,13 @@ yarn global add @cloudwick/astral-ui-cli
 
 ```bash
 # Initialize your project
-npx astral-ui init
+npx @cloudwick/astral-ui-cli init
 
 # Follow instructions to set up path aliases
-npx astral-ui setup-aliases
+npx @cloudwick/astral-ui-cli setup-aliases
 
 # Add components
-npx astral-ui add button card
+npx @cloudwick/astral-ui-cli add button card
 
 # Start using in your code
 import { Button } from '@components/ui/button';
@@ -50,10 +46,10 @@ import { keyboardKeys, mobileBreakPoint } from '@constants';
 
 For the best experience, follow these steps in order:
 
-1. **Initialize** your project with `npx astral-ui init`
-2. **Set up path aliases** using `npx astral-ui setup-aliases` and follow the instructions
-3. **Add components** with `npx astral-ui add [component...]`
-4. **Repair Tailwind** if needed with `npx astral-ui repair-tailwind`
+1. **Initialize** your project with `npx @cloudwick/astral-ui-cli init`
+2. **Set up path aliases** using `npx @cloudwick/astral-ui-cli setup-aliases` and follow the instructions
+3. **Add components** with `npx @cloudwick/astral-ui-cli add [component...]`
+4. **Repair Tailwind** if needed with `npx @cloudwick/astral-ui-cli repair-tailwind`
 5. **Import and use** components in your application
 
 ## Commands
@@ -63,7 +59,7 @@ For the best experience, follow these steps in order:
 Initialize a project with Astral Core configuration.
 
 ```bash
-npx astral-ui init
+npx @cloudwick/astral-ui-cli init
 ```
 
 This command will:
@@ -90,7 +86,7 @@ This command will:
 Display instructions for setting up path aliases in your project.
 
 ```bash
-npx astral-ui setup-aliases
+npx @cloudwick/astral-ui-cli setup-aliases
 ```
 
 This command will:
@@ -110,10 +106,10 @@ This command will:
 
 ```bash
 # Generate instructions for current directory
-npx astral-ui setup-aliases
+npx @cloudwick/astral-ui-cli setup-aliases
 
 # Generate instructions for a specific project
-npx astral-ui setup-aliases --cwd ./my-project
+npx @cloudwick/astral-ui-cli setup-aliases --cwd ./my-project
 ```
 
 ### `add`
@@ -121,7 +117,7 @@ npx astral-ui setup-aliases --cwd ./my-project
 Add components to your project.
 
 ```bash
-npx astral-ui add [component...]
+npx @cloudwick/astral-ui-cli add [component...]
 ```
 
 #### Options
@@ -135,21 +131,28 @@ npx astral-ui add [component...]
 | `--path <path>` | `-p` | Specify the path to add the component to |
 | `--silent` | `-s` | Mute output |
 | `--skip-dependencies` |  | Skip installing internal component dependencies |
+| `--list` | `-l` | List all available components |
 
 #### Examples
 
 ```bash
+# List all available components
+npx @cloudwick/astral-ui-cli add --list
+
+# List components in silent mode (component names only)
+npx @cloudwick/astral-ui-cli add --list --silent
+
 # Add specific components
-npx astral-ui add button card select
+npx @cloudwick/astral-ui-cli add button card select
 
 # Add all components
-npx astral-ui add --all
+npx @cloudwick/astral-ui-cli add --all
 
 # Add a component to a specific directory
-npx astral-ui add button --path ./components/custom
+npx @cloudwick/astral-ui-cli add button --path ./components/custom
 
 # Skip installing internal component dependencies
-npx astral-ui add button --skip-dependencies
+npx @cloudwick/astral-ui-cli add button --skip-dependencies
 ```
 
 ### `repair-tailwind`
@@ -157,7 +160,7 @@ npx astral-ui add button --skip-dependencies
 Repair Tailwind configuration when setup fails - only use if experiencing issues with Tailwind.
 
 ```bash
-npx astral-ui repair-tailwind
+npx @cloudwick/astral-ui-cli repair-tailwind
 ```
 
 This command will:
@@ -186,13 +189,13 @@ The CSS structure created will match exactly what the `init` command creates, in
 
 ```bash
 # Basic repair
-npx astral-ui repair-tailwind
+npx @cloudwick/astral-ui-cli repair-tailwind
 
 # Force overwrite existing files
-npx astral-ui repair-tailwind --force
+npx @cloudwick/astral-ui-cli repair-tailwind --force
 
 # Repair in a specific directory
-npx astral-ui repair-tailwind --cwd ./my-project
+npx @cloudwick/astral-ui-cli repair-tailwind --cwd ./my-project
 ```
 
 ## Configuration
@@ -236,6 +239,20 @@ For full details, see `schema/components-config.schema.json` in your project.
 
 ## Available Components
 
+To see a complete list of all available components, run:
+
+```bash
+npx @cloudwick/astral-ui-cli add --list
+```
+
+This will display all components with their descriptions. You can also use the silent mode to get just the component names:
+
+```bash
+npx @cloudwick/astral-ui-cli add --list --silent
+```
+
+### Popular Components
+
 | Component | Description |
 |-----------|-------------|
 | `button` | A button component with various styles, sizes, and states |
@@ -284,7 +301,7 @@ The `cn` function allows you to conditionally combine class names and automatica
 
 ## Styling Components
 
-The components in the registry require Tailwind CSS to be properly configured in your application. When you run `npx astral-ui init`, the CLI will:
+The components in the registry require Tailwind CSS to be properly configured in your application. When you run `npx @cloudwick/astral-ui-cli init`, the CLI will:
 
 1. Check for an existing Tailwind configuration and upgrade it with required settings
 2. Create a CSS file with required CSS variables for component styling
@@ -327,7 +344,7 @@ If you're having problems with imports:
    - **Next.js**: Make sure you're using the correct import format for your Next.js version
    - **Angular**: Configure paths in tsconfig.app.json instead of tsconfig.json
    - **Create React App**: You'll need CRACO or similar to enable path aliases
-3. **Verify setup**: Run `npx astral-ui setup-aliases` again to get fresh instructions
+3. **Verify setup**: Run `npx @cloudwick/astral-ui-cli setup-aliases` again to get fresh instructions
 4. **Check components.json**: Make sure the paths in the "aliases" section match your project structure
 
 ### Styling Issues
@@ -337,7 +354,7 @@ If components don't appear correctly styled:
 1. Make sure the Tailwind CSS configuration is properly loaded in your application
 2. Verify the CSS variables are included in your main CSS file 
 3. Check that your component is properly importing the required utilities
-4. Run `npx astral-ui repair-tailwind` to create a fresh Tailwind configuration
+4. Run `npx @cloudwick/astral-ui-cli repair-tailwind` to create a fresh Tailwind configuration
 5. If you need to combine the new configuration with your existing customizations, use your backup file as a reference
 
 ## Contributing