Skip to content

Commit 4eee614

Browse files
committed
docs: add install tracking route and installs table to docs
1 parent e48a2e7 commit 4eee614

3 files changed

Lines changed: 18 additions & 3 deletions

File tree

CLAUDE.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,13 +77,14 @@ pnpm db:migrate:remote # Apply migrations to remote D1
7777
| `/api/skills/:slug/rate` | api.skill-rate.ts | Session/Key |
7878
| `/api/skills/:slug/review` | api.skill-review.ts | Session/Key |
7979
| `/api/skills/:slug/favorite` | api.skill-favorite.ts | Session/Key |
80+
| `/api/skills/:slug/install` | api.skill-install.ts | Optional (API key or X-Device-Id) |
8081
| `/api/report` | api.usage-report.ts | Session/Key |
8182
| `/api/user/api-keys` | api.user-api-keys.ts | Session |
8283
| `/api/admin/seed` | api.admin.seed.ts | Admin secret |
8384

8485
## Database Tables (Drizzle schema)
8586

86-
`skills`, `ratings`, `reviews`, `favorites`, `usageStats`, `apiKeys`
87+
`skills`, `ratings`, `reviews`, `favorites`, `usageStats`, `apiKeys`, `installs`
8788
Plus Better Auth tables: `user`, `session`, `account`, `verification`
8889

8990
## Key Patterns

docs/codebase-summary.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ skillx/
6767
| `api.skill-rate.ts` | API | 100 | Create/update rating (0-10) |
6868
| `api.skill-review.ts` | API | 109 | Create/list reviews |
6969
| `api.skill-favorite.ts` | API | 74 | Add/remove favorites |
70+
| `api.skill-install.ts` | API | ? | Track skill install (fire-and-forget) |
7071
| `api.usage-report.ts` | API | 99 | Log skill execution outcomes |
7172
| `api.user-api-keys.ts` | API | 133 | Create/list/revoke API keys |
7273
| `api.admin.seed.ts` | API | 121 | Load demo seed data |
@@ -103,6 +104,7 @@ skillx/
103104
| `ratings` | id, skill_id, user_id, score, is_agent, timestamps | 0-10 scores |
104105
| `reviews` | id, skill_id, user_id, content, is_agent, created_at | Text feedback |
105106
| `favorites` | user_id, skill_id, created_at | Many-to-many bookmarks |
107+
| `installs` | id, skill_id, user_id, device_id, created_at | Install tracking (deduplicated per user/device) |
106108
| `usageStats` | id, skill_id, user_id, model, outcome, duration_ms, created_at | Execution tracking |
107109
| `apiKeys` | id, user_id, name, key_hash, key_prefix, last_used_at, revoked_at, created_at | API authentication |
108110

@@ -166,11 +168,11 @@ skillx/
166168
|------|-----|---------|
167169
| `index.ts` | - | Commander.js CLI entry + command registration |
168170
| `commands/search.ts` | 86 | `skillx search "..."` → API call → table output |
169-
| `commands/use.ts` | 78 | `skillx use skill1 skill2` → fetch SKILL.md, echo to stdout |
171+
| `commands/use.ts` | 78 | `skillx use skill1 skill2` → fetch SKILL.md, POST install, echo to stdout |
170172
| `commands/report.ts` | 90 | `skillx report` → POST usage metrics to API |
171173
| `commands/config.ts` | 91 | `skillx config set/get KEY VALUE` → local store |
172174
| `lib/api-client.ts` | 35 | HTTP client with API key auth |
173-
| `utils/config-store.ts` | - | conf package: ~/.skillx/config.json |
175+
| `utils/config-store.ts` | - | conf package: ~/.skillx/config.json, includes getDeviceId() |
174176

175177
**Usage:**
176178
```bash

docs/system-architecture.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,17 @@
8484
│ created_at │ │ revoked_at │
8585
└────────────────────────┘ │ created_at │
8686
└─────────────────────┘
87+
88+
┌────────────────────────┐
89+
│ INSTALLS │
90+
├────────────────────────┤
91+
│ id (PK) │
92+
│ skill_id (FK) │
93+
│ user_id (nullable) │
94+
│ device_id (nullable) │
95+
│ created_at │
96+
│ (dedup per user/device)│
97+
└────────────────────────┘
8798
```
8899

89100
**Indexes:**
@@ -269,6 +280,7 @@ Response:
269280
| POST | `/api/skills/:slug/rate` | Submit rating |
270281
| POST | `/api/skills/:slug/review` | Write review |
271282
| POST | `/api/skills/:slug/favorite` | Add/remove favorite |
283+
| POST | `/api/skills/:slug/install` | Track install (fire-and-forget) |
272284
| POST | `/api/report` | Report usage |
273285

274286
### User Endpoints (Session Only)

0 commit comments

Comments
 (0)