@shadsapp/cli 0.1.0 → 0.1.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 +67 -0
- package/package.json +5 -4
package/README.md
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# @shadsapp/cli
|
|
2
|
+
|
|
3
|
+
CLI for installing and importing [shads.app](https://shads.app) themes into shadcn/ui projects.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g @shadsapp/cli
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Or run without installing:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npx @shadsapp/cli --help
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
The binary name is **`shads`**.
|
|
18
|
+
|
|
19
|
+
## Commands
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
# Install theme files into the current project
|
|
23
|
+
shads install -t workspace
|
|
24
|
+
|
|
25
|
+
# List public starter themes
|
|
26
|
+
shads themes list
|
|
27
|
+
|
|
28
|
+
# Import a theme (theme.json + theme.css)
|
|
29
|
+
shads themes import workspace
|
|
30
|
+
|
|
31
|
+
# Validate a theme document
|
|
32
|
+
shads validate theme.json
|
|
33
|
+
|
|
34
|
+
# Print active schema id
|
|
35
|
+
shads schema
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## What gets written
|
|
39
|
+
|
|
40
|
+
By default:
|
|
41
|
+
|
|
42
|
+
- `theme.json`
|
|
43
|
+
- `src/styles/theme.css`
|
|
44
|
+
|
|
45
|
+
Import the CSS in your app entry (e.g. `main.tsx` or `layout.tsx`).
|
|
46
|
+
|
|
47
|
+
## Examples
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
npx @shadsapp/cli install -t workspace
|
|
51
|
+
npx @shadsapp/cli themes import terminal
|
|
52
|
+
npx @shadsapp/cli validate ./theme.json
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## Customize themes
|
|
56
|
+
|
|
57
|
+
Edit visually at [shads.app](https://shads.app), then export production CSS from the builder.
|
|
58
|
+
|
|
59
|
+
## Related packages
|
|
60
|
+
|
|
61
|
+
- [`@shadsapp/themes`](https://www.npmjs.com/package/@shadsapp/themes) — theme bundles
|
|
62
|
+
- [`@shadsapp/schema`](https://www.npmjs.com/package/@shadsapp/schema) — `theme.json` spec
|
|
63
|
+
- [`@shadsapp/mcp`](https://www.npmjs.com/package/@shadsapp/mcp) — MCP server for AI agents
|
|
64
|
+
|
|
65
|
+
## License
|
|
66
|
+
|
|
67
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@shadsapp/cli",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "CLI for installing and importing shads themes",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
@@ -8,15 +8,16 @@
|
|
|
8
8
|
"shads": "./dist/cli.js"
|
|
9
9
|
},
|
|
10
10
|
"files": [
|
|
11
|
-
"dist"
|
|
11
|
+
"dist",
|
|
12
|
+
"README.md"
|
|
12
13
|
],
|
|
13
14
|
"scripts": {
|
|
14
15
|
"build": "tsc -p tsconfig.json",
|
|
15
16
|
"typecheck": "tsc -p tsconfig.json --noEmit"
|
|
16
17
|
},
|
|
17
18
|
"dependencies": {
|
|
18
|
-
"@shadsapp/schema": "0.1.
|
|
19
|
-
"@shadsapp/themes": "0.1.
|
|
19
|
+
"@shadsapp/schema": "0.1.1",
|
|
20
|
+
"@shadsapp/themes": "0.1.1"
|
|
20
21
|
},
|
|
21
22
|
"publishConfig": {
|
|
22
23
|
"access": "public"
|