petdex-cc 0.1.5 → 0.1.7
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/LICENSE +21 -21
- package/README.md +287 -112
- package/README_CN.md +283 -110
- package/dist/bin/cli.js +13 -13
- package/dist/src/cli/install.js +1 -1
- package/dist/src/cli/install.js.map +1 -1
- package/dist/src/cli/postinstall.js +28 -11
- package/dist/src/cli/postinstall.js.map +1 -1
- package/dist/src/hooks/write-scripts.js +21 -21
- package/dist/src/main/index.js +1 -1
- package/dist/src/main/index.js.map +1 -1
- package/dist/src/main/tray.js +1 -1
- package/dist/src/main/tray.js.map +1 -1
- package/dist/src/renderer/index.html +264 -264
- package/dist/src/renderer/wander.d.ts +8 -0
- package/dist/src/renderer/wander.d.ts.map +1 -0
- package/dist/src/renderer/wander.js +137 -0
- package/dist/src/renderer/wander.js.map +1 -0
- package/package.json +12 -2
- package/src/hooks/bridge.ps1 +11 -11
- package/src/hooks/bridge.sh +9 -9
package/LICENSE
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2026 devnomad-byte
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
11
|
-
|
|
12
|
-
The above copyright notice and this permission notice shall be included in all
|
|
13
|
-
copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
-
SOFTWARE.
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 devnomad-byte
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,44 +1,114 @@
|
|
|
1
1
|
<div align="center">
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
<br />
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
# ✨ petdex-cc ✨
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
### Desktop Pet Companion for Claude Code
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
[]()
|
|
11
|
-
[]()
|
|
12
|
-
[]()
|
|
13
|
-
[](https://petdex.crafter.run)
|
|
9
|
+
**Animated pets that live on your screen and react to your coding in real-time**
|
|
14
10
|
|
|
15
|
-
|
|
11
|
+
<br />
|
|
12
|
+
|
|
13
|
+
[](https://www.npmjs.com/package/petdex-cc)
|
|
14
|
+
[]()
|
|
15
|
+
[]()
|
|
16
|
+
[](./LICENSE)
|
|
17
|
+
[](https://petdex.crafter.run)
|
|
18
|
+
[](https://github.com/devnomad-byte/petdex-cc/stargazers)
|
|
19
|
+
|
|
20
|
+
<br />
|
|
21
|
+
|
|
22
|
+
[🌐 English](./README.md) · [🇨🇳 中文文档](./README_CN.md)
|
|
16
23
|
|
|
17
24
|
</div>
|
|
18
25
|
|
|
19
26
|
---
|
|
20
27
|
|
|
21
|
-
|
|
28
|
+
<div align="center">
|
|
29
|
+
|
|
30
|
+
<img src="./boba.gif" alt="petdex-cc demo" width="600" />
|
|
31
|
+
|
|
32
|
+
</div>
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
<div align="center">
|
|
37
|
+
|
|
38
|
+
🐾 **One command to bring your pet to life** 🐾
|
|
39
|
+
|
|
40
|
+
</div>
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
npx petdex-cc install boba
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
<div align="center">
|
|
47
|
+
<i>Your pet appears on the desktop and starts reacting to your Claude Code in real-time 🎉</i>
|
|
48
|
+
</div>
|
|
49
|
+
|
|
50
|
+
---
|
|
22
51
|
|
|
23
|
-
|
|
52
|
+
## 🌟 Why petdex-cc?
|
|
24
53
|
|
|
25
54
|
> **How is this different from `npx petdex install`?**
|
|
26
|
-
>
|
|
55
|
+
>
|
|
56
|
+
> The original `petdex` gives you a basic pet. `petdex-cc` adds a deep **Claude Code integration layer** — hooks into your coding workflow, a level progression system, AI-generated speech, time-aware greetings, and interactive effects. Your pet isn't just decoration — it *lives* in your coding session.
|
|
57
|
+
|
|
58
|
+
<table>
|
|
59
|
+
<tr>
|
|
60
|
+
<td width="50%">
|
|
61
|
+
|
|
62
|
+
🎯 **Real-time Reactions**
|
|
63
|
+
|
|
64
|
+
Pet changes animation as you read, edit, run commands, complete tasks, or hit errors
|
|
65
|
+
|
|
66
|
+
</td>
|
|
67
|
+
<td width="50%">
|
|
68
|
+
|
|
69
|
+
🏆 **8-Level Progression**
|
|
70
|
+
|
|
71
|
+
Byte → Process → Thread → Module → Kernel → Neural → Quantum → Singularity
|
|
72
|
+
|
|
73
|
+
</td>
|
|
74
|
+
</tr>
|
|
75
|
+
<tr>
|
|
76
|
+
<td width="50%">
|
|
27
77
|
|
|
28
|
-
|
|
78
|
+
🤖 **AI Speech Bubbles**
|
|
29
79
|
|
|
30
|
-
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
80
|
+
Context-aware dialogue generated by Claude, or built-in preset lines
|
|
81
|
+
|
|
82
|
+
</td>
|
|
83
|
+
<td width="50%">
|
|
84
|
+
|
|
85
|
+
🕐 **Time-Aware Greetings**
|
|
86
|
+
|
|
87
|
+
Morning, lunch, afternoon, evening, night, and midnight messages in Chinese
|
|
88
|
+
|
|
89
|
+
</td>
|
|
90
|
+
</tr>
|
|
91
|
+
<tr>
|
|
92
|
+
<td width="50%">
|
|
93
|
+
|
|
94
|
+
🎮 **Interactive**
|
|
95
|
+
|
|
96
|
+
Drag pet anywhere, right-click menu, rapid-click easter egg
|
|
97
|
+
|
|
98
|
+
</td>
|
|
99
|
+
<td width="50%">
|
|
100
|
+
|
|
101
|
+
💾 **State Persistence**
|
|
102
|
+
|
|
103
|
+
Level and event count survive restarts (HMAC-signed, tamper-resistant)
|
|
104
|
+
|
|
105
|
+
</td>
|
|
106
|
+
</tr>
|
|
107
|
+
</table>
|
|
38
108
|
|
|
39
109
|
---
|
|
40
110
|
|
|
41
|
-
## Quick Start
|
|
111
|
+
## 🚀 Quick Start
|
|
42
112
|
|
|
43
113
|
### Prerequisites
|
|
44
114
|
|
|
@@ -55,72 +125,158 @@ petdex-cc brings **animated desktop pets** to your Claude Code workflow. Pick an
|
|
|
55
125
|
npx petdex-cc install boba
|
|
56
126
|
```
|
|
57
127
|
|
|
58
|
-
|
|
128
|
+
### 🐾 Popular Pets
|
|
129
|
+
|
|
130
|
+
<table>
|
|
131
|
+
<tr>
|
|
132
|
+
<th>Slug</th>
|
|
133
|
+
<th>Name</th>
|
|
134
|
+
<th>Description</th>
|
|
135
|
+
</tr>
|
|
136
|
+
<tr>
|
|
137
|
+
<td><code>boba</code></td>
|
|
138
|
+
<td>🦦 Boba</td>
|
|
139
|
+
<td>Tiny otter sipping bubble tea</td>
|
|
140
|
+
</tr>
|
|
141
|
+
<tr>
|
|
142
|
+
<td><code>doraemon</code></td>
|
|
143
|
+
<td>🐱 Doraemon</td>
|
|
144
|
+
<td>Blue robot-cat from the future</td>
|
|
145
|
+
</tr>
|
|
146
|
+
<tr>
|
|
147
|
+
<td><code>noir-webling</code></td>
|
|
148
|
+
<td>🕷️ Noir Webling</td>
|
|
149
|
+
<td>Monochrome spider detective</td>
|
|
150
|
+
</tr>
|
|
151
|
+
<tr>
|
|
152
|
+
<td><code>ikun-hoops</code></td>
|
|
153
|
+
<td>🏀 IKUN Hoops</td>
|
|
154
|
+
<td>Hoodie chick with a basketball</td>
|
|
155
|
+
</tr>
|
|
156
|
+
<tr>
|
|
157
|
+
<td><code>ddo-zvzo</code></td>
|
|
158
|
+
<td>😎 ddo-zvzo</td>
|
|
159
|
+
<td>Purple mascot with sunglasses</td>
|
|
160
|
+
</tr>
|
|
161
|
+
<tr>
|
|
162
|
+
<td><code>mochi</code></td>
|
|
163
|
+
<td>🐱 Mochi</td>
|
|
164
|
+
<td>Orange-and-white chibi cat</td>
|
|
165
|
+
</tr>
|
|
166
|
+
</table>
|
|
167
|
+
|
|
168
|
+
> Browse all 1,569+ pets at [**petdex.crafter.run**](https://petdex.crafter.run/) 🎨
|
|
169
|
+
|
|
170
|
+
<details>
|
|
171
|
+
<summary>🌏 For users in China (国内用户加速)</summary>
|
|
172
|
+
|
|
173
|
+
<br />
|
|
174
|
+
|
|
175
|
+
The first install downloads the Electron binary (~100MB) from GitHub, which can be slow or blocked. Configure npm to use China mirrors before installing:
|
|
59
176
|
|
|
60
|
-
|
|
177
|
+
```bash
|
|
178
|
+
# Set npm registry to China mirror
|
|
179
|
+
npm config set registry https://registry.npmmirror.com
|
|
61
180
|
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
181
|
+
# Set Electron download mirror
|
|
182
|
+
npm config set electron_mirror https://npmmirror.com/mirrors/electron/
|
|
183
|
+
|
|
184
|
+
# Then install
|
|
185
|
+
npx petdex-cc install boba
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
These settings are persistent — you only need to run them once.
|
|
189
|
+
|
|
190
|
+
</details>
|
|
191
|
+
|
|
192
|
+
<details>
|
|
193
|
+
<summary>🔧 Troubleshooting</summary>
|
|
194
|
+
|
|
195
|
+
<br />
|
|
196
|
+
|
|
197
|
+
**`ERR_MODULE_NOT_FOUND: Cannot find package '@electron/remote'`**
|
|
198
|
+
|
|
199
|
+
This was a bug in versions before 0.1.6. Update to the latest version:
|
|
200
|
+
|
|
201
|
+
```bash
|
|
202
|
+
npm uninstall -g petdex-cc
|
|
203
|
+
npx petdex-cc install boba
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
**`EPERM` / `EBUSY` errors**
|
|
207
|
+
|
|
208
|
+
The pet process is still running and locking files. Stop it first:
|
|
209
|
+
|
|
210
|
+
```bash
|
|
211
|
+
# Windows PowerShell
|
|
212
|
+
Stop-Process -Name electron -Force -ErrorAction SilentlyContinue
|
|
70
213
|
|
|
71
|
-
|
|
214
|
+
# macOS / Linux
|
|
215
|
+
pkill -f electron
|
|
216
|
+
|
|
217
|
+
# Then reinstall
|
|
218
|
+
npx petdex-cc install boba
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
**`ECONNRESET` / `ETIMEDOUT` during install**
|
|
222
|
+
|
|
223
|
+
Electron cannot download from GitHub. Set the mirror (see "For users in China" above).
|
|
224
|
+
|
|
225
|
+
</details>
|
|
72
226
|
|
|
73
227
|
---
|
|
74
228
|
|
|
75
|
-
## What Your Pet Does
|
|
229
|
+
## 🎬 What Your Pet Does
|
|
76
230
|
|
|
77
231
|
Every Claude Code action triggers a pet reaction:
|
|
78
232
|
|
|
79
|
-
| Claude Code
|
|
233
|
+
| Claude Code Event | Pet Animation | Speech Bubble |
|
|
80
234
|
|---|---|---|
|
|
81
|
-
| Session starts | Waving | "Let's get to work!" |
|
|
82
|
-
| Reading a file | Review | "Reading filename..." |
|
|
83
|
-
| Editing a file | Idle | "Edited filename" |
|
|
84
|
-
| Running a command | Running | "Running command..." |
|
|
85
|
-
| Searching (Glob/Grep) | Waiting | "Searching..." |
|
|
86
|
-
| Tool fails | Failed | "Oops, something went wrong" + AI encouragement |
|
|
87
|
-
| Task completes | Jumping | "Task complete!" + AI celebration |
|
|
88
|
-
| Claude stops | Jumping | "Task complete!" (60% AI speech) |
|
|
89
|
-
| Claude errors | Failed | Error message + AI comfort |
|
|
90
|
-
| Idle (10+ min) | Waving | Time-aware Chinese greeting |
|
|
91
|
-
| Level up | Current state | "Level up! Kernel!" + all effects activate |
|
|
92
|
-
|
|
93
|
-
### Pet
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
235
|
+
| 🟢 Session starts | Waving 👋 | "Let's get to work!" |
|
|
236
|
+
| 📖 Reading a file | Review 🔍 | "Reading filename..." |
|
|
237
|
+
| ✏️ Editing a file | Idle | "Edited filename" |
|
|
238
|
+
| ▶️ Running a command | Running 🏃 | "Running command..." |
|
|
239
|
+
| 🔍 Searching (Glob/Grep) | Waiting ⏳ | "Searching..." |
|
|
240
|
+
| ❌ Tool fails | Failed 😢 | "Oops, something went wrong" + AI encouragement |
|
|
241
|
+
| ✅ Task completes | Jumping 🎉 | "Task complete!" + AI celebration |
|
|
242
|
+
| 🛑 Claude stops | Jumping | "Task complete!" (60% AI speech) |
|
|
243
|
+
| ⚠️ Claude errors | Failed | Error message + AI comfort |
|
|
244
|
+
| 💤 Idle (10+ min) | Waving | Time-aware Chinese greeting |
|
|
245
|
+
| ⬆️ Level up | Current state | "Level up! Kernel!" + all effects activate |
|
|
246
|
+
|
|
247
|
+
### 🎮 Pet Interactions
|
|
248
|
+
|
|
249
|
+
| Action | Effect |
|
|
250
|
+
|---|---|
|
|
251
|
+
| **Drag** | Click and drag to move your pet anywhere |
|
|
252
|
+
| **Right-click** | Context menu: Show/Hide, About, Quit |
|
|
253
|
+
| **System tray** | Right-click tray icon for menu |
|
|
254
|
+
| **Easter egg** | Rapidly click for escalating reactions (2→4→6→9→12→15 clicks) |
|
|
99
255
|
|
|
100
256
|
---
|
|
101
257
|
|
|
102
|
-
## Level System
|
|
258
|
+
## 🏆 Level System
|
|
103
259
|
|
|
104
|
-
Your pet levels up based on cumulative Claude Code events
|
|
260
|
+
Your pet levels up based on cumulative Claude Code events:
|
|
105
261
|
|
|
106
|
-
| Lv | Name | Events |
|
|
262
|
+
| Lv | Name | Events | | Effect |
|
|
107
263
|
|:---:|---|---:|---|---|
|
|
108
|
-
| 1 | **Byte** | 0 |
|
|
109
|
-
| 2 | **Process** | 50 |
|
|
110
|
-
| 3 | **Thread** | 200 |
|
|
111
|
-
| 4 | **Module** | 500 |
|
|
112
|
-
| 5 | **Kernel** | 1,000 |
|
|
113
|
-
| 6 | **Neural** | 2,000 |
|
|
114
|
-
| 7 | **Quantum** | 5,000 |
|
|
115
|
-
| 8 | **Singularity** | 10,000 |
|
|
264
|
+
| 1 | **Byte** | 0 | 🟣 Base pet |
|
|
265
|
+
| 2 | **Process** | 50 | 🟢 Breathing glow |
|
|
266
|
+
| 3 | **Thread** | 200 | 🔵 Rotating aura ring |
|
|
267
|
+
| 4 | **Module** | 500 | 🟣 Enhanced aura |
|
|
268
|
+
| 5 | **Kernel** | 1,000 | 🟡 Floating light particles |
|
|
269
|
+
| 6 | **Neural** | 2,000 | 🩷 Particle storm |
|
|
270
|
+
| 7 | **Quantum** | 5,000 | 🩵 Energy field |
|
|
271
|
+
| 8 | **Singularity** | 10,000 | 🌟 Golden halo + all effects |
|
|
116
272
|
|
|
117
273
|
---
|
|
118
274
|
|
|
119
|
-
## AI Speech
|
|
275
|
+
## 🤖 AI Speech
|
|
120
276
|
|
|
121
|
-
When an Anthropic API key is available (auto-detected from Claude Code settings
|
|
277
|
+
When an Anthropic API key is available (auto-detected from Claude Code settings), your pet generates **context-aware speech**:
|
|
122
278
|
|
|
123
|
-
| Scene | Trigger | Example AI
|
|
279
|
+
| Scene | Trigger | Example AI Response |
|
|
124
280
|
|---|---|---|
|
|
125
281
|
| `task_complete` | Task finishes | "做得好！继续加油！" |
|
|
126
282
|
| `error` | Tool fails | "别担心，bugs难免的~" |
|
|
@@ -129,11 +285,11 @@ When an Anthropic API key is available (auto-detected from Claude Code settings
|
|
|
129
285
|
|
|
130
286
|
- **2-minute cooldown** between AI calls (level-ups bypass this)
|
|
131
287
|
- **5-second timeout** — falls back to preset lines if API is slow
|
|
132
|
-
- **No API key?** Built-in preset lines work great — 7 task
|
|
288
|
+
- **No API key?** Built-in preset lines work great — 7 task, 5 error, 5 idle, 4 level-up lines
|
|
133
289
|
|
|
134
290
|
---
|
|
135
291
|
|
|
136
|
-
## CLI Reference
|
|
292
|
+
## 📋 CLI Reference
|
|
137
293
|
|
|
138
294
|
```bash
|
|
139
295
|
petdex-cc install <slug> # Download pet, configure hooks, and launch
|
|
@@ -146,7 +302,10 @@ petdex-cc uninstall # Remove hooks, stop pet, delete all data
|
|
|
146
302
|
petdex-cc config [options] # Configure settings
|
|
147
303
|
```
|
|
148
304
|
|
|
149
|
-
|
|
305
|
+
<details>
|
|
306
|
+
<summary>⚙️ Config options</summary>
|
|
307
|
+
|
|
308
|
+
<br />
|
|
150
309
|
|
|
151
310
|
```bash
|
|
152
311
|
petdex-cc config --api-key <key> # Anthropic API key for AI speech
|
|
@@ -156,9 +315,11 @@ petdex-cc config --cooldown <minutes> # AI call cooldown (default: 2)
|
|
|
156
315
|
|
|
157
316
|
> API credentials are auto-detected from `~/.claude/settings.json` — most users don't need manual config.
|
|
158
317
|
|
|
318
|
+
</details>
|
|
319
|
+
|
|
159
320
|
---
|
|
160
321
|
|
|
161
|
-
## Architecture
|
|
322
|
+
## 🏗️ Architecture
|
|
162
323
|
|
|
163
324
|
```
|
|
164
325
|
┌─────────────────────────────────────────────────┐
|
|
@@ -198,25 +359,10 @@ petdex-cc config --cooldown <minutes> # AI call cooldown (default: 2)
|
|
|
198
359
|
└──────────────────┘
|
|
199
360
|
```
|
|
200
361
|
|
|
201
|
-
|
|
362
|
+
<details>
|
|
363
|
+
<summary>📁 Project structure</summary>
|
|
202
364
|
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
```bash
|
|
206
|
-
git clone https://github.com/devnomad-byte/petdex-cc.git
|
|
207
|
-
cd petdex-cc
|
|
208
|
-
npm install
|
|
209
|
-
npm run build
|
|
210
|
-
|
|
211
|
-
# Run in dev mode
|
|
212
|
-
npx electron .
|
|
213
|
-
|
|
214
|
-
# Install globally for CLI
|
|
215
|
-
npm link
|
|
216
|
-
petdex-cc install boba
|
|
217
|
-
```
|
|
218
|
-
|
|
219
|
-
### Project structure
|
|
365
|
+
<br />
|
|
220
366
|
|
|
221
367
|
```
|
|
222
368
|
petdex-cc/
|
|
@@ -239,21 +385,38 @@ petdex-cc/
|
|
|
239
385
|
│ │ └── context-menu.ts Right-click menu
|
|
240
386
|
│ ├── cli/ CLI command implementations
|
|
241
387
|
│ ├── hooks/ Claude Code hooks (register/unregister)
|
|
242
|
-
│ │ ├── register.ts Writes to ~/.claude/settings.json
|
|
243
|
-
│ │ ├── write-scripts.ts Cross-platform bridge scripts
|
|
244
|
-
│ │ ├── bridge.ps1 Windows PowerShell bridge
|
|
245
|
-
│ │ └── bridge.sh Unix bash bridge
|
|
246
388
|
│ ├── petdex-api/ Petdex registry client
|
|
247
|
-
│ │ ├── client.ts Manifest fetch + slug lookup
|
|
248
|
-
│ │ └── download.ts Streaming download with progress
|
|
249
389
|
│ └── shared/ Shared types and constants
|
|
250
390
|
```
|
|
251
391
|
|
|
392
|
+
</details>
|
|
393
|
+
|
|
394
|
+
---
|
|
395
|
+
|
|
396
|
+
## 🔧 Developer Setup
|
|
397
|
+
|
|
398
|
+
```bash
|
|
399
|
+
git clone https://github.com/devnomad-byte/petdex-cc.git
|
|
400
|
+
cd petdex-cc
|
|
401
|
+
npm install
|
|
402
|
+
npm run build
|
|
403
|
+
|
|
404
|
+
# Run in dev mode
|
|
405
|
+
npx electron .
|
|
406
|
+
|
|
407
|
+
# Install globally for CLI
|
|
408
|
+
npm link
|
|
409
|
+
petdex-cc install boba
|
|
410
|
+
```
|
|
411
|
+
|
|
252
412
|
---
|
|
253
413
|
|
|
254
|
-
## Configuration Reference
|
|
414
|
+
## ⚙️ Configuration Reference
|
|
415
|
+
|
|
416
|
+
<details>
|
|
417
|
+
<summary>Auto-detected settings</summary>
|
|
255
418
|
|
|
256
|
-
|
|
419
|
+
<br />
|
|
257
420
|
|
|
258
421
|
petdex-cc reads these from `~/.claude/settings.json` automatically:
|
|
259
422
|
|
|
@@ -262,15 +425,12 @@ petdex-cc reads these from `~/.claude/settings.json` automatically:
|
|
|
262
425
|
| `ANTHROPIC_AUTH_TOKEN` | API key for AI speech |
|
|
263
426
|
| `ANTHROPIC_BASE_URL` | API endpoint for AI speech |
|
|
264
427
|
|
|
265
|
-
|
|
428
|
+
</details>
|
|
266
429
|
|
|
267
|
-
|
|
430
|
+
<details>
|
|
431
|
+
<summary>Data locations</summary>
|
|
268
432
|
|
|
269
|
-
|
|
270
|
-
petdex-cc config --api-key <key> --api-base-url <url> --cooldown 2
|
|
271
|
-
```
|
|
272
|
-
|
|
273
|
-
### Data locations
|
|
433
|
+
<br />
|
|
274
434
|
|
|
275
435
|
| Path | Contents |
|
|
276
436
|
|---|---|
|
|
@@ -280,11 +440,11 @@ petdex-cc config --api-key <key> --api-base-url <url> --cooldown 2
|
|
|
280
440
|
| `~/.petdex-cc/hooks/` | Bridge scripts |
|
|
281
441
|
| `~/.petdex-cc/config.json` | User config (API key, cooldown) |
|
|
282
442
|
|
|
283
|
-
|
|
443
|
+
</details>
|
|
284
444
|
|
|
285
|
-
|
|
445
|
+
---
|
|
286
446
|
|
|
287
|
-
|
|
447
|
+
## 🪝 Hooks Reference
|
|
288
448
|
|
|
289
449
|
| Hook | Matcher | What triggers it |
|
|
290
450
|
|---|---|---|
|
|
@@ -299,13 +459,28 @@ petdex-cc registers these hooks in `~/.claude/settings.json`:
|
|
|
299
459
|
|
|
300
460
|
---
|
|
301
461
|
|
|
302
|
-
|
|
462
|
+
<div align="center">
|
|
463
|
+
|
|
464
|
+
## ⭐ Star History
|
|
465
|
+
|
|
466
|
+
<a href="https://www.star-history.com/?repos=devnomad-byte%2Fpetdex-cc&type=date&legend=top-left">
|
|
467
|
+
<picture>
|
|
468
|
+
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/chart?repos=devnomad-byte/petdex-cc&type=date&theme=dark&legend=top-left" />
|
|
469
|
+
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/chart?repos=devnomad-byte/petdex-cc&type=date&legend=top-left" />
|
|
470
|
+
<img alt="Star History Chart" src="https://api.star-history.com/chart?repos=devnomad-byte/petdex-cc&type=date&legend=top-left" />
|
|
471
|
+
</picture>
|
|
472
|
+
</a>
|
|
473
|
+
|
|
474
|
+
<br />
|
|
475
|
+
|
|
476
|
+
## 📄 License
|
|
303
477
|
|
|
304
478
|
[MIT](./LICENSE)
|
|
305
479
|
|
|
306
|
-
|
|
480
|
+
<br />
|
|
481
|
+
|
|
482
|
+
Built with 💜 for the [Claude Code](https://docs.anthropic.com/en/docs/claude-code) community
|
|
483
|
+
|
|
484
|
+
Pets powered by [**Petdex**](https://petdex.crafter.run/) · 1,569+ community pets and growing
|
|
307
485
|
|
|
308
|
-
<div align="center">
|
|
309
|
-
<sub>Built for the <a href="https://docs.anthropic.com/en/docs/claude-code">Claude Code</a> community</sub><br />
|
|
310
|
-
<sub>Pets powered by <a href="https://petdex.crafter.run/">Petdex</a></sub>
|
|
311
486
|
</div>
|