zerozeeker 1.0.0 → 1.0.1
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 +73 -0
- package/package.json +4 -3
package/README.md
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# ZeroZeeker CLI
|
|
2
|
+
|
|
3
|
+
Official CLI for installing ZeroZeeker UI components globally.
|
|
4
|
+
|
|
5
|
+
## Package Details
|
|
6
|
+
|
|
7
|
+
- **NPM Package:** `zerozeeker` (unscoped)
|
|
8
|
+
- **Published:** Yes, on npmjs.com
|
|
9
|
+
- **Usage:** `npx zerozeeker add <component>`
|
|
10
|
+
|
|
11
|
+
## Features
|
|
12
|
+
|
|
13
|
+
- ✅ Zero configuration required
|
|
14
|
+
- ✅ Works in any project globally
|
|
15
|
+
- ✅ Short, memorable command
|
|
16
|
+
- ✅ Lists all available components
|
|
17
|
+
|
|
18
|
+
## Usage Examples
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
# Install a component
|
|
22
|
+
npx zerozeeker add rainbow-button
|
|
23
|
+
|
|
24
|
+
# List all available components
|
|
25
|
+
npx zerozeeker list
|
|
26
|
+
|
|
27
|
+
# Get help
|
|
28
|
+
npx zerozeeker --help
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## How It Works
|
|
32
|
+
|
|
33
|
+
This CLI wraps the shadcn CLI and automatically resolves the full registry URL, so users don't need to configure anything in their `components.json`.
|
|
34
|
+
|
|
35
|
+
When a user runs:
|
|
36
|
+
```bash
|
|
37
|
+
npx zerozeeker add rainbow-button
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
The CLI internally calls:
|
|
41
|
+
```bash
|
|
42
|
+
npx shadcn@latest add https://www.zerozeeker.com/r/rainbow-button.json
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Development
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
# Install dependencies
|
|
49
|
+
npm install
|
|
50
|
+
|
|
51
|
+
# Build
|
|
52
|
+
npm run build
|
|
53
|
+
|
|
54
|
+
# Test locally
|
|
55
|
+
npm link
|
|
56
|
+
zerozeeker list
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## Publishing
|
|
60
|
+
|
|
61
|
+
Already published to NPM as `zerozeeker@1.0.0`
|
|
62
|
+
|
|
63
|
+
To publish updates:
|
|
64
|
+
```bash
|
|
65
|
+
# Update version in package.json
|
|
66
|
+
# Then:
|
|
67
|
+
npm run build
|
|
68
|
+
npm publish
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## Note
|
|
72
|
+
|
|
73
|
+
There's also a scoped version `@zerozeeker/cli` published, but we use the unscoped `zerozeeker` package in all documentation for better UX (shorter command).
|
package/package.json
CHANGED
|
@@ -1,13 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "zerozeeker",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "CLI for installing ZeroZeeker UI components",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
7
7
|
"zerozeeker": "dist/index.js"
|
|
8
8
|
},
|
|
9
9
|
"files": [
|
|
10
|
-
"dist"
|
|
10
|
+
"dist",
|
|
11
|
+
"README.md"
|
|
11
12
|
],
|
|
12
13
|
"scripts": {
|
|
13
14
|
"build": "tsup index.ts --format esm --dts --clean",
|
|
@@ -37,7 +38,7 @@
|
|
|
37
38
|
},
|
|
38
39
|
"repository": {
|
|
39
40
|
"type": "git",
|
|
40
|
-
"url": "https://
|
|
41
|
+
"url": "https://g/ZERO-DAWN-X/zero-zeeker-frontend.git",
|
|
41
42
|
"directory": "cli-unscoped"
|
|
42
43
|
}
|
|
43
44
|
}
|