@docyrus/cli 0.3.1 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -114,6 +114,57 @@ Each template includes:
114
114
  - Modern TypeScript setup
115
115
  - Linter configuration (ESLint or Biome)
116
116
 
117
+ ### Component Registry
118
+
119
+ #### `add [items...]`
120
+
121
+ Add Docyrus UI components, hooks, or utilities to your project. Reads `components.json` to auto-detect the correct variant (Radix or Base).
122
+
123
+ **Prerequisite:** Run `npx shadcn@latest init` first to create `components.json`.
124
+
125
+ ```bash
126
+ npx @docyrus/cli add button # Add a component (variant from components.json)
127
+ npx @docyrus/cli add button dialog # Add multiple components
128
+ npx @docyrus/cli add hooks-debounce # Add a hook
129
+ npx @docyrus/cli add utils-cn # Add a utility
130
+ npx @docyrus/cli add button --dry-run # Preview installation
131
+ npx @docyrus/cli add button -o # Overwrite existing files
132
+ npx @docyrus/cli add button -p ./src/ui # Custom target path
133
+ ```
134
+
135
+ **Registry Names:**
136
+
137
+ | Input | Registry Name |
138
+ |-------|---------------|
139
+ | `button` | `@docyrus/ui-button` |
140
+ | `hooks-debounce` | `@docyrus/hooks-debounce` |
141
+ | `utils-cn` | `@docyrus/utils-cn` |
142
+
143
+ **Options:**
144
+
145
+ | Option | Description |
146
+ |--------|-------------|
147
+ | `-o, --overwrite` | Overwrite existing files without prompting |
148
+ | `-d, --dry-run` | Show what would be installed without making changes |
149
+ | `-p, --path <path>` | Custom target path for files |
150
+
151
+ #### `list`
152
+
153
+ List available Docyrus UI registry items (components, hooks, utilities) or published npm packages.
154
+
155
+ ```bash
156
+ npx @docyrus/cli list # List registry components
157
+ npx @docyrus/cli ls # Shorthand alias
158
+ npx @docyrus/cli list --packages # List published @docyrus npm packages
159
+ npx @docyrus/cli list --json # Output as JSON
160
+ ```
161
+
162
+ **Options:**
163
+
164
+ | Option | Description |
165
+ |--------|-------------|
166
+ | `--packages` | List published @docyrus npm packages instead |
167
+
117
168
  ### Code Generation
118
169
 
119
170
  #### `generate db [spec]`