@eyeglass/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 +41 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# @eyeglass/cli
|
|
2
|
+
|
|
3
|
+
CLI for initializing [Eyeglass](https://github.com/donutboyband/eyeglass) in your project.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npx @eyeglass/cli init
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
This single command will:
|
|
12
|
+
|
|
13
|
+
1. **Install** `@eyeglass/inspector` as a dev dependency
|
|
14
|
+
2. **Create** `.claude/settings.json` with MCP server configuration
|
|
15
|
+
3. **Configure** your bundler (Vite, Next.js, CRA, or Remix)
|
|
16
|
+
|
|
17
|
+
## Options
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npx @eyeglass/cli init --dry-run # Preview changes without making them
|
|
21
|
+
npx @eyeglass/cli init --skip-install # Skip installing @eyeglass/inspector
|
|
22
|
+
npx @eyeglass/cli help # Show help
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Supported Frameworks
|
|
26
|
+
|
|
27
|
+
| Framework | Auto-Detection | Component Names | File Paths |
|
|
28
|
+
|-----------|:--------------:|:---------------:|:----------:|
|
|
29
|
+
| Vite | ✓ | ✓ | ✓ |
|
|
30
|
+
| Next.js | ✓ | ✓ | ✓ |
|
|
31
|
+
| CRA | ✓ | ✓ | ✓ |
|
|
32
|
+
| Remix | ✓ | ✓ | ✓ |
|
|
33
|
+
|
|
34
|
+
## After Setup
|
|
35
|
+
|
|
36
|
+
1. Start your dev server (`npm run dev`)
|
|
37
|
+
2. Run `claude` in your project directory
|
|
38
|
+
3. Tell Claude: `watch eyeglass` or `eg`
|
|
39
|
+
4. Select elements in your browser and submit requests!
|
|
40
|
+
|
|
41
|
+
See the [main repo](https://github.com/donutboyband/eyeglass) for full documentation.
|