skilld 0.2.0 → 0.3.0

package/README.md

@@ -2,25 +2,25 @@
 
 [![npm version](https://img.shields.io/npm/v/skilld?color=yellow)](https://npmjs.com/package/skilld)
 [![npm downloads](https://img.shields.io/npm/dm/skilld?color=yellow)](https://npm.chart.dev/skilld)
-[![license](https://img.shields.io/github/license/harlan-zw/skilld?color=yellow)](https://github.com/harlan-zw/skilld/blob/main/LICENSE)
+[![license](https://img.shields.io/npm/l/skilld?color=yellow)](https://github.com/harlan-zw/skilld/blob/main/LICENSE)
 
-> Skilld gives your AI agent skills for your npm dependencies, generated from versioned docs, dist files and GitHub data.
+> Expert SKILL.md knowledge for your NPM dependencies.
 
 ## Why?
 
-Agents already know how most packages work from training data. Skills should focus on what they *don't* know and push them to follow best practices. Without this:
+Agents suck at following latest conventions beyond their [reliable knowledge cut-off](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison). They shoot themselves in the foot
+with new APIs and conventions, and they don't know what they don't know.
 
-- **Generic patterns** - AI uses common approaches instead of package-specific conventions
-- **Missed best practices** - Optimal patterns go unused because the AI defaults to "good enough"
-- **Version drift** - Training data lags behind latest APIs and deprecations
+[Agent Skills](https://agentskills.io/home) help us solve this by distilling the most important patterns and conventions for a package into a single SKILL.md file.
+Getting skills for our packages either involves the maintainer (or ourselves) taking on the maintenance burden and surfacing them or using skill sharing
+sites like [skills.sh](https://skills.sh/).
 
-skilld generates skills from the package's *actual* documentation using your existing agent. Works with any public npm package, no author opt-in needed.
+While these are great for generic skills, they aren't good for NPM skills:
+- No version-awareness, high maintenance burden to keep up with new releases and deprecations.
+- Non-optimized context windows, prompt injection risks, missing references.
+- Community-sourced skills leak personal opinions and biases. Maintainers are out of the loop, and may not even know about them.
 
-```
-npm install vueuse → skilld add vueuse → AI knows current vueuse API
-```
-
-Compatible with [skills-npm](https://github.com/antfu/skills-npm)—if a package ships a `skills/` directory, skilld uses it directly. Generation is the fallback.
+Skilld leverages maintainers existing effort. Maintainers write great docs for us, we generate our own local skills optimized for our models and codebase from them.
 
 <p align="center">
 <table>
@@ -34,20 +34,42 @@ Compatible with [skills-npm](https://github.com/antfu/skills-npm)—if a package
 
 ## Features
 
-- 🤖 **Agent-powered** - Uses your existing LLM to generate SKILL.md for your key dependencies; works with any coding agent
-- 🎯 **Best practices first** - Token-optimized output focused on non-obvious patterns and conventions, not generic knowledge
-- 🔗 **Context-aware** - Generation adapts to your preferences and accepts custom prompts
-- ✏️ **You own it** - Skills live in your project, easy to customize; sync new package versions with zero config
-- 🛡️ **Sanitized content** - All fetched markdown is sanitized against known injection patterns (zero-width chars, HTML injection, entity encoding, directive lines) before reaching your agent
-- 🚀 **Zero friction** - Works with any public npm package, no author opt-in; respects `llms.txt` and shipped `skills/` when available
+- 🌍 **Full Context SKILL.md** - Generates with the repo code, docs, releases, issues, discussions
+- 🤖 **BYO Agent** - Generate SKILL.md with or without an LLM
+- 📚 **Customizable** - `Best practices`, `LLM Gaps`, `Doc Map` or your own prompts
+- 🔍 **Semantic Search** - Token-optimized search via [retriv](https://github.com/harlan-zw/retriv)
+- 🎯 **Safe** - Prompt injection sanitization, version-aware output
+- 🤝 **Ecosystem** - [skills-npm](https://github.com/antfu/skills-npm) and `/llms.txt` support
+
+## Quick Start
+
+Run skilld in a project to generate skills for your dependencies through a simple interactive wizard:
+
+```bash
+npx skilld
+```
+
+If you need to re-configure skilld, just run `npx skilld config` to update your agent, model, or preferences.
+
+### Tips
+
+- **Be selective** — only add skills for packages your agent already struggles with or that you're actively debugging. Not every dependency needs a skill.
+- **LLM enhancement is optional** — skilld generates a useful SKILL.md without any LLM, but enhancing with one makes them significantly better. This costs tokens, so be mindful.
+- **Multi-agent support** — if you switch between agents (e.g. Claude Code and Gemini CLI), run `skilld install --agent gemini-cli` to sync your existing skills to the other agent. The doc cache is shared, so nothing is re-downloaded.
 
 ## Installation
 
+If you'd like to install skilld and track the lock file references, add it as a dev dependency:
+
 ```bash
-pnpm add -g skilld
+npm install -D skilld
+# or
+yarn add -D skilld
+# or
+pnpm add -D skilld
 ```
 
-## Automatic Updates
+### Automatic Updates
 
 Add to `package.json` to keep skills fresh on install:
 
@@ -59,8 +81,6 @@ Add to `package.json` to keep skills fresh on install:
 }
 ```
 
-skilld fast-paths unchanged versions—only regenerates when minor/major versions bump.
-
 ## CLI Usage
 
 ```bash
@@ -68,27 +88,30 @@ skilld fast-paths unchanged versions—only regenerates when minor/major version
 skilld
 
 # Add skills for specific package(s)
-skilld add vueuse
 skilld add vue nuxt pinia
 
 # Update outdated skills
 skilld update
-skilld update vue
+skilld update tailwindcss
 
 # Search docs across installed skills
 skilld search "useFetch options" -p nuxt
 
 # Target a specific agent
-skilld add vueuse --agent cursor
+skilld add react --agent cursor
 
 # Install globally to ~/.claude/skills
-skilld add vueuse --global
+skilld add zod --global
 
 # Skip prompts
-skilld add vueuse --yes
+skilld add drizzle-orm --yes
+
+# Check skill info
+skilld info
 
-# Check skill status
-skilld status
+# List installed skills
+skilld list
+skilld list --json
 
 # Manage settings
 skilld config
@@ -102,11 +125,13 @@ skilld config
 | `skilld add <pkg...>` | Add skills for package(s), space or comma-separated |
 | `skilld update [pkg]` | Update outdated skills (all or specific) |
 | `skilld search <query>` | Search indexed docs (`-p` to filter by package) |
-| `skilld status` | Show skill status across agents |
-| `skilld config` | Configure agent, model, preferences |
-| `skilld install` | Restore references from lockfile |
-| `skilld remove` | Remove installed skills |
-| `skilld uninstall` | Remove all skilld data |
+| `skilld list`           | List installed skills (`--json` for machine-readable output) |
+| `skilld info`           | Show skill info and config |
+| `skilld config`         | Configure agent, model, preferences |
+| `skilld install`        | Restore references from lockfile |
+| `skilld remove`         | Remove installed skills |
+| `skilld uninstall`      | Remove all skilld data |
+| `skilld cache`          | Cache management (clean expired LLM cache entries) |
 
 ### CLI Options
 
@@ -116,87 +141,16 @@ skilld config
 | `--agent` | `-a` | auto-detect | Target specific agent (claude-code, cursor, etc.) |
 | `--yes` | `-y` | `false` | Skip prompts, use defaults |
 | `--force` | `-f` | `false` | Ignore all caches, re-fetch docs and regenerate |
-| `--prepare` | | `false` | Non-interactive sync for prepare hook (outdated only) |
-| `--background` | `-b` | `false` | Run `--prepare` in a detached background process |
-
-## How It Works
-
-```
-Package name → Resolve docs → Fetch → Generate → Install
-```
-
-1. **Resolve** - Looks up npm registry for homepage, repository URL
-2. **Fetch** - Tries versioned git docs → GitHub README → llms.txt (via ungh)
-3. **Generate** - Your agent creates SKILL.md from fetched docs
-4. **Cache** - References stored in `~/.skilld/` (shared across projects)
-5. **Install** - Writes SKILL.md to `./<agent>/skills/<package>/` (e.g. `.claude/skills/vueuse/`)
-
-Supported agents: Claude Code, Cursor, Windsurf, Cline, Codex, GitHub Copilot, Gemini CLI, Goose, Amp, OpenCode, Roo Code
-
-## Output Structure
-
-Skills install to each detected agent's skill directory. References are cached globally and shared across projects:
-
-```
-.claude/skills/vueuse/
-├── SKILL.md                    # Project-specific, adapts to your conventions
-└── .skilld/                    # Gitignored, recreated by `skilld install`
-    ├── pkg -> node_modules/vueuse
-    └── docs -> ~/.skilld/references/vueuse@10.9.0/docs
-
-~/.skilld/references/
-└── vueuse@10.9.0/              # Global cache, static docs
-    ├── docs/
-    ├── issues/
-    └── discussions/
-```
-
-SKILL.md is regenerated per-project (different conventions), but references stay static (same package docs). Version frontmatter enables sync:
-
-```yaml
----
-name: vueuse
-version: 10.9.0
-description: Collection of Vue Composition Utilities
----
-```
-
-## Package.json Auto-Discovery
-
-Run `skilld` without arguments to interactively generate skills for your dependencies:
-
-```bash
-cd my-project
-pnpx skilld
-```
-
-On first run, skilld launches a wizard to configure your agent and model, then lets you choose packages from:
-- **Source imports** — scans your code for actually used packages
-- **package.json** — all dependencies and devDependencies
-- **Manual entry** — comma-separated package names
-
-Skips `@types/*` and common dev tools (typescript, eslint, vitest, etc).
-
-## Shipped Skills (skills-npm)
-
-skilld supports the [skills-npm](https://github.com/antfu/skills-npm) convention. If a package ships a `skills/` directory, skilld symlinks it directly — no doc fetching, no caching, no LLM generation, no tokens spent.
-
-```
-node_modules/@slidev/cli/skills/
-  slidev/
-    SKILL.md
-    references/
-
-→ .claude/skills/slidev -> node_modules/@slidev/cli/skills/slidev
-```
-
-Package authors can ship skills alongside their code. skilld detects and links them automatically during sync. Generation is the fallback for packages that haven't adopted the convention yet.
+| `--model`      | `-m` | config default | LLM model for skill generation (sonnet, haiku, opus, etc.) |
+| `--debug`      |      | `false`        | Save raw LLM output to logs/ for each section |
+| `--prepare`    |      | `false`        | Non-interactive sync for prepare hook (outdated only) |
+| `--background` | `-b` | `false`        | Run `--prepare` in a detached background process |
 
 ## Related
 
 - [skills-npm](https://github.com/antfu/skills-npm) - Convention for shipping agent skills in npm packages
-- [mdream](https://github.com/harlan-zw/mdream) - HTML to Markdown converter used for crawling
-- [retriv](https://github.com/harlan-zw/retriv) - Vector database abstraction layer
+- [mdream](https://github.com/harlan-zw/mdream) - HTML to Markdown converter
+- [retriv](https://github.com/harlan-zw/retriv) - Vector search with sqlite-vec
 
 ## License
 

package/dist/_chunks/config.mjs

@@ -17,10 +17,9 @@ function getCacheDir(name, version) {
 }
 const CACHE_DIR = join(homedir(), ".skilld");
 const REFERENCES_DIR = join(CACHE_DIR, "references");
-const SEARCH_DB = join(CACHE_DIR, "search.db");
 function getPackageDbPath(name, version) {
 	return join(REFERENCES_DIR, getCacheKey(name, version), "search.db");
 }
-export { getCacheDir as a, getPackageDbPath as i, REFERENCES_DIR as n, getCacheKey as o, SEARCH_DB as r, getVersionKey as s, CACHE_DIR as t };
+export { getCacheKey as a, getCacheDir as i, REFERENCES_DIR as n, getVersionKey as o, getPackageDbPath as r, CACHE_DIR as t };
 
 //# sourceMappingURL=config.mjs.map

package/dist/_chunks/config.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"config.mjs","names":[],"sources":["../../src/cache/version.ts","../../src/cache/config.ts"],"sourcesContent":["/**\n * Version utilities\n */\n\nimport { resolve } from 'pathe'\nimport { REFERENCES_DIR } from './config'\n\n/** Validate npm package name (scoped or unscoped) */\nconst VALID_PKG_NAME = /^(?:@[a-z0-9][-a-z0-9._]*\\/)?[a-z0-9][-a-z0-9._]*$/\n\n/** Validate version string (semver-ish, no path separators) */\nconst VALID_VERSION = /^[a-z0-9][-\\w.+]*$/i\n\n/**\n * Get exact version key for cache keying\n */\nexport function getVersionKey(version: string): string {\n  return version\n}\n\n/**\n * Get cache key for a package: name@version\n */\nexport function getCacheKey(name: string, version: string): string {\n  return `${name}@${getVersionKey(version)}`\n}\n\n/**\n * Get path to cached package references.\n * Validates name/version to prevent path traversal.\n */\nexport function getCacheDir(name: string, version: string): string {\n  if (!VALID_PKG_NAME.test(name))\n    throw new Error(`Invalid package name: ${name}`)\n  if (!VALID_VERSION.test(version))\n    throw new Error(`Invalid version: ${version}`)\n\n  const dir = resolve(REFERENCES_DIR, getCacheKey(name, version))\n  if (!dir.startsWith(REFERENCES_DIR))\n    throw new Error(`Path traversal detected: ${dir}`)\n  return dir\n}\n","/**\n * Cache configuration\n */\n\nimport { homedir } from 'node:os'\nimport { join } from 'pathe'\nimport { getCacheKey } from './version'\n\n/** Global cache directory */\nexport const CACHE_DIR = join(homedir(), '.skilld')\n\n/** References subdirectory */\nexport const REFERENCES_DIR = join(CACHE_DIR, 'references')\n\n/** @deprecated Use getPackageDbPath instead */\nexport const SEARCH_DB = join(CACHE_DIR, 'search.db')\n\n/** Get search DB path for a specific package@version */\nexport function getPackageDbPath(name: string, version: string): string {\n  return join(REFERENCES_DIR, getCacheKey(name, version), 'search.db')\n}\n"],"mappings":";;AAQA,MAAM,iBAAiB;AAGvB,MAAM,gBAAgB;AAKtB,SAAgB,cAAc,SAAyB;AACrD,QAAO;;AAMT,SAAgB,YAAY,MAAc,SAAyB;AACjE,QAAO,GAAG,KAAK,GAAG,cAAc,QAAQ;;AAO1C,SAAgB,YAAY,MAAc,SAAyB;AACjE,KAAI,CAAC,eAAe,KAAK,KAAK,CAC5B,OAAM,IAAI,MAAM,yBAAyB,OAAO;AAClD,KAAI,CAAC,cAAc,KAAK,QAAQ,CAC9B,OAAM,IAAI,MAAM,oBAAoB,UAAU;CAEhD,MAAM,MAAM,QAAQ,gBAAgB,YAAY,MAAM,QAAQ,CAAC;AAC/D,KAAI,CAAC,IAAI,WAAW,eAAe,CACjC,OAAM,IAAI,MAAM,4BAA4B,MAAM;AACpD,QAAO;;AC/BT,MAAa,YAAY,KAAK,SAAS,EAAE,UAAU;AAGnD,MAAa,iBAAiB,KAAK,WAAW,aAAa;AAG3D,MAAa,YAAY,KAAK,WAAW,YAAY;AAGrD,SAAgB,iBAAiB,MAAc,SAAyB;AACtE,QAAO,KAAK,gBAAgB,YAAY,MAAM,QAAQ,EAAE,YAAY"}
+{"version":3,"file":"config.mjs","names":[],"sources":["../../src/cache/version.ts","../../src/cache/config.ts"],"sourcesContent":["/**\n * Version utilities\n */\n\nimport { resolve } from 'pathe'\nimport { REFERENCES_DIR } from './config'\n\n/** Validate npm package name (scoped or unscoped) */\nconst VALID_PKG_NAME = /^(?:@[a-z0-9][-a-z0-9._]*\\/)?[a-z0-9][-a-z0-9._]*$/\n\n/** Validate version string (semver-ish, no path separators) */\nconst VALID_VERSION = /^[a-z0-9][-\\w.+]*$/i\n\n/**\n * Get exact version key for cache keying\n */\nexport function getVersionKey(version: string): string {\n  return version\n}\n\n/**\n * Get cache key for a package: name@version\n */\nexport function getCacheKey(name: string, version: string): string {\n  return `${name}@${getVersionKey(version)}`\n}\n\n/**\n * Get path to cached package references.\n * Validates name/version to prevent path traversal.\n */\nexport function getCacheDir(name: string, version: string): string {\n  if (!VALID_PKG_NAME.test(name))\n    throw new Error(`Invalid package name: ${name}`)\n  if (!VALID_VERSION.test(version))\n    throw new Error(`Invalid version: ${version}`)\n\n  const dir = resolve(REFERENCES_DIR, getCacheKey(name, version))\n  if (!dir.startsWith(REFERENCES_DIR))\n    throw new Error(`Path traversal detected: ${dir}`)\n  return dir\n}\n","/**\n * Cache configuration\n */\n\nimport { homedir } from 'node:os'\nimport { join } from 'pathe'\nimport { getCacheKey } from './version'\n\n/** Global cache directory */\nexport const CACHE_DIR = join(homedir(), '.skilld')\n\n/** References subdirectory */\nexport const REFERENCES_DIR = join(CACHE_DIR, 'references')\n\n/** Get search DB path for a specific package@version */\nexport function getPackageDbPath(name: string, version: string): string {\n  return join(REFERENCES_DIR, getCacheKey(name, version), 'search.db')\n}\n"],"mappings":";;AAQA,MAAM,iBAAiB;AAGvB,MAAM,gBAAgB;AAKtB,SAAgB,cAAc,SAAyB;AACrD,QAAO;;AAMT,SAAgB,YAAY,MAAc,SAAyB;AACjE,QAAO,GAAG,KAAK,GAAG,cAAc,QAAQ;;AAO1C,SAAgB,YAAY,MAAc,SAAyB;AACjE,KAAI,CAAC,eAAe,KAAK,KAAK,CAC5B,OAAM,IAAI,MAAM,yBAAyB,OAAO;AAClD,KAAI,CAAC,cAAc,KAAK,QAAQ,CAC9B,OAAM,IAAI,MAAM,oBAAoB,UAAU;CAEhD,MAAM,MAAM,QAAQ,gBAAgB,YAAY,MAAM,QAAQ,CAAC;AAC/D,KAAI,CAAC,IAAI,WAAW,eAAe,CACjC,OAAM,IAAI,MAAM,4BAA4B,MAAM;AACpD,QAAO;;AC/BT,MAAa,YAAY,KAAK,SAAS,EAAE,UAAU;AAGnD,MAAa,iBAAiB,KAAK,WAAW,aAAa;AAG3D,SAAgB,iBAAiB,MAAc,SAAyB;AACtE,QAAO,KAAK,gBAAgB,YAAY,MAAM,QAAQ,EAAE,YAAY"}