lerpa-cli 0.1.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 +60 -0
- package/dist/index.js +736 -0
- package/package.json +55 -0
- package/registry/registry.json +19852 -0
package/README.md
ADDED
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# lerpa-cli
|
|
2
|
+
|
|
3
|
+
Copy-paste components and blocks from the [Lerpa UI](https://github.com/cuibit-labs/lerpaui)
|
|
4
|
+
registry into any React + Tailwind project.
|
|
5
|
+
|
|
6
|
+
## Quick start
|
|
7
|
+
|
|
8
|
+
```bash
|
|
9
|
+
# Initialize the project (creates lerpa.json + components/ui/cn.ts)
|
|
10
|
+
pnpm dlx lerpa-cli init
|
|
11
|
+
|
|
12
|
+
# Add a component
|
|
13
|
+
pnpm dlx lerpa-cli add shiny-glow-button
|
|
14
|
+
|
|
15
|
+
# Add a block (e.g. a hero section)
|
|
16
|
+
pnpm dlx lerpa-cli add hero-saas-simple
|
|
17
|
+
|
|
18
|
+
# Update everything you have installed
|
|
19
|
+
pnpm dlx lerpa-cli update
|
|
20
|
+
|
|
21
|
+
# List what is available
|
|
22
|
+
pnpm dlx lerpa-cli list
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
The CLI ships with a bundled copy of the registry, so it works offline as
|
|
26
|
+
long as the package is installed.
|
|
27
|
+
|
|
28
|
+
## Where it puts files
|
|
29
|
+
|
|
30
|
+
By default, components are written to `components/ui/` and blocks to
|
|
31
|
+
`components/blocks/`. Override the targets in `lerpa.json`:
|
|
32
|
+
|
|
33
|
+
```json
|
|
34
|
+
{
|
|
35
|
+
"style": "default",
|
|
36
|
+
"tailwind": {
|
|
37
|
+
"config": "tailwind.config.ts",
|
|
38
|
+
"css": "app/globals.css"
|
|
39
|
+
},
|
|
40
|
+
"aliases": {
|
|
41
|
+
"components": "@/components",
|
|
42
|
+
"utils": "@/lib/utils"
|
|
43
|
+
},
|
|
44
|
+
"packageManager": "pnpm"
|
|
45
|
+
}
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Commands
|
|
49
|
+
|
|
50
|
+
| Command | Description |
|
|
51
|
+
| ---------------------------------- | ----------------------------------------------- |
|
|
52
|
+
| `lerpa-cli init` | Create `lerpa.json` and the `cn` helper. |
|
|
53
|
+
| `lerpa-cli add <name>` | Install a component or block + its npm deps. |
|
|
54
|
+
| `lerpa-cli update [name]` | Re-install one or all installed items. |
|
|
55
|
+
| `lerpa-cli list` | Print every item available in the registry. |
|
|
56
|
+
| `lerpa-cli remove <name>` | Delete an installed component file. |
|
|
57
|
+
|
|
58
|
+
## License
|
|
59
|
+
|
|
60
|
+
MIT © Lerpa UI contributors.
|