skilldb 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,136 @@
+# skilldb
+
+CLI and TypeScript SDK for [SkillDB](https://skilldb.dev) — discover, install, and manage AI agent skills from the terminal.
+
+## Quick Start
+
+```bash
+# Search for skills
+npx skilldb search "code review"
+
+# Install a skill pack
+npx skilldb add software-skills
+
+# Initialize SkillDB in your project
+npx skilldb init
+```
+
+## Install
+
+```bash
+npm install -g skilldb
+```
+
+Or use `npx skilldb` without installing.
+
+## CLI Commands
+
+### `skilldb init`
+
+Detect your IDE (Claude Code, Cursor, or Codex CLI), create a `.skilldb/` cache directory, and add an integration snippet to your config file.
+
+```bash
+skilldb init
+```
+
+### `skilldb search <query>`
+
+Search skills by keyword.
+
+```bash
+skilldb search "debugging"
+skilldb search "api design" --category "Technology & Engineering"
+skilldb search "testing" --limit 10
+```
+
+### `skilldb list`
+
+List available categories, packs, and skills.
+
+```bash
+skilldb list
+skilldb list --category "Autonomous Agents"
+skilldb list --pack software-skills
+```
+
+### `skilldb add <pack>`
+
+Download a skill pack to your local `.skilldb/skills/` cache. Idempotent — skips already-cached skills.
+
+```bash
+skilldb add software-skills
+skilldb add autonomous-agent-skills
+```
+
+### `skilldb info <id>`
+
+Show metadata and a content preview for a single skill.
+
+```bash
+skilldb info software-skills/code-review
+skilldb info autonomous-agent-skills/task-decomposition
+```
+
+### `skilldb login`
+
+Save your API key for authenticated access (required for full skill content).
+
+```bash
+skilldb login
+```
+
+Get your API key at [skilldb.dev/api-access](https://skilldb.dev/api-access).
+
+## SDK Usage
+
+```typescript
+import { createClient } from 'skilldb';
+
+const db = createClient(); // auto-loads key from env/config
+
+// Search
+const results = await db.search('code review');
+console.log(results.skills);
+
+// Get a single skill
+const skill = await db.get('software-skills/code-review.md');
+console.log(skill.title, skill.description);
+
+// List with filters
+const listing = await db.list({ category: 'Autonomous Agents', limit: 10 });
+```
+
+## Authentication
+
+The SDK and CLI resolve your API key in this order:
+
+1. `SKILLDB_API_KEY` environment variable (CI-friendly)
+2. `.skilldbrc` in project root (project-specific)
+3. `~/.skilldbrc` in home directory (user-wide)
+
+Browsing and searching works without authentication. Full skill content requires a Pro or Enterprise key.
+
+## Local Cache
+
+After running `skilldb add`, skills are cached locally for zero-latency reads:
+
+```
+.skilldb/
+  manifest.json
+  skills/
+    software-skills/
+      code-review.md
+      debugging.md
+    autonomous-agent-skills/
+      task-decomposition.md
+```
+
+Add `.skilldb/` and `.skilldbrc` to your `.gitignore` (handled automatically by `skilldb init`).
+
+## Requirements
+
+- Node.js >= 18
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skilldb",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "SDK and CLI for SkillDB — discover, install, and manage AI agent skills",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -17,7 +17,8 @@
     "skilldb": "./dist/cli.js"
   },
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
   "scripts": {
     "build": "tsup",