mirror of
https://github.com/rohitg00/skillkit.git
synced 2026-11-19 02:13:58 +00:00
Compare commits
31
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8ed4ada674 | ||
|
|
514de86727 | ||
|
|
bf5903bf7f | ||
|
|
aafa086314 | ||
|
|
344f081664 | ||
|
|
86c1e5d8f9 | ||
|
|
9930096242 | ||
|
|
24ff833265 | ||
|
|
12ac7356f8 | ||
|
|
53b3f4f839 | ||
|
|
896eff184c | ||
|
|
407e8215f2 | ||
|
|
dd4ec56a1a | ||
|
|
e9bb9fbd0d | ||
|
|
ee54bf1545 | ||
|
|
f097ec7ad7 | ||
|
|
eeddd2a8cf | ||
|
|
6362be2cb9 | ||
|
|
7e23c3a5d7 | ||
|
|
91c81ba1fa | ||
|
|
684ea48f58 | ||
|
|
19c9f6bdc4 | ||
|
|
f11de2ac63 | ||
|
|
3e92215231 | ||
|
|
2f29632f17 | ||
|
|
596fc0aa7b | ||
|
|
2bf8c7499c | ||
|
|
d7861f96a7 | ||
|
|
c89d3130d1 | ||
|
|
d8168044b3 | ||
|
|
b28a2801b2 |
@@ -65,3 +65,4 @@ skillkit.yaml
|
||||
CLAUDE.md
|
||||
prd.md
|
||||
.vercel
|
||||
packages/extension/store-assets/skillkit-extension.zip
|
||||
|
||||
@@ -3,23 +3,21 @@
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="docs/img/banner.svg">
|
||||
<source media="(prefers-color-scheme: light)" srcset="docs/img/banner.svg">
|
||||
<img alt="SkillKit - One Skill. 32 Agents." src="docs/img/banner.svg" width="100%">
|
||||
<img alt="SkillKit - One Skill. Every Agent." src="docs/img/banner.svg" width="100%">
|
||||
</picture>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
[](https://www.npmjs.com/package/skillkit)
|
||||
[](https://github.com/rohitg00/skillkit/actions/workflows/ci.yml)
|
||||
[](https://www.npmjs.com/package/skillkit)
|
||||
[](https://www.npmjs.com/package/skillkit)
|
||||
[](https://github.com/rohitg00/skillkit/stargazers)
|
||||
[](https://github.com/rohitg00/skillkit/actions/workflows/ci.yml)
|
||||
[](https://opensource.org/licenses/Apache-2.0)
|
||||
[](https://agenstskills.com)
|
||||
[](https://agenstskills.com/docs)
|
||||
[](https://agenstskills.com/api)
|
||||
|
||||
**Write a skill once, deploy it to all 32 agents. No rewrites.**
|
||||
**SkillKit** is the open source package manager for AI agent skills. Write a skill once, deploy it to **44 agents** — Claude, Cursor, Copilot, Windsurf, Devin, Codex, and 38 more. No rewrites. 15,000+ skills in the marketplace.
|
||||
|
||||
[Website](https://agenstskills.com) · [Docs](https://agenstskills.com/docs) · [API](https://agenstskills.com/api) · [npm](https://www.npmjs.com/package/skillkit)
|
||||
[Website](https://agenstskills.com) · [Docs](https://agenstskills.com/docs) · [API Explorer](https://agenstskills.com/api) · [Chrome Extension](https://github.com/rohitg00/skillkit/tree/main/packages/extension#readme) · [npm](https://www.npmjs.com/package/skillkit)
|
||||
|
||||
</div>
|
||||
|
||||
@@ -36,7 +34,7 @@ Skills make AI coding agents smarter. But every agent uses a different format:
|
||||
|
||||
You end up rewriting the same skill for each agent, or locking into one platform.
|
||||
|
||||
**SkillKit fixes this.** Install from 15,000+ skills, auto-translate between formats, persist learnings with Memory. Works with Claude, Cursor, Windsurf, Copilot, and 28 more.
|
||||
**SkillKit fixes this.** Install from 15,000+ skills, auto-translate between formats, persist learnings with Memory. Works with Claude, Cursor, Windsurf, Copilot, and 40 more.
|
||||
|
||||
```bash
|
||||
npx skillkit@latest
|
||||
@@ -183,6 +181,18 @@ git commit -m "add team skills"
|
||||
|
||||
Team members run `skillkit manifest install` and they're in sync.
|
||||
|
||||
### Chrome Extension
|
||||
|
||||
Save any webpage as a skill directly from your browser.
|
||||
|
||||
1. Build: `pnpm --filter @skillkit/extension build`
|
||||
2. Chrome → `chrome://extensions` → Load unpacked → `packages/extension/dist/`
|
||||
3. Click the extension icon or right-click → "Save page as Skill"
|
||||
|
||||
The extension sends the page URL to the SkillKit API for server-side extraction with Turndown, 5-source weighted tag detection, and GitHub URL support. The resulting SKILL.md downloads automatically. Then run `skillkit install ~/Downloads/skillkit-skills/my-skill` to deploy to all agents.
|
||||
|
||||
[Extension docs](https://agenstskills.com/docs/chrome-extension)
|
||||
|
||||
### Interactive TUI
|
||||
|
||||
```bash
|
||||
@@ -193,7 +203,7 @@ skillkit ui
|
||||
|
||||

|
||||
|
||||
## Supported Agents (32)
|
||||
## Supported Agents (44)
|
||||
|
||||
| Agent | Format | Directory |
|
||||
|-------|--------|-----------|
|
||||
@@ -204,8 +214,12 @@ skillkit ui
|
||||
| **OpenCode** | SKILL.md | `.opencode/skills/` |
|
||||
| **GitHub Copilot** | Markdown | `.github/skills/` |
|
||||
| **Windsurf** | Markdown | `.windsurf/skills/` |
|
||||
| **Devin** | Markdown | `.devin/skills/` |
|
||||
| **Aider** | SKILL.md | `.aider/skills/` |
|
||||
| **Sourcegraph Cody** | SKILL.md | `.cody/skills/` |
|
||||
| **Amazon Q** | SKILL.md | `.amazonq/skills/` |
|
||||
|
||||
Plus 25 more: Amp, Antigravity, Clawdbot, Cline, CodeBuddy, CommandCode, Continue, Crush, Droid, Factory, Goose, Kilo Code, Kiro CLI, MCPJam, Mux, Neovate, OpenHands, Pi, Qoder, Qwen, Roo Code, Trae, Vercel, Zencoder, Universal
|
||||
Plus 33 more: Amp, Antigravity, Augment Code, Bolt, Clawdbot, Cline, CodeBuddy, CodeGPT, CommandCode, Continue, Crush, Droid, Factory, Goose, Kilo Code, Kiro CLI, Lovable, MCPJam, Mux, Neovate, OpenHands, Pi, PlayCode, Qoder, Qwen, Replit Agent, Roo Code, Tabby, Tabnine, Trae, Vercel, Zencoder, Universal
|
||||
|
||||
[Full agent details](https://agenstskills.com/docs/agents)
|
||||
|
||||
@@ -223,12 +237,21 @@ skillkit generate # AI skill generation wizard
|
||||
skillkit serve # Start REST API server
|
||||
```
|
||||
|
||||
### Discovery
|
||||
### Discovery & Security
|
||||
|
||||
```bash
|
||||
skillkit marketplace # Browse skills
|
||||
skillkit tree # Hierarchical taxonomy
|
||||
skillkit find <query> # Quick search
|
||||
skillkit scan <path> # Security scan for skills
|
||||
```
|
||||
|
||||
### Issue Planner
|
||||
|
||||
```bash
|
||||
skillkit issue plan "#42" # Plan from GitHub Issue
|
||||
skillkit issue plan owner/repo#42 # Cross-repo plan
|
||||
skillkit issue list # List open issues
|
||||
```
|
||||
|
||||
### Advanced
|
||||
|
||||
@@ -1,93 +0,0 @@
|
||||
# Versioning
|
||||
|
||||
SkillKit uses **synchronized versioning** - all packages share the same version number.
|
||||
|
||||
## Package List
|
||||
|
||||
All these packages are kept in sync:
|
||||
|
||||
| Package | Location |
|
||||
|---------|----------|
|
||||
| `skillkit` | `apps/skillkit/` |
|
||||
| `@skillkit/cli` | `packages/cli/` |
|
||||
| `@skillkit/core` | `packages/core/` |
|
||||
| `@skillkit/tui` | `packages/tui/` |
|
||||
| `@skillkit/agents` | `packages/agents/` |
|
||||
| `@skillkit/memory` | `packages/memory/` |
|
||||
| `@skillkit/mesh` | `packages/mesh/` |
|
||||
| `@skillkit/messaging` | `packages/messaging/` |
|
||||
| `@skillkit/mcp-memory` | `packages/mcp-memory/` |
|
||||
| `@skillkit/resources` | `packages/resources/` |
|
||||
| `skillkit-docs` | `docs/fumadocs/` |
|
||||
| Website | `docs/skillkit/` |
|
||||
|
||||
## How to Release
|
||||
|
||||
### 1. Bump Version
|
||||
|
||||
Use the version bump script:
|
||||
|
||||
```bash
|
||||
./scripts/bump-version.sh 1.8.1
|
||||
```
|
||||
|
||||
This updates all package.json files to the same version.
|
||||
|
||||
### 2. Commit Changes
|
||||
|
||||
```bash
|
||||
git add -A
|
||||
git commit -m "chore: bump version to 1.8.1"
|
||||
git push origin main
|
||||
```
|
||||
|
||||
### 3. Create Release
|
||||
|
||||
```bash
|
||||
gh release create v1.8.1 --generate-notes
|
||||
```
|
||||
|
||||
Or with custom notes:
|
||||
|
||||
```bash
|
||||
gh release create v1.8.1 --title "v1.8.1 - Bug fixes" --notes "Release notes here"
|
||||
```
|
||||
|
||||
### 4. Automated Publishing
|
||||
|
||||
When you push a tag starting with `v`, the CI automatically:
|
||||
|
||||
1. Verifies tag matches package versions
|
||||
2. Runs tests
|
||||
3. Publishes to npm
|
||||
4. Publishes to GitHub Packages
|
||||
5. Creates GitHub Release
|
||||
|
||||
## CI Checks
|
||||
|
||||
The CI validates version consistency on every PR:
|
||||
|
||||
- **version-check** job compares all package versions
|
||||
- Fails if any package has a different version
|
||||
- Run `./scripts/bump-version.sh <version>` to fix mismatches
|
||||
|
||||
## Semantic Versioning
|
||||
|
||||
We follow [semver](https://semver.org/):
|
||||
|
||||
- **MAJOR** (x.0.0): Breaking changes
|
||||
- **MINOR** (0.x.0): New features, backward compatible
|
||||
- **PATCH** (0.0.x): Bug fixes, backward compatible
|
||||
|
||||
## Quick Commands
|
||||
|
||||
```bash
|
||||
# Check current versions
|
||||
grep -r '"version"' apps/skillkit/package.json
|
||||
|
||||
# Bump all packages
|
||||
./scripts/bump-version.sh 1.8.1
|
||||
|
||||
# Create release
|
||||
gh release create v1.8.1 --generate-notes
|
||||
```
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "skillkit",
|
||||
"version": "1.14.0",
|
||||
"version": "1.19.0",
|
||||
"description": "Supercharge AI coding agents with portable skills. Install, translate, and share skills across Claude Code, Cursor, Codex, Copilot & 13 more",
|
||||
"type": "module",
|
||||
"bin": {
|
||||
|
||||
@@ -86,6 +86,12 @@ import {
|
||||
SessionNoteCommand,
|
||||
SessionCompleteCommand,
|
||||
SessionInProgressCommand,
|
||||
SessionSnapshotSaveCommand,
|
||||
SessionSnapshotRestoreCommand,
|
||||
SessionSnapshotListCommand,
|
||||
SessionSnapshotDeleteCommand,
|
||||
SessionExplainCommand,
|
||||
ActivityCommand,
|
||||
ProfileCommand,
|
||||
ProfileListCommand,
|
||||
ProfileCreateCommand,
|
||||
@@ -103,6 +109,15 @@ import {
|
||||
SkillMdInitCommand,
|
||||
SkillMdCheckCommand,
|
||||
ServeCommand,
|
||||
ScanCommand,
|
||||
DoctorCommand,
|
||||
SaveCommand,
|
||||
AgentsMdCommand,
|
||||
AgentsMdInitCommand,
|
||||
AgentsMdSyncCommand,
|
||||
AgentsMdShowCommand,
|
||||
IssuePlanCommand,
|
||||
IssueListCommand,
|
||||
} from '@skillkit/cli';
|
||||
|
||||
const __filename = fileURLToPath(import.meta.url);
|
||||
@@ -209,6 +224,12 @@ cli.register(SessionListCommand);
|
||||
cli.register(SessionNoteCommand);
|
||||
cli.register(SessionCompleteCommand);
|
||||
cli.register(SessionInProgressCommand);
|
||||
cli.register(SessionSnapshotSaveCommand);
|
||||
cli.register(SessionSnapshotRestoreCommand);
|
||||
cli.register(SessionSnapshotListCommand);
|
||||
cli.register(SessionSnapshotDeleteCommand);
|
||||
cli.register(SessionExplainCommand);
|
||||
cli.register(ActivityCommand);
|
||||
|
||||
cli.register(ProfileCommand);
|
||||
cli.register(ProfileListCommand);
|
||||
@@ -231,5 +252,15 @@ cli.register(SkillMdInitCommand);
|
||||
cli.register(SkillMdCheckCommand);
|
||||
|
||||
cli.register(ServeCommand);
|
||||
cli.register(ScanCommand);
|
||||
cli.register(DoctorCommand);
|
||||
cli.register(SaveCommand);
|
||||
cli.register(AgentsMdCommand);
|
||||
cli.register(AgentsMdInitCommand);
|
||||
cli.register(AgentsMdSyncCommand);
|
||||
cli.register(AgentsMdShowCommand);
|
||||
|
||||
cli.register(IssuePlanCommand);
|
||||
cli.register(IssueListCommand);
|
||||
|
||||
cli.runExit(process.argv.slice(2));
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
---
|
||||
title: Supported Agents
|
||||
description: 32 AI coding agents supported by SkillKit
|
||||
description: 44 AI coding agents supported by SkillKit
|
||||
---
|
||||
|
||||
# Supported Agents
|
||||
|
||||
SkillKit uses an adapter pattern to support 32 AI coding platforms. Each adapter implements `getConfigPath()` and `generateConfig()` methods.
|
||||
SkillKit uses an adapter pattern to support 44 AI coding platforms. Each adapter implements `getConfigPath()` and `generateConfig()` methods.
|
||||
|
||||
## Agent Directory Mapping
|
||||
|
||||
@@ -42,6 +42,18 @@ SkillKit uses an adapter pattern to support 32 AI coding platforms. Each adapter
|
||||
| Qwen | `.qwen/skills/` | SKILL.md |
|
||||
| Vercel | `.vercel/skills/` | SKILL.md |
|
||||
| Zencoder | `.zencoder/skills/` | SKILL.md |
|
||||
| Devin | `.devin/skills/` | Markdown |
|
||||
| Aider | `.aider/skills/` | SKILL.md |
|
||||
| Sourcegraph Cody | `.cody/skills/` | SKILL.md |
|
||||
| Amazon Q Developer | `.amazonq/skills/` | SKILL.md |
|
||||
| Augment Code | `.augment/skills/` | SKILL.md |
|
||||
| Replit Agent | `.replit/skills/` | Markdown |
|
||||
| Bolt | `.bolt/skills/` | Markdown |
|
||||
| Lovable | `.lovable/skills/` | Markdown |
|
||||
| Tabby | `.tabby/skills/` | SKILL.md |
|
||||
| Tabnine | `.tabnine/skills/` | SKILL.md |
|
||||
| CodeGPT | `.codegpt/skills/` | SKILL.md |
|
||||
| PlayCode Agent | `.playcode/skills/` | Markdown |
|
||||
| Universal | `skills/` | SKILL.md |
|
||||
|
||||
## Translation System
|
||||
|
||||
@@ -0,0 +1,121 @@
|
||||
---
|
||||
title: Chrome Extension
|
||||
description: Save any webpage as an AI agent skill from your browser
|
||||
---
|
||||
|
||||
# Chrome Extension
|
||||
|
||||
Save any webpage as a SKILL.md directly from your browser.
|
||||
|
||||
## Install
|
||||
|
||||
1. Download the extension from the [releases page](https://github.com/rohitg00/skillkit/releases)
|
||||
2. Open `chrome://extensions` in Chrome
|
||||
3. Enable "Developer mode" (top right)
|
||||
4. Click "Load unpacked" and select the `packages/extension/dist/` folder
|
||||
|
||||
Or build from source:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/rohitg00/skillkit.git
|
||||
cd skillkit
|
||||
pnpm install && pnpm --filter @skillkit/extension build
|
||||
```
|
||||
|
||||
Then load `packages/extension/dist/` as an unpacked extension.
|
||||
|
||||
## Usage
|
||||
|
||||
### Popup
|
||||
|
||||
1. Navigate to any webpage
|
||||
2. Click the SkillKit extension icon
|
||||
3. Optionally enter a custom skill name
|
||||
4. Click **Save as Skill**
|
||||
|
||||
The extension sends the page URL to the SkillKit API, which extracts the content as markdown, generates tags using weighted 5-source analysis, and returns a complete SKILL.md. The file downloads to your `Downloads/skillkit-skills/` folder.
|
||||
|
||||
### Context Menu
|
||||
|
||||
Right-click on any page:
|
||||
|
||||
- **Save page as Skill** — sends the URL to the API, downloads the result
|
||||
- **Save selection as Skill** — builds the skill locally from selected text (no network request)
|
||||
|
||||
### Making Skills Available to Agents
|
||||
|
||||
After downloading, install the skill so all agents can use it:
|
||||
|
||||
```bash
|
||||
skillkit install ~/Downloads/skillkit-skills/my-skill
|
||||
```
|
||||
|
||||
Or copy directly:
|
||||
|
||||
```bash
|
||||
cp -r ~/Downloads/skillkit-skills/my-skill ~/.skillkit/skills/
|
||||
skillkit sync
|
||||
```
|
||||
|
||||
## How It Works
|
||||
|
||||
```
|
||||
Extension → POST /api/save-skill { url } → Server pipeline → Download
|
||||
```
|
||||
|
||||
1. **Popup** reads the current tab's URL and title via `activeTab` permission. No content script injection needed.
|
||||
|
||||
2. **Background service worker** sends the URL to `agenstskills.com/api/save-skill`:
|
||||
- Server fetches the page and converts HTML to markdown via Turndown
|
||||
- GitHub URLs are auto-converted to raw content
|
||||
- Tags are detected from 5 weighted sources (URL segments, headings, code blocks, keywords, language)
|
||||
- Returns a complete SKILL.md with YAML frontmatter
|
||||
|
||||
3. **Download** — the service worker creates a blob and saves via `chrome.downloads` API.
|
||||
|
||||
4. **Selection saves** work entirely offline — Chrome natively provides `selectionText` via the context menu API, so the skill is built locally with no server round-trip.
|
||||
|
||||
## Permissions
|
||||
|
||||
| Permission | Why |
|
||||
|-----------|-----|
|
||||
| `contextMenus` | Right-click "Save as Skill" menu items |
|
||||
| `activeTab` | Access current page URL and title on click |
|
||||
| `downloads` | Save SKILL.md files to disk |
|
||||
|
||||
No `host_permissions` or `scripting` permissions needed. Only the page URL is sent to the server — no page content, browsing history, or personal data.
|
||||
|
||||
## Generated SKILL.md Format
|
||||
|
||||
```yaml
|
||||
---
|
||||
name: react-performance-tips
|
||||
description: Optimizing React rendering with memo and useMemo
|
||||
tags:
|
||||
- react
|
||||
- javascript
|
||||
- testing
|
||||
metadata:
|
||||
source: https://example.com/react-performance
|
||||
savedAt: 2026-02-14T09:00:00.000Z
|
||||
---
|
||||
|
||||
# React Performance Tips
|
||||
|
||||
The extracted markdown content of the page...
|
||||
```
|
||||
|
||||
## Building from Source
|
||||
|
||||
The extension uses tsup to bundle TypeScript into IIFE format for browser compatibility:
|
||||
|
||||
```bash
|
||||
pnpm --filter @skillkit/extension build
|
||||
```
|
||||
|
||||
Output goes to `packages/extension/dist/` with:
|
||||
- `background.global.js` — Service worker (~4KB)
|
||||
- `popup.global.js` — Popup UI logic (~2KB)
|
||||
- `popup.html` + `popup.css` — Monochromatic UI
|
||||
- `manifest.json` — Chrome Manifest V3
|
||||
- `icons/` — 16/48/128px PNG icons
|
||||
@@ -343,6 +343,41 @@ skillkit serve --cache-ttl 3600000
|
||||
| GET | `/health` | Server health |
|
||||
| GET | `/cache/stats` | Cache statistics |
|
||||
|
||||
## Issue Planner
|
||||
|
||||
Generate structured plans from GitHub Issues. Requires the `gh` CLI.
|
||||
|
||||
```bash
|
||||
skillkit issue plan "#42" # Plan from current repo
|
||||
skillkit issue plan rohitg00/skillkit#42 # Cross-repo
|
||||
skillkit issue plan "#42" --agent cursor # Target specific agent
|
||||
skillkit issue plan "#42" --no-tests # Skip test steps
|
||||
skillkit issue plan "#42" --json # JSON output
|
||||
skillkit issue plan "#42" --tech-stack react,ts # Override tech stack
|
||||
```
|
||||
|
||||
### Issue Plan Options
|
||||
|
||||
| Option | Short | Default | Purpose |
|
||||
|--------|-------|---------|---------|
|
||||
| `--agent` | `-a` | `claude-code` | Target agent |
|
||||
| `--output` | `-o` | `.skillkit/plans/issue-<n>.md` | Output file path |
|
||||
| `--no-tests` | — | `false` | Skip test steps |
|
||||
| `--json` | — | `false` | Output as JSON |
|
||||
| `--tech-stack` | — | — | Comma-separated tech stack |
|
||||
|
||||
### Issue List
|
||||
|
||||
```bash
|
||||
skillkit issue list # List open issues
|
||||
skillkit issue list --repo owner/repo # Specific repo
|
||||
skillkit issue list --label bug # Filter by label
|
||||
skillkit issue list --limit 20 # More results
|
||||
skillkit issue list --json # JSON output
|
||||
```
|
||||
|
||||
The planner extracts task lists (checkboxes) from the issue body, infers file mentions from backtick-quoted paths, and maps labels to tags (e.g., `bug` → `fix`, `enhancement` → `feature`). Generated plans work with `skillkit plan validate` and `skillkit plan execute`.
|
||||
|
||||
## Utility Commands
|
||||
|
||||
```bash
|
||||
@@ -362,6 +397,39 @@ skillkit publish --dry-run # Preview without writing
|
||||
skillkit publish submit # Submit to SkillKit marketplace
|
||||
```
|
||||
|
||||
## Security Scanning
|
||||
|
||||
```bash
|
||||
skillkit scan <path> # Scan skill for vulnerabilities
|
||||
skillkit scan <path> --format json # Output as JSON
|
||||
skillkit scan <path> --format table # Tabular output
|
||||
skillkit scan <path> --format sarif # SARIF for GitHub Code Scanning
|
||||
skillkit scan <path> --fail-on high # Exit 1 if HIGH+ findings
|
||||
skillkit scan <path> --skip-rules UC001 # Skip specific rules
|
||||
```
|
||||
|
||||
**Threat Categories:**
|
||||
|
||||
| Category | Description |
|
||||
|----------|-------------|
|
||||
| Prompt Injection | Override/bypass agent instructions |
|
||||
| Command Injection | eval(), exec(), shell commands |
|
||||
| Data Exfiltration | Webhook URLs, env var reads, credential access |
|
||||
| Tool Abuse | Tool shadowing, autonomy escalation |
|
||||
| Hardcoded Secrets | API keys, tokens, private keys |
|
||||
| Unicode Steganography | Zero-width chars, bidi overrides |
|
||||
|
||||
**Install Integration:**
|
||||
|
||||
Skills are automatically scanned during `skillkit install`. Use `--no-scan` to skip, or `--force` to install despite findings.
|
||||
|
||||
**Output Formats:**
|
||||
|
||||
- `summary` (default) - colored terminal output
|
||||
- `json` - machine-readable JSON
|
||||
- `table` - tabular format
|
||||
- `sarif` - SARIF v2.1 for GitHub Code Scanning / IDE integration
|
||||
|
||||
## Interactive TUI
|
||||
|
||||
```bash
|
||||
|
||||
@@ -7,7 +7,7 @@ description: Universal skill management for AI coding agents
|
||||
|
||||
Skills make AI coding agents smarter. But every agent uses a different format — Claude Code wants `.claude/skills/`, Cursor uses `.mdc`, Copilot expects `.github/skills/`. You end up rewriting the same skill three times, or locking into one platform.
|
||||
|
||||
SkillKit fixes this. Write a skill once, deploy it to all 32 agents.
|
||||
SkillKit fixes this. Write a skill once, deploy it to all 44 agents.
|
||||
|
||||
## Get Started
|
||||
|
||||
@@ -94,12 +94,24 @@ SkillKit sits between your skills and your agents. It handles format translation
|
||||
|
||||
## Supported Agents
|
||||
|
||||
32 agents and counting:
|
||||
44 agents and counting:
|
||||
|
||||
**Claude Code** | **Cursor** | **Codex** | **Gemini CLI** | **OpenCode** | **GitHub Copilot** | **Windsurf** | Amp | Antigravity | Clawdbot | Cline | CodeBuddy | CommandCode | Continue | Crush | Droid | Factory | Goose | Kilo Code | Kiro CLI | MCPJam | Mux | Neovate | OpenHands | Pi | Qoder | Qwen | Roo Code | Trae | Vercel | Zencoder | Universal
|
||||
|
||||
[Full agent details](/docs/agents)
|
||||
|
||||
### Security scanning
|
||||
|
||||
Every skill is scanned for threats before installation — prompt injection, hardcoded secrets, command injection, and more:
|
||||
|
||||
```bash
|
||||
skillkit scan ./my-skill # 46+ detection rules
|
||||
skillkit scan ./my-skill --format sarif # GitHub Code Scanning
|
||||
skillkit scan ./my-skill --fail-on high # CI gate
|
||||
```
|
||||
|
||||
[Security Scanner](/docs/security)
|
||||
|
||||
## Beyond Basic Skills
|
||||
|
||||
### Session Memory
|
||||
@@ -145,6 +157,7 @@ Team members run `skillkit manifest install` and they're in sync.
|
||||
|
||||
- [Installation](/docs/installation) — Install and configure
|
||||
- [Quick Start](/docs/quickstart) — First project setup
|
||||
- [Security Scanner](/docs/security) — Threat detection for skills
|
||||
- [Commands](/docs/commands) — Full CLI reference
|
||||
- [REST API](/docs/rest-api) — Runtime discovery server
|
||||
- [MCP Server](/docs/mcp-server) — Agent-native discovery
|
||||
|
||||
@@ -58,7 +58,7 @@ The init command:
|
||||
|
||||
```bash
|
||||
skillkit init --agent cursor
|
||||
skillkit init --list # Show all 32 supported agents
|
||||
skillkit init --list # Show all 44 supported agents
|
||||
skillkit init --quiet # Skip logo and prompts (for CI)
|
||||
```
|
||||
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
"pages": [
|
||||
"index",
|
||||
"installation",
|
||||
"chrome-extension",
|
||||
"quickstart",
|
||||
"tui",
|
||||
"skills",
|
||||
@@ -16,6 +17,7 @@
|
||||
"mesh",
|
||||
"messaging",
|
||||
"workflows",
|
||||
"security",
|
||||
"testing",
|
||||
"commands",
|
||||
"configuration",
|
||||
|
||||
@@ -16,7 +16,7 @@ skillkit primer
|
||||
# Generate for specific agents
|
||||
skillkit primer --agent claude,cursor,windsurf
|
||||
|
||||
# Generate for all 32 agents
|
||||
# Generate for all 44 agents
|
||||
skillkit primer --all-agents
|
||||
|
||||
# Preview without writing files
|
||||
|
||||
@@ -0,0 +1,259 @@
|
||||
---
|
||||
title: Security Scanner
|
||||
description: Detect malicious patterns, secrets, and vulnerabilities in AI agent skills
|
||||
---
|
||||
|
||||
# Security Scanner
|
||||
|
||||
SkillKit includes a built-in security scanner that analyzes skills for prompt injection, command injection, data exfiltration, hardcoded secrets, and other threats before installation.
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
skillkit scan ./my-skill
|
||||
```
|
||||
|
||||
The scanner runs automatically during `skillkit install`. Use `--no-scan` to skip or `--force` to install despite findings.
|
||||
|
||||
## CLI Usage
|
||||
|
||||
```bash
|
||||
skillkit scan <path> # Scan skill directory
|
||||
skillkit scan <path> --format json # JSON output
|
||||
skillkit scan <path> --format table # Tabular output
|
||||
skillkit scan <path> --format sarif # SARIF v2.1 for GitHub Code Scanning
|
||||
skillkit scan <path> --fail-on high # Exit code 1 if HIGH+ findings
|
||||
skillkit scan <path> --skip-rules UC001 # Skip specific rules
|
||||
skillkit scan <path> --skip-rules PI001,PI002 # Skip multiple rules
|
||||
```
|
||||
|
||||
## Threat Categories
|
||||
|
||||
The scanner detects 46+ patterns across 6 threat categories:
|
||||
|
||||
### Prompt Injection (PI001–PI015)
|
||||
|
||||
Detects attempts to override, bypass, or manipulate agent instructions.
|
||||
|
||||
| Rule | Severity | Description |
|
||||
|------|----------|-------------|
|
||||
| PI001 | Critical | Instruction override ("ignore previous instructions") |
|
||||
| PI002 | Critical | Context clearing ("forget everything") |
|
||||
| PI003 | Critical | Training bypass ("disregard your training") |
|
||||
| PI004 | Critical | System prompt injection ("new instructions:") |
|
||||
| PI005 | High | Role manipulation ("you are now a...") |
|
||||
| PI006 | High | Roleplay manipulation ("pretend to be...") |
|
||||
| PI007 | High | Persistent behavior change ("from now on...") |
|
||||
| PI008 | High | System prompt extraction ("show me your instructions") |
|
||||
| PI009 | Critical | Policy bypass (jailbreak, unrestricted mode, DAN) |
|
||||
| PI010 | High | Concealment ("don't tell the user") |
|
||||
| PI011 | High | Delimiter injection (conversation role markers) |
|
||||
| PI012 | High | Model-specific delimiters (Llama [INST] tags) |
|
||||
| PI013 | Medium | YAML front-matter injection |
|
||||
| PI014 | Medium | Hidden HTML comments with instructions |
|
||||
| PI015 | Medium | Hidden Markdown comments with instructions |
|
||||
|
||||
### Command Injection (CI001–CI010)
|
||||
|
||||
Detects code execution, shell injection, and path traversal patterns.
|
||||
|
||||
| Rule | Severity | Description |
|
||||
|------|----------|-------------|
|
||||
| CI001 | Critical | `eval()` calls |
|
||||
| CI002 | Critical | `Function()` constructor |
|
||||
| CI003 | Critical | `child_process` exec/execSync |
|
||||
| CI004 | Critical | Python `subprocess` with `shell=True` |
|
||||
| CI005 | Medium | Template literals with dynamic content in command context |
|
||||
| CI006 | Medium | Path traversal (`../`) |
|
||||
| CI007 | High | Shell command chaining with dangerous commands |
|
||||
| CI008 | Medium | Process execution functions |
|
||||
| CI009 | High | Python dynamic import/compile |
|
||||
| CI010 | Medium | Node.js `vm` module usage |
|
||||
|
||||
### Data Exfiltration (DE001–DE008)
|
||||
|
||||
Detects network requests, webhook URLs, and credential access patterns.
|
||||
|
||||
| Rule | Severity | Description |
|
||||
|------|----------|-------------|
|
||||
| DE001 | Critical | Discord webhook URLs |
|
||||
| DE002 | Critical | Telegram bot API URLs |
|
||||
| DE003 | High | Slack webhook URLs |
|
||||
| DE004 | High | HTTP POST with env variables |
|
||||
| DE005 | High | Fetch/axios sending to external URLs |
|
||||
| DE006 | Medium | Reading `.env` or credentials files |
|
||||
| DE007 | Medium | Environment variable access patterns |
|
||||
| DE008 | Medium | DNS/IP-based exfiltration patterns |
|
||||
|
||||
### Tool Abuse (TA001–TA006)
|
||||
|
||||
Detects tool shadowing, autonomy escalation, and capability manipulation.
|
||||
|
||||
| Rule | Severity | Description |
|
||||
|------|----------|-------------|
|
||||
| TA001 | High | Tool shadowing (redefining built-in tools) |
|
||||
| TA002 | High | Autonomy abuse ("keep retrying", "run without confirmation") |
|
||||
| TA003 | High | Capability inflation (discovering/enabling extra tools) |
|
||||
| TA004 | Medium | Tool chaining (read sensitive data then send externally) |
|
||||
| TA005 | Medium | Permission escalation patterns |
|
||||
| TA006 | Medium | Recursive self-invocation |
|
||||
|
||||
### Hardcoded Secrets (SK001–SK013)
|
||||
|
||||
Detects API keys, tokens, and credentials embedded in skill files.
|
||||
|
||||
| Rule | Severity | Description |
|
||||
|------|----------|-------------|
|
||||
| SK001 | Critical | OpenAI API key (`sk-...`) |
|
||||
| SK002 | Critical | Stripe live publishable key |
|
||||
| SK003 | Critical | Stripe secret key |
|
||||
| SK004 | Critical | GitHub personal access token |
|
||||
| SK005 | Critical | GitHub OAuth token |
|
||||
| SK006 | Critical | AWS access key (`AKIA...`) |
|
||||
| SK007 | Critical | Slack bot token (`xoxb-...`) |
|
||||
| SK008 | Critical | Slack user token (`xoxp-...`) |
|
||||
| SK009 | Critical | Private key block |
|
||||
| SK010 | High | Google API key |
|
||||
| SK011 | Critical | Anthropic API key (`sk-ant-...`) |
|
||||
| SK012 | High | npm token |
|
||||
| SK013 | Low | UUID patterns (with credential context) |
|
||||
| SK-ENV | High | Environment file included in skill |
|
||||
|
||||
### Unicode Steganography (UC001–UC007)
|
||||
|
||||
Detects invisible characters and obfuscation techniques.
|
||||
|
||||
| Rule | Severity | Description |
|
||||
|------|----------|-------------|
|
||||
| UC001 | Medium | Zero-width characters (U+200B, U+200C, U+200D, U+FEFF) |
|
||||
| UC002 | High | Bidirectional text override (U+202A–U+202E) |
|
||||
| UC003 | High | Bidirectional isolate characters (U+2066–U+2069) |
|
||||
| UC004 | High | Unicode tag characters (U+E0001–U+E007F) |
|
||||
| UC005 | Medium | Control characters |
|
||||
| UC006 | Medium | Base64-encoded payloads |
|
||||
| UC007 | Medium | Hex/Unicode escape sequences |
|
||||
|
||||
### Manifest Validation (MF001–MF008)
|
||||
|
||||
Validates SKILL.md frontmatter and skill structure.
|
||||
|
||||
| Rule | Severity | Description |
|
||||
|------|----------|-------------|
|
||||
| MF001 | Low | Missing SKILL.md frontmatter |
|
||||
| MF002 | Low | Missing skill name |
|
||||
| MF003 | Low | Invalid skill name format |
|
||||
| MF004 | Info | Missing skill description |
|
||||
| MF005 | Info | Short skill description |
|
||||
| MF006 | High | Dangerous tool in allowed-tools (Bash, shell) |
|
||||
| MF007 | High | Impersonation (claiming official affiliation) |
|
||||
| MF008 | Medium | Binary files in skill directory |
|
||||
|
||||
## Analyzers
|
||||
|
||||
The scanner uses three analyzers that run in parallel:
|
||||
|
||||
| Analyzer | Purpose | Rules |
|
||||
|----------|---------|-------|
|
||||
| **StaticAnalyzer** | Regex pattern matching against security rules | PI, CI, DE, TA, UC |
|
||||
| **ManifestAnalyzer** | SKILL.md frontmatter validation | MF |
|
||||
| **SecretsAnalyzer** | Credential and secret detection | SK |
|
||||
|
||||
## Output Formats
|
||||
|
||||
### Summary (default)
|
||||
|
||||
Colored terminal output with severity indicators, file locations, snippets, and remediation advice.
|
||||
|
||||
### JSON
|
||||
|
||||
Machine-readable JSON with all findings, stats, and verdict.
|
||||
|
||||
```bash
|
||||
skillkit scan ./my-skill --format json | jq '.findings[] | {ruleId, severity, title}'
|
||||
```
|
||||
|
||||
### Table
|
||||
|
||||
Tabular format for quick review:
|
||||
|
||||
```bash
|
||||
skillkit scan ./my-skill --format table
|
||||
```
|
||||
|
||||
### SARIF
|
||||
|
||||
SARIF v2.1 for GitHub Code Scanning and IDE integration:
|
||||
|
||||
```bash
|
||||
skillkit scan ./my-skill --format sarif > results.sarif
|
||||
```
|
||||
|
||||
Upload to GitHub:
|
||||
|
||||
```bash
|
||||
gh api repos/{owner}/{repo}/code-scanning/sarifs \
|
||||
-f "sarif=$(gzip -c results.sarif | base64)"
|
||||
```
|
||||
|
||||
## CI/CD Integration
|
||||
|
||||
### GitHub Actions
|
||||
|
||||
```yaml
|
||||
- name: Scan skills
|
||||
run: npx skillkit scan ./skills --format sarif --fail-on high > results.sarif
|
||||
|
||||
- name: Upload SARIF
|
||||
uses: github/codeql-action/upload-sarif@v3
|
||||
with:
|
||||
sarif_file: results.sarif
|
||||
```
|
||||
|
||||
### Pre-commit Hook
|
||||
|
||||
```bash
|
||||
skillkit scan . --fail-on medium
|
||||
```
|
||||
|
||||
## Programmatic Usage
|
||||
|
||||
```typescript
|
||||
import { SkillScanner, formatResult } from '@skillkit/core';
|
||||
|
||||
const scanner = new SkillScanner({
|
||||
failOnSeverity: 'high',
|
||||
skipRules: ['UC001', 'MF004'],
|
||||
});
|
||||
|
||||
const result = await scanner.scan('./my-skill');
|
||||
|
||||
console.log(formatResult(result, 'summary'));
|
||||
console.log(`Verdict: ${result.verdict}`);
|
||||
console.log(`Findings: ${result.findings.length}`);
|
||||
```
|
||||
|
||||
## Severity Levels
|
||||
|
||||
| Level | Exit Code | Description |
|
||||
|-------|-----------|-------------|
|
||||
| **Critical** | 1 (with `--fail-on critical`) | Immediate security threat |
|
||||
| **High** | 1 (with `--fail-on high`, default) | Significant security risk |
|
||||
| **Medium** | 1 (with `--fail-on medium`) | Potential security concern |
|
||||
| **Low** | 1 (with `--fail-on low`) | Minor issue or best practice |
|
||||
| **Info** | 0 | Informational finding |
|
||||
|
||||
## False Positive Handling
|
||||
|
||||
The scanner automatically filters:
|
||||
|
||||
- **Placeholder patterns**: `your-api-key`, `example`, `sample`, `dummy`, `xxx`
|
||||
- **Test files**: `*.test.ts`, `*.spec.ts`, `__tests__/`
|
||||
- **Import statements**: `import ... from '../'` (not path traversal)
|
||||
- **Comments**: Code comments mentioning patterns
|
||||
- **Security discussions**: Text discussing jailbreaks or vulnerabilities (uses negative lookbehind)
|
||||
|
||||
To skip specific rules:
|
||||
|
||||
```bash
|
||||
skillkit scan . --skip-rules UC001,UC002,MF004
|
||||
```
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "skillkit-docs",
|
||||
"version": "1.14.0",
|
||||
"version": "1.19.0",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"build": "next build",
|
||||
@@ -21,7 +21,8 @@
|
||||
"next-themes": "^0.4.6",
|
||||
"react": "^19.2.3",
|
||||
"react-dom": "^19.2.3",
|
||||
"tailwind-merge": "^3.4.0"
|
||||
"tailwind-merge": "^3.4.0",
|
||||
"turndown": "^7.2.2"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@tailwindcss/postcss": "^4.1.18",
|
||||
@@ -29,6 +30,7 @@
|
||||
"@types/node": "^24.10.2",
|
||||
"@types/react": "^19.2.7",
|
||||
"@types/react-dom": "^19.2.3",
|
||||
"@types/turndown": "^5.0.6",
|
||||
"postcss": "^8.5.6",
|
||||
"tailwindcss": "^4.1.18",
|
||||
"typescript": "^5.9.3"
|
||||
|
||||
@@ -0,0 +1,291 @@
|
||||
import { NextRequest, NextResponse } from 'next/server';
|
||||
import TurndownService from 'turndown';
|
||||
|
||||
const rateLimitMap = new Map<string, { count: number; resetTime: number }>();
|
||||
const RATE_LIMIT_WINDOW_MS = 60 * 1000;
|
||||
const RATE_LIMIT_MAX_REQUESTS = 10;
|
||||
|
||||
function checkRateLimit(key: string): { allowed: boolean; remaining: number } {
|
||||
const now = Date.now();
|
||||
const entry = rateLimitMap.get(key);
|
||||
|
||||
if (!entry || now > entry.resetTime) {
|
||||
rateLimitMap.set(key, { count: 1, resetTime: now + RATE_LIMIT_WINDOW_MS });
|
||||
return { allowed: true, remaining: RATE_LIMIT_MAX_REQUESTS - 1 };
|
||||
}
|
||||
|
||||
if (entry.count >= RATE_LIMIT_MAX_REQUESTS) {
|
||||
return { allowed: false, remaining: 0 };
|
||||
}
|
||||
|
||||
entry.count++;
|
||||
return { allowed: true, remaining: RATE_LIMIT_MAX_REQUESTS - entry.count };
|
||||
}
|
||||
|
||||
const BLOCKED_HOSTS = new Set(['localhost', '127.0.0.1', '[::1]', '::1', '0.0.0.0']);
|
||||
|
||||
function isAllowedUrl(url: string): boolean {
|
||||
try {
|
||||
const parsed = new URL(url);
|
||||
if (parsed.protocol !== 'http:' && parsed.protocol !== 'https:') return false;
|
||||
|
||||
const hostname = parsed.hostname.toLowerCase();
|
||||
const bare = hostname.replace(/^\[|\]$/g, '');
|
||||
|
||||
if (BLOCKED_HOSTS.has(hostname) || BLOCKED_HOSTS.has(bare)) return false;
|
||||
if (bare.startsWith('::ffff:')) return isAllowedUrl(`http://${bare.slice(7)}`);
|
||||
if (/^127\./.test(bare) || /^0\./.test(bare)) return false;
|
||||
if (bare.startsWith('10.') || bare.startsWith('192.168.')) return false;
|
||||
if (/^172\.(1[6-9]|2\d|3[01])\./.test(bare)) return false;
|
||||
if (bare.startsWith('169.254.')) return false;
|
||||
if (bare.startsWith('fe80:') || bare.startsWith('fc00:') || bare.startsWith('fd')) return false;
|
||||
if (/^(22[4-9]|23\d|24\d|25[0-5])\./.test(bare)) return false;
|
||||
if (/^ff[0-9a-f]{2}:/.test(bare)) return false;
|
||||
return true;
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
const GITHUB_URL_PATTERN = /^https?:\/\/github\.com\/([^/]+)\/([^/]+)\/blob\/([^/]+)\/(.+)$/;
|
||||
const GITHUB_RAW_PATTERN = /^https?:\/\/raw\.githubusercontent\.com\//;
|
||||
const FETCH_TIMEOUT = 30_000;
|
||||
|
||||
const TECH_KEYWORDS = new Set([
|
||||
'react', 'vue', 'angular', 'svelte', 'nextjs', 'nuxt', 'remix',
|
||||
'typescript', 'javascript', 'python', 'rust', 'go', 'java', 'ruby',
|
||||
'node', 'deno', 'bun', 'docker', 'kubernetes', 'terraform',
|
||||
'aws', 'gcp', 'azure', 'vercel', 'netlify', 'cloudflare',
|
||||
'graphql', 'rest', 'grpc', 'websocket', 'redis', 'postgres',
|
||||
'mongodb', 'sqlite', 'mysql', 'prisma', 'drizzle',
|
||||
'tailwind', 'css', 'html', 'sass', 'webpack', 'vite', 'esbuild',
|
||||
'git', 'ci', 'cd', 'testing', 'security', 'authentication',
|
||||
'api', 'cli', 'sdk', 'mcp', 'llm', 'ai', 'ml', 'openai', 'anthropic',
|
||||
]);
|
||||
|
||||
const TAG_PATTERN = /^[a-z0-9]+(-[a-z0-9]+)*$/;
|
||||
|
||||
const turndown = new TurndownService({ headingStyle: 'atx', codeBlockStyle: 'fenced' });
|
||||
|
||||
interface ExtractedContent {
|
||||
title: string;
|
||||
content: string;
|
||||
sourceUrl: string;
|
||||
contentType: string;
|
||||
language?: string;
|
||||
}
|
||||
|
||||
async function extractFromUrl(url: string): Promise<ExtractedContent> {
|
||||
if (GITHUB_URL_PATTERN.test(url) || GITHUB_RAW_PATTERN.test(url)) {
|
||||
return fetchGitHubContent(url);
|
||||
}
|
||||
|
||||
const MAX_BODY_SIZE = 5 * 1024 * 1024;
|
||||
const response = await fetch(url, { signal: AbortSignal.timeout(FETCH_TIMEOUT) });
|
||||
if (!response.ok) {
|
||||
throw new Error(`Failed to fetch ${url}: ${response.status} ${response.statusText}`);
|
||||
}
|
||||
|
||||
const contentLength = Number(response.headers.get('content-length') || '0');
|
||||
if (contentLength > MAX_BODY_SIZE) {
|
||||
throw new Error('Response too large');
|
||||
}
|
||||
|
||||
const contentType = response.headers.get('content-type') ?? '';
|
||||
const body = await response.text();
|
||||
if (body.length > MAX_BODY_SIZE) {
|
||||
throw new Error('Response too large');
|
||||
}
|
||||
|
||||
if (contentType.includes('text/html')) {
|
||||
const titleMatch = body.match(/<title[^>]*>([^<]+)<\/title>/i);
|
||||
const title = titleMatch?.[1]?.trim() ?? new URL(url).hostname;
|
||||
const bodyMatch = body.match(/<body[^>]*>([\s\S]*)<\/body>/i);
|
||||
const content = turndown.turndown(bodyMatch?.[1] ?? body);
|
||||
return { title, content, sourceUrl: url, contentType: 'webpage' };
|
||||
}
|
||||
|
||||
const title = new URL(url).pathname.split('/').pop() ?? 'Untitled';
|
||||
return { title, content: body, sourceUrl: url, contentType: 'text' };
|
||||
}
|
||||
|
||||
const LANG_MAP: Record<string, string> = {
|
||||
'.ts': 'typescript', '.tsx': 'typescript', '.js': 'javascript', '.jsx': 'javascript',
|
||||
'.py': 'python', '.rb': 'ruby', '.go': 'go', '.rs': 'rust', '.java': 'java',
|
||||
'.kt': 'kotlin', '.swift': 'swift', '.sh': 'shell', '.yml': 'yaml', '.yaml': 'yaml',
|
||||
'.json': 'json', '.md': 'markdown', '.html': 'html', '.css': 'css', '.sql': 'sql',
|
||||
};
|
||||
|
||||
async function fetchGitHubContent(url: string): Promise<ExtractedContent> {
|
||||
let rawUrl = url;
|
||||
const match = url.match(GITHUB_URL_PATTERN);
|
||||
if (match) {
|
||||
const [, owner, repo, branch, path] = match;
|
||||
rawUrl = `https://raw.githubusercontent.com/${owner}/${repo}/${branch}/${path}`;
|
||||
}
|
||||
|
||||
const MAX_BODY_SIZE = 5 * 1024 * 1024;
|
||||
const response = await fetch(rawUrl, { signal: AbortSignal.timeout(FETCH_TIMEOUT) });
|
||||
if (!response.ok) {
|
||||
throw new Error(`Failed to fetch GitHub content: ${response.status} ${response.statusText}`);
|
||||
}
|
||||
|
||||
const contentLength = Number(response.headers.get('content-length') || '0');
|
||||
if (contentLength > MAX_BODY_SIZE) {
|
||||
throw new Error('Response too large');
|
||||
}
|
||||
|
||||
const body = await response.text();
|
||||
if (body.length > MAX_BODY_SIZE) {
|
||||
throw new Error('Response too large');
|
||||
}
|
||||
const filename = rawUrl.split('/').pop() ?? 'file';
|
||||
const ext = filename.includes('.') ? '.' + filename.split('.').pop()!.toLowerCase() : '';
|
||||
const language = LANG_MAP[ext];
|
||||
const isCode = language !== undefined && language !== 'markdown';
|
||||
const content = isCode ? `\`\`\`${language}\n${body}\n\`\`\`` : body;
|
||||
|
||||
return { title: filename, content, sourceUrl: url, contentType: 'github', language };
|
||||
}
|
||||
|
||||
function addTag(counts: Map<string, number>, tag: string, weight: number): void {
|
||||
if (TAG_PATTERN.test(tag)) {
|
||||
counts.set(tag, (counts.get(tag) ?? 0) + weight);
|
||||
}
|
||||
}
|
||||
|
||||
function detectTags(extracted: ExtractedContent): string[] {
|
||||
const counts = new Map<string, number>();
|
||||
|
||||
try {
|
||||
const segments = new URL(extracted.sourceUrl).pathname
|
||||
.split('/').filter(Boolean)
|
||||
.map((s) => s.toLowerCase().replace(/[^a-z0-9-]/g, ''));
|
||||
for (const seg of segments) {
|
||||
if (seg.length >= 2 && seg.length <= 30) {
|
||||
addTag(counts, seg, 2);
|
||||
}
|
||||
}
|
||||
} catch { /* skip */ }
|
||||
|
||||
const headingRe = /^#{1,2}\s+(.+)$/gm;
|
||||
let m: RegExpExecArray | null;
|
||||
while ((m = headingRe.exec(extracted.content)) !== null) {
|
||||
for (const word of m[1].toLowerCase().split(/\s+/)) {
|
||||
const cleaned = word.replace(/[^a-z0-9-]/g, '');
|
||||
if (cleaned.length >= 2) {
|
||||
addTag(counts, cleaned, 2);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
const codeBlockRe = /^```(\w+)/gm;
|
||||
while ((m = codeBlockRe.exec(extracted.content)) !== null) {
|
||||
const lang = m[1].toLowerCase();
|
||||
if (lang.length >= 2) {
|
||||
addTag(counts, lang, 3);
|
||||
}
|
||||
}
|
||||
|
||||
const lower = extracted.content.toLowerCase();
|
||||
for (const keyword of TECH_KEYWORDS) {
|
||||
if (new RegExp(`\\b${keyword}\\b`, 'i').test(lower)) {
|
||||
addTag(counts, keyword, 1);
|
||||
}
|
||||
}
|
||||
|
||||
if (extracted.language) {
|
||||
addTag(counts, extracted.language.toLowerCase(), 3);
|
||||
}
|
||||
|
||||
return Array.from(counts.entries())
|
||||
.sort((a, b) => b[1] - a[1])
|
||||
.slice(0, 10)
|
||||
.map(([tag]) => tag);
|
||||
}
|
||||
|
||||
function slugify(input: string): string {
|
||||
const slug = input
|
||||
.toLowerCase()
|
||||
.replace(/[^a-z0-9]+/g, '-')
|
||||
.replace(/^-+|-+$/g, '')
|
||||
.replace(/-{2,}/g, '-');
|
||||
return slug.slice(0, 64).replace(/-+$/, '') || 'untitled-skill';
|
||||
}
|
||||
|
||||
function yamlEscape(value: string): string {
|
||||
const singleLine = value.replace(/\r?\n/g, ' ').trim();
|
||||
if (/[:#{}[\],&*?|>!%@`]/.test(singleLine) || singleLine.startsWith("'") || singleLine.startsWith('"')) {
|
||||
return `"${singleLine.replace(/\\/g, '\\\\').replace(/"/g, '\\"')}"`;
|
||||
}
|
||||
return singleLine;
|
||||
}
|
||||
|
||||
export async function POST(request: NextRequest) {
|
||||
const ip = request.headers.get('x-forwarded-for')?.split(',')[0]?.trim() ?? 'unknown';
|
||||
const { allowed, remaining } = checkRateLimit(ip);
|
||||
|
||||
if (!allowed) {
|
||||
return NextResponse.json(
|
||||
{ error: 'Too many requests. Try again in a minute.' },
|
||||
{ status: 429, headers: { 'X-RateLimit-Remaining': '0', 'Retry-After': '60' } },
|
||||
);
|
||||
}
|
||||
|
||||
let body: { url?: string; name?: string };
|
||||
try {
|
||||
body = await request.json();
|
||||
} catch {
|
||||
return NextResponse.json({ error: 'Invalid JSON body' }, { status: 400 });
|
||||
}
|
||||
|
||||
const { url, name } = body;
|
||||
if (!url || typeof url !== 'string') {
|
||||
return NextResponse.json({ error: 'Missing required field: url' }, { status: 400 });
|
||||
}
|
||||
|
||||
if (name !== undefined && typeof name !== 'string') {
|
||||
return NextResponse.json({ error: 'Field "name" must be a string' }, { status: 400 });
|
||||
}
|
||||
|
||||
if (!isAllowedUrl(url)) {
|
||||
return NextResponse.json({ error: 'URL not allowed' }, { status: 403 });
|
||||
}
|
||||
|
||||
try {
|
||||
const extracted = await extractFromUrl(url);
|
||||
const tags = detectTags(extracted);
|
||||
|
||||
const skillName = slugify(name || extracted.title || 'untitled');
|
||||
const description = extracted.content
|
||||
.split('\n')
|
||||
.find((l) => l.trim().length > 0)
|
||||
?.replace(/^#+\s*/, '')
|
||||
.trim()
|
||||
.slice(0, 200) || 'Saved skill';
|
||||
const savedAt = new Date().toISOString();
|
||||
|
||||
const yamlTags = tags.length > 0
|
||||
? `tags:\n${tags.map((t) => ` - ${t}`).join('\n')}\n`
|
||||
: '';
|
||||
|
||||
const skillMd =
|
||||
`---\n` +
|
||||
`name: ${skillName}\n` +
|
||||
`description: ${yamlEscape(description)}\n` +
|
||||
yamlTags +
|
||||
`metadata:\n` +
|
||||
` source: ${yamlEscape(url)}\n` +
|
||||
` savedAt: ${savedAt}\n` +
|
||||
`---\n\n` +
|
||||
extracted.content + '\n';
|
||||
|
||||
return NextResponse.json(
|
||||
{ name: skillName, skillMd, tags, description },
|
||||
{ headers: { 'X-RateLimit-Remaining': String(remaining) } },
|
||||
);
|
||||
} catch (err) {
|
||||
const message = err instanceof Error ? err.message : 'Failed to extract content';
|
||||
return NextResponse.json({ error: message }, { status: 502 });
|
||||
}
|
||||
}
|
||||
@@ -33,6 +33,15 @@ const COMMAND_GROUPS: CommandGroup[] = [
|
||||
{ cmd: 'publish', desc: 'Submit to marketplace' },
|
||||
],
|
||||
},
|
||||
{
|
||||
name: 'Security',
|
||||
commands: [
|
||||
{ cmd: 'scan <path>', desc: 'Security vulnerability scanner' },
|
||||
{ cmd: 'scan --format sarif', desc: 'SARIF for GitHub Code Scanning' },
|
||||
{ cmd: 'scan --fail-on high', desc: 'CI security gate' },
|
||||
{ cmd: 'audit log', desc: 'View audit trail' },
|
||||
],
|
||||
},
|
||||
{
|
||||
name: 'Advanced',
|
||||
commands: [
|
||||
|
||||
+35
-22
@@ -1,4 +1,4 @@
|
||||
<svg width="1200" height="400" viewBox="0 0 1200 400" xmlns="http://www.w3.org/2000/svg">
|
||||
<svg width="1200" height="420" viewBox="0 0 1200 420" xmlns="http://www.w3.org/2000/svg">
|
||||
<defs>
|
||||
<linearGradient id="bg" x1="0%" y1="0%" x2="100%" y2="100%">
|
||||
<stop offset="0%" style="stop-color:#0a0a0a"/>
|
||||
@@ -10,48 +10,61 @@
|
||||
<stop offset="50%" style="stop-color:#555"/>
|
||||
<stop offset="100%" style="stop-color:#333"/>
|
||||
</linearGradient>
|
||||
<linearGradient id="accent" x1="0%" y1="0%" x2="100%" y2="0%">
|
||||
<stop offset="0%" style="stop-color:#666"/>
|
||||
<stop offset="100%" style="stop-color:#999"/>
|
||||
<linearGradient id="ph-badge" x1="0%" y1="0%" x2="0%" y2="100%">
|
||||
<stop offset="0%" style="stop-color:#2a2a2a"/>
|
||||
<stop offset="100%" style="stop-color:#1a1a1a"/>
|
||||
</linearGradient>
|
||||
</defs>
|
||||
|
||||
<rect width="1200" height="400" fill="url(#bg)" rx="12"/>
|
||||
<rect x="1" y="1" width="1198" height="398" fill="none" stroke="url(#border)" stroke-width="1" rx="12"/>
|
||||
<rect width="1200" height="420" fill="url(#bg)" rx="12"/>
|
||||
<rect x="1" y="1" width="1198" height="418" fill="none" stroke="url(#border)" stroke-width="1" rx="12"/>
|
||||
|
||||
<line x1="60" y1="340" x2="1140" y2="340" stroke="#1a1a1a" stroke-width="1"/>
|
||||
<line x1="60" y1="350" x2="1140" y2="350" stroke="#1a1a1a" stroke-width="1"/>
|
||||
|
||||
<g transform="translate(60, 80)">
|
||||
<g transform="translate(60, 72)">
|
||||
<rect width="16" height="16" fill="white" rx="2"/>
|
||||
</g>
|
||||
|
||||
<text x="90" y="94" font-family="'SF Mono', 'Fira Code', 'JetBrains Mono', Consolas, monospace" font-size="20" font-weight="700" fill="white" letter-spacing="3">SKILLKIT</text>
|
||||
<text x="90" y="86" font-family="'SF Mono', 'Fira Code', 'JetBrains Mono', Consolas, monospace" font-size="20" font-weight="700" fill="white" letter-spacing="3">SKILLKIT</text>
|
||||
|
||||
<text x="600" y="200" font-family="'SF Mono', 'Fira Code', 'JetBrains Mono', Consolas, monospace" font-size="62" font-weight="700" fill="white" text-anchor="middle" letter-spacing="-1">One Skill. 32 Agents.</text>
|
||||
<g transform="translate(890, 58)">
|
||||
<rect width="250" height="40" fill="url(#ph-badge)" stroke="#444" stroke-width="1" rx="20"/>
|
||||
<circle cx="28" cy="20" r="14" fill="none" stroke="#666" stroke-width="1.5"/>
|
||||
<text x="28" y="25" font-family="system-ui, sans-serif" font-size="16" font-weight="700" fill="white" text-anchor="middle">P</text>
|
||||
<text x="54" y="16" font-family="system-ui, sans-serif" font-size="9" font-weight="600" fill="#888" letter-spacing="1">PRODUCT HUNT</text>
|
||||
<text x="54" y="30" font-family="system-ui, sans-serif" font-size="13" font-weight="700" fill="white">#3 Product of the Day</text>
|
||||
</g>
|
||||
|
||||
<text x="600" y="200" font-family="'SF Mono', 'Fira Code', 'JetBrains Mono', Consolas, monospace" font-size="62" font-weight="700" fill="white" text-anchor="middle" letter-spacing="-1">One Skill. 44 Agents.</text>
|
||||
|
||||
<text x="600" y="248" font-family="'SF Mono', 'Fira Code', 'JetBrains Mono', Consolas, monospace" font-size="20" fill="#888" text-anchor="middle" letter-spacing="0.5">The open source package manager for AI agent skills</text>
|
||||
|
||||
<g transform="translate(280, 280)">
|
||||
<rect width="280" height="40" fill="#1a1a1a" stroke="#333" stroke-width="1" rx="6"/>
|
||||
<text x="16" y="26" font-family="'SF Mono', 'Fira Code', monospace" font-size="14" fill="#666">$</text>
|
||||
<text x="32" y="26" font-family="'SF Mono', 'Fira Code', monospace" font-size="14" fill="#ccc">npx skillkit@latest</text>
|
||||
<g transform="translate(240, 282)">
|
||||
<rect width="260" height="38" fill="#1a1a1a" stroke="#333" stroke-width="1" rx="6"/>
|
||||
<text x="16" y="25" font-family="'SF Mono', 'Fira Code', monospace" font-size="14" fill="#666">$</text>
|
||||
<text x="32" y="25" font-family="'SF Mono', 'Fira Code', monospace" font-size="14" fill="#ccc">npx skillkit@latest</text>
|
||||
</g>
|
||||
|
||||
<g transform="translate(580, 280)">
|
||||
<rect width="160" height="40" fill="transparent" stroke="#444" stroke-width="1" rx="6"/>
|
||||
<text x="80" y="26" font-family="'SF Mono', 'Fira Code', monospace" font-size="14" fill="#999" text-anchor="middle">15,000+ skills</text>
|
||||
<g transform="translate(520, 282)">
|
||||
<rect width="150" height="38" fill="transparent" stroke="#444" stroke-width="1" rx="6"/>
|
||||
<text x="75" y="25" font-family="'SF Mono', 'Fira Code', monospace" font-size="14" fill="#999" text-anchor="middle">15,000+ skills</text>
|
||||
</g>
|
||||
|
||||
<g transform="translate(760, 280)">
|
||||
<rect width="160" height="40" fill="transparent" stroke="#444" stroke-width="1" rx="6"/>
|
||||
<text x="80" y="26" font-family="'SF Mono', 'Fira Code', monospace" font-size="14" fill="#999" text-anchor="middle">Zero rewrites</text>
|
||||
<g transform="translate(690, 282)">
|
||||
<rect width="140" height="38" fill="transparent" stroke="#444" stroke-width="1" rx="6"/>
|
||||
<text x="70" y="25" font-family="'SF Mono', 'Fira Code', monospace" font-size="14" fill="#999" text-anchor="middle">Zero rewrites</text>
|
||||
</g>
|
||||
|
||||
<g transform="translate(60, 355)">
|
||||
<g transform="translate(850, 282)">
|
||||
<rect width="120" height="38" fill="transparent" stroke="#444" stroke-width="1" rx="6"/>
|
||||
<text x="60" y="25" font-family="'SF Mono', 'Fira Code', monospace" font-size="14" fill="#999" text-anchor="middle">Apache-2.0</text>
|
||||
</g>
|
||||
|
||||
<g transform="translate(60, 370)">
|
||||
<circle cx="5" cy="5" r="3" fill="#666"/>
|
||||
<circle cx="15" cy="5" r="3" fill="#555"/>
|
||||
<circle cx="25" cy="5" r="3" fill="#444"/>
|
||||
<circle cx="35" cy="5" r="3" fill="#333"/>
|
||||
<text x="50" y="9" font-family="'SF Mono', monospace" font-size="11" fill="#444">Claude Cursor Codex Gemini Copilot Windsurf OpenCode +25 more</text>
|
||||
<text x="50" y="9" font-family="'SF Mono', monospace" font-size="11" fill="#444">Claude Cursor Codex Gemini Copilot Windsurf Devin Aider Cody +35 more</text>
|
||||
</g>
|
||||
</svg>
|
||||
|
||||
|
Before Width: | Height: | Size: 3.0 KiB After Width: | Height: | Size: 3.9 KiB |
+13
-19
@@ -98,6 +98,14 @@ export default function App(): React.ReactElement {
|
||||
>
|
||||
Generator
|
||||
</a>
|
||||
<a
|
||||
href="https://github.com/rohitg00/skillkit/tree/main/packages/extension#readme"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
className="text-zinc-500 hover:text-white transition-colors"
|
||||
>
|
||||
Extension
|
||||
</a>
|
||||
</div>
|
||||
<div className="flex items-center gap-3 sm:gap-4">
|
||||
<a
|
||||
@@ -123,7 +131,7 @@ export default function App(): React.ReactElement {
|
||||
<svg className="w-3.5 h-3.5 text-zinc-500 group-hover:text-yellow-500 transition-colors" fill="currentColor" viewBox="0 0 24 24">
|
||||
<path d="M12 2l3.09 6.26L22 9.27l-5 4.87 1.18 6.88L12 17.77l-6.18 3.25L7 14.14 2 9.27l6.91-1.01L12 2z" />
|
||||
</svg>
|
||||
<span className="text-xs font-mono text-zinc-400 group-hover:text-white transition-colors">{stats.stars}</span>
|
||||
<span className="text-xs font-mono text-zinc-400 group-hover:text-white transition-colors">{stats.stars || '—'}</span>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -131,7 +139,7 @@ export default function App(): React.ReactElement {
|
||||
</nav>
|
||||
|
||||
<main className="pt-14">
|
||||
<Hero version={stats.version} stars={stats.stars} />
|
||||
<Hero version={stats.version || '—'} stars={stats.stars || '—'} />
|
||||
|
||||
<div className="border-b border-zinc-800/50 py-2.5" style={{ background: 'linear-gradient(to bottom, rgba(9,9,11,0.95), rgba(0,0,0,1))' }}>
|
||||
<div className="mx-auto max-w-5xl px-4 sm:px-6 lg:px-8">
|
||||
@@ -143,7 +151,7 @@ export default function App(): React.ReactElement {
|
||||
className="flex items-center gap-1.5 text-zinc-500 hover:text-white transition-colors group"
|
||||
>
|
||||
<span className="text-zinc-600 group-hover:text-zinc-400">v</span>
|
||||
<span className="text-white font-medium">{stats.version}</span>
|
||||
<span className="text-white font-medium">{stats.version || '—'}</span>
|
||||
</a>
|
||||
<span className="text-zinc-800">·</span>
|
||||
<a
|
||||
@@ -155,7 +163,7 @@ export default function App(): React.ReactElement {
|
||||
<svg className="w-3 h-3 text-zinc-600 group-hover:text-zinc-400" fill="none" viewBox="0 0 24 24" stroke="currentColor">
|
||||
<path strokeLinecap="round" strokeLinejoin="round" strokeWidth={2} d="M4 16v1a3 3 0 003 3h10a3 3 0 003-3v-1m-4-4l-4 4m0 0l-4-4m4 4V4" />
|
||||
</svg>
|
||||
<span className="text-white font-medium">{stats.downloads}</span>
|
||||
<span className="text-white font-medium">{stats.downloads || '—'}</span>
|
||||
</a>
|
||||
<span className="text-zinc-800">·</span>
|
||||
<a
|
||||
@@ -167,21 +175,7 @@ export default function App(): React.ReactElement {
|
||||
<svg className="w-3 h-3 text-zinc-600 group-hover:text-yellow-500" fill="currentColor" viewBox="0 0 24 24">
|
||||
<path d="M12 2l3.09 6.26L22 9.27l-5 4.87 1.18 6.88L12 17.77l-6.18 3.25L7 14.14 2 9.27l6.91-1.01L12 2z" />
|
||||
</svg>
|
||||
<span className="text-white font-medium">{stats.stars}</span>
|
||||
</a>
|
||||
<span className="text-zinc-800 hidden sm:inline">·</span>
|
||||
<a
|
||||
href="https://www.producthunt.com/products/skillkit-2?embed=true&utm_source=badge-featured&utm_medium=badge&utm_campaign=badge-skillkit-2"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
className="hidden sm:inline-flex items-center hover:opacity-80 transition-opacity"
|
||||
>
|
||||
<img
|
||||
src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=1071813&theme=dark"
|
||||
alt="SkillKit on Product Hunt"
|
||||
height="28"
|
||||
style={{ height: '28px', width: 'auto' }}
|
||||
/>
|
||||
<span className="text-white font-medium">{stats.stars || '—'}</span>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -51,8 +51,8 @@ const ADVANCED_FEATURES: AdvancedFeature[] = [
|
||||
id: 'primer',
|
||||
title: 'Primer',
|
||||
subtitle: 'Zero-Config AI Instructions',
|
||||
description: 'Automatically generate CLAUDE.md, .cursorrules, and agent instructions by analyzing your codebase. Detects your tech stack, coding patterns, and project structure—then creates optimized instructions for all 32 agents.',
|
||||
highlight: 'Auto-generates instructions for 32 agents',
|
||||
description: 'Automatically generate CLAUDE.md, .cursorrules, and agent instructions by analyzing your codebase. Detects your tech stack, coding patterns, and project structure—then creates optimized instructions for all 44 agents.',
|
||||
highlight: 'Auto-generates instructions for 44 agents',
|
||||
icon: (
|
||||
<svg className="w-8 h-8" fill="none" viewBox="0 0 24 24" stroke="currentColor">
|
||||
<path strokeLinecap="round" strokeLinejoin="round" strokeWidth={1.5} d="M9 5H7a2 2 0 00-2 2v12a2 2 0 002 2h10a2 2 0 002-2V7a2 2 0 00-2-2h-2M9 5a2 2 0 002 2h2a2 2 0 002-2M9 5a2 2 0 012-2h2a2 2 0 012 2m-3 7h3m-3 4h3m-6-4h.01M9 16h.01" />
|
||||
@@ -60,7 +60,7 @@ const ADVANCED_FEATURES: AdvancedFeature[] = [
|
||||
),
|
||||
commands: [
|
||||
{ cmd: 'primer', desc: 'Analyze & generate for detected agents' },
|
||||
{ cmd: 'primer --all-agents', desc: 'Generate for all 32 agents' },
|
||||
{ cmd: 'primer --all-agents', desc: 'Generate for all 44 agents' },
|
||||
{ cmd: 'primer --analyze-only', desc: 'Preview codebase analysis' },
|
||||
{ cmd: 'primer --json', desc: 'Machine-readable output' },
|
||||
],
|
||||
|
||||
@@ -312,7 +312,7 @@ export function Agents(): React.ReactElement {
|
||||
<section className="py-6 border-b border-zinc-800 overflow-hidden">
|
||||
<div className="mx-auto max-w-5xl px-4 sm:px-6 lg:px-8">
|
||||
<p className="text-zinc-500 font-mono text-[11px] uppercase tracking-widest mb-6 text-center">
|
||||
Works with 32 AI Agents
|
||||
Works with 44 AI Agents
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -82,6 +82,28 @@ const COMMAND_GROUPS: CommandGroup[] = [
|
||||
{ cmd: 'serve --cache-ttl 3600000', desc: 'Cache TTL' },
|
||||
],
|
||||
},
|
||||
{
|
||||
name: 'Security',
|
||||
commands: [
|
||||
{ cmd: 'scan <path>', desc: 'Security scan' },
|
||||
{ cmd: 'scan --format sarif', desc: 'SARIF output' },
|
||||
{ cmd: 'scan --fail-on high', desc: 'CI gate' },
|
||||
{ cmd: 'install --no-scan', desc: 'Skip scan' },
|
||||
{ cmd: 'audit log', desc: 'View audit logs' },
|
||||
{ cmd: 'validate', desc: 'Validate format' },
|
||||
],
|
||||
},
|
||||
{
|
||||
name: 'Issues',
|
||||
commands: [
|
||||
{ cmd: 'issue plan "#42"', desc: 'Plan from issue' },
|
||||
{ cmd: 'issue plan owner/repo#42', desc: 'Cross-repo plan' },
|
||||
{ cmd: 'issue plan "#42" --agent cursor', desc: 'Target agent' },
|
||||
{ cmd: 'issue plan "#42" --json', desc: 'JSON output' },
|
||||
{ cmd: 'issue list', desc: 'List open issues' },
|
||||
{ cmd: 'issue list --label bug', desc: 'Filter by label' },
|
||||
],
|
||||
},
|
||||
{
|
||||
name: 'Advanced',
|
||||
commands: [
|
||||
|
||||
@@ -16,111 +16,106 @@ interface CategoryDef {
|
||||
}
|
||||
|
||||
const AGENTS: AgentDef[] = [
|
||||
{ id: 'claude-code', name: 'Claude Code', icon: '\u27C1', group: 'Tier 1' },
|
||||
{ id: 'claude-code', name: 'Claude', icon: '\u27C1', group: 'Tier 1' },
|
||||
{ id: 'cursor', name: 'Cursor', icon: '\u25EB', group: 'Tier 1' },
|
||||
{ id: 'codex', name: 'Codex', icon: '\u25CE', group: 'Tier 1' },
|
||||
{ id: 'gemini-cli', name: 'Gemini CLI', icon: '\u2726', group: 'Tier 1' },
|
||||
{ id: 'gemini-cli', name: 'Gemini', icon: '\u2726', group: 'Tier 1' },
|
||||
{ id: 'opencode', name: 'OpenCode', icon: '\u2B21', group: 'Tier 1' },
|
||||
{ id: 'windsurf', name: 'Windsurf', icon: '\u25C7', group: 'Tier 1' },
|
||||
{ id: 'github-copilot', name: 'Copilot', icon: '\u2318', group: 'Tier 1' },
|
||||
{ id: 'goose', name: 'Goose', icon: '\u25CA', group: 'Tier 2' },
|
||||
{ id: 'cline', name: 'Cline', icon: '\u25CF', group: 'Tier 1' },
|
||||
{ id: 'roo', name: 'Roo', icon: '\u25C6', group: 'Tier 2' },
|
||||
{ id: 'kilo', name: 'Kilo', icon: '\u25B3', group: 'Tier 2' },
|
||||
{ id: 'kiro-cli', name: 'Kiro CLI', icon: '\u25BD', group: 'Tier 2' },
|
||||
{ id: 'roo', name: 'Roo', icon: '\u25C6', group: 'Tier 2' },
|
||||
{ id: 'goose', name: 'Goose', icon: '\u25CA', group: 'Tier 2' },
|
||||
{ id: 'trae', name: 'Trae', icon: '\u25A0', group: 'Tier 2' },
|
||||
{ id: 'amp', name: 'AMP', icon: '\u26A1', group: 'Tier 2' },
|
||||
{ id: 'cline', name: 'Cline', icon: '\u25CF', group: 'Tier 3' },
|
||||
{ id: 'antigravity', name: 'Antigrav', icon: '\u2191', group: 'Tier 3' },
|
||||
{ id: 'continue', name: 'Continue', icon: '\u25B6', group: 'Tier 3' },
|
||||
{ id: 'antigravity', name: 'Antigravity', icon: '\u2191', group: 'Tier 3' },
|
||||
];
|
||||
|
||||
const CATEGORIES: CategoryDef[] = [
|
||||
{ id: 'security', name: 'Security', icon: '\u25D0' },
|
||||
{ id: 'testing', name: 'Testing', icon: '\u25D2' },
|
||||
{ id: 'react-frontend', name: 'React/Frontend', icon: '\u269B' },
|
||||
{ id: 'backend', name: 'Backend', icon: '\u2393' },
|
||||
{ id: 'devops', name: 'DevOps', icon: '\u25D1' },
|
||||
{ id: 'python', name: 'Python', icon: '\u25C9' },
|
||||
{ id: 'go', name: 'Go', icon: '\u25C8' },
|
||||
{ id: 'typescript', name: 'TypeScript', icon: '\u25C8' },
|
||||
{ id: 'database', name: 'Database', icon: '\u25A3' },
|
||||
{ id: 'performance', name: 'Performance', icon: '\u25CE' },
|
||||
{ id: 'documentation', name: 'Documentation', icon: '\u25A1' },
|
||||
{ id: 'ai-ml', name: 'AI/ML', icon: '\u25CE' },
|
||||
{ id: 'translation', name: 'Skill Translation', icon: '\u21C4' },
|
||||
{ id: 'hooks', name: 'Hooks', icon: '\u2693' },
|
||||
{ id: 'mcp-tools', name: 'MCP & Tools', icon: '\u2699' },
|
||||
{ id: 'context', name: 'Context Window', icon: '\u25A3' },
|
||||
{ id: 'security', name: 'Security Skills', icon: '\u25D0' },
|
||||
{ id: 'testing', name: 'Testing Skills', icon: '\u25D2' },
|
||||
{ id: 'frontend', name: 'Frontend Skills', icon: '\u269B' },
|
||||
{ id: 'backend', name: 'Backend Skills', icon: '\u2393' },
|
||||
{ id: 'devops', name: 'DevOps Skills', icon: '\u25D1' },
|
||||
{ id: 'docs', name: 'Documentation', icon: '\u25A1' },
|
||||
];
|
||||
|
||||
// Based on actual SkillKit translator, agent constraints, and compatibility scoring:
|
||||
// - claude-code, cline, roo: MCP + Tools + Hooks + large context (full support)
|
||||
// - cursor: 32K context, no MCP/tools, hooks need manual adjustment
|
||||
// - gemini-cli: 128K context, no MCP/tools, JSON-in-markdown format
|
||||
// - opencode: 100K context, no MCP/tools, XML skills format
|
||||
// - codex, github-copilot: 8K context, no MCP/tools (content condensed)
|
||||
// - windsurf: 32K context, no MCP/tools, workflow YAML format
|
||||
// - kilo, kiro-cli: XML block format, multi-mode support, no MCP
|
||||
// - goose, amp, antigravity, trae, continue: varies, mostly universal adapter
|
||||
const MATRIX: Record<string, Record<string, Support>> = {
|
||||
'security': {
|
||||
'translation': {
|
||||
'claude-code': 'full', 'cursor': 'full', 'codex': 'full', 'gemini-cli': 'full',
|
||||
'opencode': 'full', 'windsurf': 'full', 'github-copilot': 'full', 'goose': 'partial',
|
||||
'kilo': 'partial', 'kiro-cli': 'partial', 'roo': 'full', 'trae': 'partial',
|
||||
'amp': 'full', 'cline': 'full', 'continue': 'partial', 'antigravity': 'partial',
|
||||
'opencode': 'full', 'windsurf': 'full', 'github-copilot': 'full', 'cline': 'full',
|
||||
'roo': 'full', 'kilo': 'full', 'kiro-cli': 'partial', 'goose': 'full',
|
||||
'trae': 'full', 'amp': 'full', 'antigravity': 'full', 'continue': 'full',
|
||||
},
|
||||
'hooks': {
|
||||
'claude-code': 'full', 'cursor': 'partial', 'codex': 'partial', 'gemini-cli': 'partial',
|
||||
'opencode': 'partial', 'windsurf': 'none', 'github-copilot': 'none', 'cline': 'full',
|
||||
'roo': 'full', 'kilo': 'partial', 'kiro-cli': 'partial', 'goose': 'partial',
|
||||
'trae': 'partial', 'amp': 'partial', 'antigravity': 'none', 'continue': 'none',
|
||||
},
|
||||
'mcp-tools': {
|
||||
'claude-code': 'full', 'cursor': 'none', 'codex': 'none', 'gemini-cli': 'none',
|
||||
'opencode': 'none', 'windsurf': 'none', 'github-copilot': 'none', 'cline': 'full',
|
||||
'roo': 'full', 'kilo': 'none', 'kiro-cli': 'none', 'goose': 'none',
|
||||
'trae': 'none', 'amp': 'none', 'antigravity': 'none', 'continue': 'none',
|
||||
},
|
||||
'context': {
|
||||
'claude-code': 'full', 'cursor': 'partial', 'codex': 'partial', 'gemini-cli': 'full',
|
||||
'opencode': 'full', 'windsurf': 'partial', 'github-copilot': 'partial', 'cline': 'full',
|
||||
'roo': 'full', 'kilo': 'full', 'kiro-cli': 'full', 'goose': 'full',
|
||||
'trae': 'partial', 'amp': 'full', 'antigravity': 'partial', 'continue': 'partial',
|
||||
},
|
||||
'security': {
|
||||
'claude-code': 'full', 'cursor': 'full', 'codex': 'partial', 'gemini-cli': 'full',
|
||||
'opencode': 'full', 'windsurf': 'full', 'github-copilot': 'partial', 'cline': 'full',
|
||||
'roo': 'full', 'kilo': 'full', 'kiro-cli': 'full', 'goose': 'full',
|
||||
'trae': 'full', 'amp': 'full', 'antigravity': 'partial', 'continue': 'partial',
|
||||
},
|
||||
'testing': {
|
||||
'claude-code': 'full', 'cursor': 'full', 'codex': 'full', 'gemini-cli': 'full',
|
||||
'opencode': 'full', 'windsurf': 'full', 'github-copilot': 'full', 'goose': 'full',
|
||||
'kilo': 'partial', 'kiro-cli': 'partial', 'roo': 'full', 'trae': 'partial',
|
||||
'amp': 'full', 'cline': 'full', 'continue': 'full', 'antigravity': 'partial',
|
||||
'claude-code': 'full', 'cursor': 'full', 'codex': 'partial', 'gemini-cli': 'full',
|
||||
'opencode': 'full', 'windsurf': 'full', 'github-copilot': 'partial', 'cline': 'full',
|
||||
'roo': 'full', 'kilo': 'full', 'kiro-cli': 'full', 'goose': 'full',
|
||||
'trae': 'full', 'amp': 'full', 'antigravity': 'partial', 'continue': 'partial',
|
||||
},
|
||||
'react-frontend': {
|
||||
'claude-code': 'full', 'cursor': 'full', 'codex': 'full', 'gemini-cli': 'full',
|
||||
'opencode': 'partial', 'windsurf': 'full', 'github-copilot': 'full', 'goose': 'partial',
|
||||
'kilo': 'partial', 'kiro-cli': 'partial', 'roo': 'full', 'trae': 'full',
|
||||
'amp': 'full', 'cline': 'full', 'continue': 'full', 'antigravity': 'none',
|
||||
'frontend': {
|
||||
'claude-code': 'full', 'cursor': 'full', 'codex': 'partial', 'gemini-cli': 'full',
|
||||
'opencode': 'full', 'windsurf': 'full', 'github-copilot': 'partial', 'cline': 'full',
|
||||
'roo': 'full', 'kilo': 'partial', 'kiro-cli': 'partial', 'goose': 'partial',
|
||||
'trae': 'full', 'amp': 'full', 'antigravity': 'partial', 'continue': 'partial',
|
||||
},
|
||||
'backend': {
|
||||
'claude-code': 'full', 'cursor': 'full', 'codex': 'full', 'gemini-cli': 'full',
|
||||
'opencode': 'full', 'windsurf': 'full', 'github-copilot': 'full', 'goose': 'full',
|
||||
'kilo': 'partial', 'kiro-cli': 'partial', 'roo': 'full', 'trae': 'partial',
|
||||
'amp': 'full', 'cline': 'full', 'continue': 'full', 'antigravity': 'partial',
|
||||
'claude-code': 'full', 'cursor': 'full', 'codex': 'partial', 'gemini-cli': 'full',
|
||||
'opencode': 'full', 'windsurf': 'full', 'github-copilot': 'partial', 'cline': 'full',
|
||||
'roo': 'full', 'kilo': 'full', 'kiro-cli': 'full', 'goose': 'full',
|
||||
'trae': 'full', 'amp': 'full', 'antigravity': 'partial', 'continue': 'partial',
|
||||
},
|
||||
'devops': {
|
||||
'claude-code': 'full', 'cursor': 'full', 'codex': 'full', 'gemini-cli': 'full',
|
||||
'opencode': 'full', 'windsurf': 'partial', 'github-copilot': 'full', 'goose': 'partial',
|
||||
'kilo': 'partial', 'kiro-cli': 'none', 'roo': 'partial', 'trae': 'partial',
|
||||
'amp': 'full', 'cline': 'partial', 'continue': 'partial', 'antigravity': 'none',
|
||||
'claude-code': 'full', 'cursor': 'full', 'codex': 'partial', 'gemini-cli': 'full',
|
||||
'opencode': 'full', 'windsurf': 'partial', 'github-copilot': 'partial', 'cline': 'full',
|
||||
'roo': 'full', 'kilo': 'partial', 'kiro-cli': 'partial', 'goose': 'partial',
|
||||
'trae': 'partial', 'amp': 'partial', 'antigravity': 'partial', 'continue': 'partial',
|
||||
},
|
||||
'python': {
|
||||
'claude-code': 'full', 'cursor': 'full', 'codex': 'full', 'gemini-cli': 'full',
|
||||
'opencode': 'full', 'windsurf': 'full', 'github-copilot': 'full', 'goose': 'full',
|
||||
'kilo': 'partial', 'kiro-cli': 'partial', 'roo': 'full', 'trae': 'partial',
|
||||
'amp': 'full', 'cline': 'full', 'continue': 'full', 'antigravity': 'partial',
|
||||
},
|
||||
'go': {
|
||||
'claude-code': 'full', 'cursor': 'full', 'codex': 'full', 'gemini-cli': 'full',
|
||||
'opencode': 'full', 'windsurf': 'partial', 'github-copilot': 'full', 'goose': 'partial',
|
||||
'kilo': 'none', 'kiro-cli': 'none', 'roo': 'partial', 'trae': 'partial',
|
||||
'amp': 'partial', 'cline': 'partial', 'continue': 'partial', 'antigravity': 'none',
|
||||
},
|
||||
'typescript': {
|
||||
'claude-code': 'full', 'cursor': 'full', 'codex': 'full', 'gemini-cli': 'full',
|
||||
'opencode': 'full', 'windsurf': 'full', 'github-copilot': 'full', 'goose': 'full',
|
||||
'kilo': 'partial', 'kiro-cli': 'partial', 'roo': 'full', 'trae': 'full',
|
||||
'amp': 'full', 'cline': 'full', 'continue': 'full', 'antigravity': 'partial',
|
||||
},
|
||||
'database': {
|
||||
'claude-code': 'full', 'cursor': 'full', 'codex': 'full', 'gemini-cli': 'full',
|
||||
'opencode': 'partial', 'windsurf': 'partial', 'github-copilot': 'full', 'goose': 'partial',
|
||||
'kilo': 'none', 'kiro-cli': 'none', 'roo': 'partial', 'trae': 'partial',
|
||||
'amp': 'partial', 'cline': 'partial', 'continue': 'partial', 'antigravity': 'none',
|
||||
},
|
||||
'performance': {
|
||||
'claude-code': 'full', 'cursor': 'full', 'codex': 'full', 'gemini-cli': 'full',
|
||||
'opencode': 'partial', 'windsurf': 'partial', 'github-copilot': 'partial', 'goose': 'partial',
|
||||
'kilo': 'none', 'kiro-cli': 'none', 'roo': 'partial', 'trae': 'partial',
|
||||
'amp': 'partial', 'cline': 'partial', 'continue': 'partial', 'antigravity': 'none',
|
||||
},
|
||||
'documentation': {
|
||||
'claude-code': 'full', 'cursor': 'full', 'codex': 'full', 'gemini-cli': 'full',
|
||||
'opencode': 'full', 'windsurf': 'full', 'github-copilot': 'full', 'goose': 'full',
|
||||
'kilo': 'partial', 'kiro-cli': 'partial', 'roo': 'full', 'trae': 'full',
|
||||
'amp': 'full', 'cline': 'full', 'continue': 'full', 'antigravity': 'partial',
|
||||
},
|
||||
'ai-ml': {
|
||||
'claude-code': 'full', 'cursor': 'full', 'codex': 'full', 'gemini-cli': 'full',
|
||||
'opencode': 'partial', 'windsurf': 'partial', 'github-copilot': 'partial', 'goose': 'partial',
|
||||
'kilo': 'none', 'kiro-cli': 'none', 'roo': 'partial', 'trae': 'partial',
|
||||
'amp': 'partial', 'cline': 'partial', 'continue': 'partial', 'antigravity': 'none',
|
||||
'docs': {
|
||||
'claude-code': 'full', 'cursor': 'full', 'codex': 'partial', 'gemini-cli': 'full',
|
||||
'opencode': 'full', 'windsurf': 'full', 'github-copilot': 'full', 'cline': 'full',
|
||||
'roo': 'full', 'kilo': 'full', 'kiro-cli': 'full', 'goose': 'full',
|
||||
'trae': 'full', 'amp': 'full', 'antigravity': 'full', 'continue': 'full',
|
||||
},
|
||||
};
|
||||
|
||||
@@ -202,7 +197,7 @@ export function CompatibilityMatrix(): React.ReactElement {
|
||||
<div>
|
||||
<h2 className="text-lg sm:text-xl font-bold text-white mb-1 font-mono">Compatibility Matrix</h2>
|
||||
<p className="text-zinc-500 font-mono text-[10px] sm:text-xs">
|
||||
Skill support across 16 agents and 12 categories.
|
||||
Skill support across {AGENTS.length} agents and {CATEGORIES.length} categories.
|
||||
</p>
|
||||
</div>
|
||||
<div className="flex items-center gap-2">
|
||||
|
||||
@@ -42,13 +42,13 @@ const sections: DocSection[] = [
|
||||
content: (
|
||||
<div className="space-y-4">
|
||||
<p className="text-zinc-300">
|
||||
SkillKit is a universal command-line interface (CLI) and programmatic toolkit for managing AI agent skills across 32 AI coding platforms. It solves the fragmentation problem where each AI agent uses different skill formats and directory structures.
|
||||
SkillKit is a universal command-line interface (CLI) and programmatic toolkit for managing AI agent skills across 44 AI coding platforms. It solves the fragmentation problem where each AI agent uses different skill formats and directory structures.
|
||||
</p>
|
||||
<h3 className="text-lg font-semibold text-white mt-6">Core Capabilities</h3>
|
||||
<ul className="list-disc list-inside space-y-2 text-zinc-400">
|
||||
<li><span className="text-white">AI Instruction Generation (Primer)</span> - Analyze your codebase and generate customized instruction files for all 32 agents</li>
|
||||
<li><span className="text-white">AI Instruction Generation (Primer)</span> - Analyze your codebase and generate customized instruction files for all 44 agents</li>
|
||||
<li><span className="text-white">Skill Discovery</span> - Browse 15,000+ skills from marketplace with AI-powered recommendations</li>
|
||||
<li><span className="text-white">Cross-Agent Translation</span> - Automatically convert skills between 32 agent-specific formats</li>
|
||||
<li><span className="text-white">Cross-Agent Translation</span> - Automatically convert skills between 44 agent-specific formats</li>
|
||||
<li><span className="text-white">Team Collaboration</span> - Share skills via .skills manifest files and publish to marketplace</li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -101,7 +101,7 @@ skillkit install anthropics/skills`}</CodeBlock>
|
||||
<ul className="list-disc list-inside space-y-2 text-zinc-400">
|
||||
<li><span className="text-white">UI Tier</span> - CLI commands, Terminal UI (OpenTUI-based), and documentation website</li>
|
||||
<li><span className="text-white">Core Logic Tier</span> - @skillkit/core for business logic; @skillkit/agents for adapter implementations</li>
|
||||
<li><span className="text-white">Integration Tier</span> - File systems, Git repositories, marketplace APIs, and 32 AI agents</li>
|
||||
<li><span className="text-white">Integration Tier</span> - File systems, Git repositories, marketplace APIs, and 44 AI agents</li>
|
||||
</ul>
|
||||
|
||||
<h3 className="text-lg font-semibold text-white mt-6">Monorepo Structure</h3>
|
||||
@@ -129,7 +129,7 @@ skillkit install anthropics/skills`}</CodeBlock>
|
||||
content: (
|
||||
<div className="space-y-4">
|
||||
<p className="text-zinc-300">
|
||||
SkillKit supports 32 AI coding agents with automatic format translation:
|
||||
SkillKit supports 44 AI coding agents with automatic format translation:
|
||||
</p>
|
||||
|
||||
<Table
|
||||
@@ -206,7 +206,7 @@ skillkit cicd init # Setup CI/CD integration`}</CodeBlock>
|
||||
|
||||
<h3 className="text-lg font-semibold text-white mt-6">AI Instruction Generation (Primer)</h3>
|
||||
<CodeBlock>{`skillkit primer # Analyze codebase, generate for detected agents
|
||||
skillkit primer --all-agents # Generate for all 32 agents
|
||||
skillkit primer --all-agents # Generate for all 44 agents
|
||||
skillkit primer --agent claude-code,cursor # Specific agents only
|
||||
skillkit primer --analyze-only # Only show codebase analysis
|
||||
skillkit primer --dry-run # Preview without writing files
|
||||
|
||||
@@ -18,7 +18,7 @@ const FEATURES: Feature[] = [
|
||||
},
|
||||
{
|
||||
title: 'Auto Translation',
|
||||
description: 'The npm for agent skills. Write once, auto-translate to 32 formats.',
|
||||
description: 'The npm for agent skills. Write once, auto-translate to 44 formats.',
|
||||
icon: (
|
||||
<svg className="w-5 h-5" fill="none" viewBox="0 0 24 24" stroke="currentColor">
|
||||
<path strokeLinecap="round" strokeLinejoin="round" strokeWidth={1.5} d="M8 7h12m0 0l-4-4m4 4l-4 4m0 6H4m0 0l4 4m-4-4l4-4" />
|
||||
@@ -36,7 +36,7 @@ const FEATURES: Feature[] = [
|
||||
},
|
||||
{
|
||||
title: 'Primer',
|
||||
description: 'Auto-generate agent instructions for all 32 agents from your codebase.',
|
||||
description: 'Auto-generate agent instructions for all 44 agents from your codebase.',
|
||||
icon: (
|
||||
<svg className="w-5 h-5" fill="none" viewBox="0 0 24 24" stroke="currentColor">
|
||||
<path strokeLinecap="round" strokeLinejoin="round" strokeWidth={1.5} d="M13 10V3L4 14h7v7l9-11h-7z" />
|
||||
@@ -70,6 +70,15 @@ const FEATURES: Feature[] = [
|
||||
</svg>
|
||||
)
|
||||
},
|
||||
{
|
||||
title: 'Security Scanner',
|
||||
description: 'Detect prompt injection, secrets, and malicious patterns in skills.',
|
||||
icon: (
|
||||
<svg className="w-5 h-5" fill="none" viewBox="0 0 24 24" stroke="currentColor">
|
||||
<path strokeLinecap="round" strokeLinejoin="round" strokeWidth={1.5} d="M9 12.75L11.25 15 15 9.75m-3-7.036A11.959 11.959 0 013.598 6 11.99 11.99 0 003 9.749c0 5.592 3.824 10.29 9 11.623 5.176-1.332 9-6.03 9-11.622 0-1.31-.21-2.571-.598-3.751h-.152c-3.196 0-6.1-1.248-8.25-3.285z" />
|
||||
</svg>
|
||||
)
|
||||
},
|
||||
{
|
||||
title: 'Testing',
|
||||
description: 'Built-in test framework with assertions.',
|
||||
@@ -100,12 +109,13 @@ const FEATURES: Feature[] = [
|
||||
];
|
||||
|
||||
const COMPARISONS = [
|
||||
['Agent Support', '1 agent', '32 agents'],
|
||||
['Agent Support', '1 agent', '44 agents'],
|
||||
['Setup', 'Write rules manually', 'Auto-generate (Primer)'],
|
||||
['Learning', 'Lost each session', 'Persistent memory'],
|
||||
['Translation', 'Rewrite for each', 'One-click conversion'],
|
||||
['Team Sharing', 'Copy/paste files', '.skills manifest'],
|
||||
['Discovery', 'Search forums', 'AI recommendations'],
|
||||
['Security', 'Manual review', 'Auto-scan on install'],
|
||||
['API Access', 'None', 'REST + MCP + Python'],
|
||||
] as const;
|
||||
|
||||
|
||||
@@ -21,7 +21,7 @@ interface TerminalLine {
|
||||
|
||||
const TERMINAL_LINES: TerminalLine[] = [
|
||||
{ type: 'cmd', text: 'skillkit install anthropics/skills --agent all' },
|
||||
{ type: 'out', text: '→ Installed to 32 agents' },
|
||||
{ type: 'out', text: '→ Installed to 44 agents' },
|
||||
{ type: 'cmd', text: 'skillkit recommend' },
|
||||
{ type: 'out', text: ' 92% vercel-react-best-practices' },
|
||||
{ type: 'out', text: ' 87% typescript-strict-mode' },
|
||||
@@ -107,10 +107,6 @@ export function Hero({ version, stars }: HeroProps): React.ReactElement {
|
||||
}
|
||||
}
|
||||
|
||||
function openGitHub(): void {
|
||||
window.open('https://github.com/rohitg00/skillkit', '_blank', 'noopener,noreferrer');
|
||||
}
|
||||
|
||||
const isTyping = visibleLines < TERMINAL_LINES.length && TERMINAL_LINES[visibleLines].type === 'cmd';
|
||||
const isComplete = visibleLines >= TERMINAL_LINES.length;
|
||||
|
||||
@@ -119,10 +115,22 @@ export function Hero({ version, stars }: HeroProps): React.ReactElement {
|
||||
<div className="absolute inset-0 bg-gradient-to-b from-zinc-900/50 to-transparent pointer-events-none"></div>
|
||||
|
||||
<div className="mx-auto max-w-5xl px-4 sm:px-6 lg:px-8 pt-8 pb-10 relative">
|
||||
<div className="hidden lg:block mb-6 overflow-hidden">
|
||||
<pre className="text-zinc-600 text-[10px] leading-none font-mono select-none whitespace-pre" style={{ fontFamily: 'JetBrains Mono, Consolas, monospace' }}>
|
||||
<div className="flex flex-col sm:flex-row sm:items-center sm:justify-between gap-3 mb-4 lg:mb-6">
|
||||
<pre className="hidden sm:block text-zinc-600 text-[6px] sm:text-[8px] lg:text-[10px] leading-none font-mono select-none whitespace-pre overflow-x-auto" style={{ fontFamily: 'JetBrains Mono, Consolas, monospace' }}>
|
||||
{ASCII_LOGO}
|
||||
</pre>
|
||||
<a
|
||||
href="https://www.producthunt.com/products/skillkit-2?embed=true&utm_source=badge-top-post-badge&utm_medium=badge&utm_campaign=badge-skillkit-2"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
className="inline-flex items-center gap-2 sm:gap-3 bg-zinc-900/80 border border-zinc-800 hover:border-zinc-600 transition-colors rounded-full px-3 sm:px-4 py-1.5 sm:py-2 group shrink-0 self-start"
|
||||
>
|
||||
<span className="flex items-center justify-center w-6 h-6 sm:w-8 sm:h-8 rounded-full border border-zinc-600 bg-transparent text-white font-bold text-xs sm:text-sm">P</span>
|
||||
<span className="flex flex-col">
|
||||
<span className="text-[8px] sm:text-[10px] font-semibold text-zinc-500 tracking-wider uppercase leading-tight">Product Hunt</span>
|
||||
<span className="text-[11px] sm:text-sm font-bold text-white group-hover:text-zinc-300 transition-colors leading-tight">#3 Product of the Day</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div className="grid grid-cols-1 md:grid-cols-2 gap-6 lg:gap-8 items-start">
|
||||
@@ -134,13 +142,13 @@ export function Hero({ version, stars }: HeroProps): React.ReactElement {
|
||||
|
||||
<h1 className="text-2xl sm:text-3xl lg:text-4xl font-bold tracking-tight text-white mb-3 font-mono">
|
||||
One Skill.<br />
|
||||
<span className="text-zinc-500">32 Agents. Zero Rewrites.</span>
|
||||
<span className="text-zinc-500">44 Agents. Zero Rewrites.</span>
|
||||
</h1>
|
||||
|
||||
<p className="text-sm text-zinc-400 mb-5 max-w-lg font-mono leading-relaxed">
|
||||
The open source package manager for AI agent skills. Install from 15,000+ skills,
|
||||
auto-translate between formats, persist learnings with Memory.
|
||||
Works with Claude, Cursor, Windsurf, Copilot, and 28 more.
|
||||
Works with Claude, Cursor, Windsurf, Copilot, Devin, Codex, and 38 more.
|
||||
</p>
|
||||
|
||||
<div className="flex flex-wrap items-center gap-2 mb-4">
|
||||
@@ -161,15 +169,30 @@ export function Hero({ version, stars }: HeroProps): React.ReactElement {
|
||||
)}
|
||||
</span>
|
||||
</button>
|
||||
<button
|
||||
onClick={openGitHub}
|
||||
className="inline-flex items-center gap-2 border border-zinc-700 px-3 py-2 hover:border-zinc-500 transition-colors group"
|
||||
<a
|
||||
href="https://github.com/rohitg00/skillkit/tree/main/packages/extension#readme"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
className="inline-flex items-center gap-2 bg-white text-black border border-zinc-300 px-3 py-2 hover:bg-zinc-200 transition-colors font-mono text-sm font-semibold"
|
||||
>
|
||||
<svg className="w-4 h-4" viewBox="0 0 24 24" fill="none">
|
||||
<circle cx="12" cy="12" r="10" fill="#09090b"/>
|
||||
<circle cx="12" cy="12" r="4.5" fill="white"/>
|
||||
<path d="M12 2v5.5M12 16.5V22M2 12h5.5M16.5 12H22" stroke="white" strokeWidth="1.5"/>
|
||||
</svg>
|
||||
Add to Chrome
|
||||
</a>
|
||||
<a
|
||||
href="https://github.com/rohitg00/skillkit"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
className="sm:hidden inline-flex items-center gap-2 border border-zinc-700 px-3 py-2 hover:border-zinc-500 transition-colors group"
|
||||
>
|
||||
<svg className="w-4 h-4 text-zinc-400 group-hover:text-white transition-colors" fill="currentColor" viewBox="0 0 24 24">
|
||||
<path fillRule="evenodd" d="M12 2C6.477 2 2 6.484 2 12.017c0 4.425 2.865 8.18 6.839 9.504.5.092.682-.217.682-.483 0-.237-.008-.868-.013-1.703-2.782.605-3.369-1.343-3.369-1.343-.454-1.158-1.11-1.466-1.11-1.466-.908-.62.069-.608.069-.608 1.003.07 1.531 1.032 1.531 1.032.892 1.53 2.341 1.088 2.91.832.092-.647.35-1.088.636-1.338-2.22-.253-4.555-1.113-4.555-4.951 0-1.093.39-1.988 1.029-2.688-.103-.253-.446-1.272.098-2.65 0 0 .84-.27 2.75 1.026A9.564 9.564 0 0112 6.844c.85.004 1.705.115 2.504.337 1.909-1.296 2.747-1.027 2.747-1.027.546 1.379.202 2.398.1 2.651.64.7 1.028 1.595 1.028 2.688 0 3.848-2.339 4.695-4.566 4.943.359.309.678.92.678 1.855 0 1.338-.012 2.419-.012 2.747 0 .268.18.58.688.482A10.019 10.019 0 0022 12.017C22 6.484 17.522 2 12 2z" clipRule="evenodd" />
|
||||
</svg>
|
||||
<span className="font-mono text-sm text-zinc-300 group-hover:text-white transition-colors">Star</span>
|
||||
{typeof stars === 'number' && (
|
||||
{typeof stars === 'number' && stars > 0 && (
|
||||
<>
|
||||
<span className="w-px h-4 bg-zinc-700"></span>
|
||||
<svg className="w-3.5 h-3.5 text-yellow-500" fill="currentColor" viewBox="0 0 24 24">
|
||||
@@ -178,7 +201,7 @@ export function Hero({ version, stars }: HeroProps): React.ReactElement {
|
||||
<span className="font-mono text-sm text-white font-medium">{stars}</span>
|
||||
</>
|
||||
)}
|
||||
</button>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -13,7 +13,7 @@ const USE_CASES: UseCase[] = [
|
||||
{
|
||||
persona: 'Multi-Agent Developer',
|
||||
problem: 'You\'ve built skills for Claude Code. Now your team wants Cursor, and you want to try Windsurf.',
|
||||
solution: 'SkillKit translates skills between all 32 agents. Write once, deploy everywhere.',
|
||||
solution: 'SkillKit translates skills between all 44 agents. Write once, deploy everywhere.',
|
||||
command: 'skillkit translate --to cursor,windsurf',
|
||||
gradient: 'from-violet-500/10 to-purple-500/10',
|
||||
icon: (
|
||||
|
||||
@@ -54,9 +54,9 @@ function setCachedStats(data: Omit<Stats, 'loading'>): void {
|
||||
|
||||
export function useStats(): Stats {
|
||||
const [stats, setStats] = useState<Stats>({
|
||||
version: '1.9.0',
|
||||
downloads: '2.4k',
|
||||
stars: 66,
|
||||
version: '',
|
||||
downloads: '',
|
||||
stars: 0,
|
||||
loading: true,
|
||||
});
|
||||
|
||||
@@ -74,9 +74,9 @@ export function useStats(): Stats {
|
||||
fetch('https://api.github.com/repos/rohitg00/skillkit'),
|
||||
]);
|
||||
|
||||
let downloads = '2.4k';
|
||||
let stars = 66;
|
||||
let version = '1.9.0';
|
||||
let downloads = '';
|
||||
let stars = 0;
|
||||
let version = '';
|
||||
|
||||
if (npmResponse.status === 'fulfilled' && npmResponse.value.ok) {
|
||||
const npmData = await npmResponse.value.json();
|
||||
|
||||
@@ -4,13 +4,13 @@
|
||||
<meta charset="UTF-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>SkillKit - Universal Skills for AI Coding Agents</title>
|
||||
<meta name="description" content="Write once, deploy to 32 AI coding agents. Skills for Claude Code, Cursor, Codex, Windsurf, GitHub Copilot, and more.">
|
||||
<meta name="description" content="Write once, deploy to 44 AI coding agents. Skills for Claude Code, Cursor, Codex, Windsurf, GitHub Copilot, and more.">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://agenstskills.com/">
|
||||
<meta property="og:title" content="SkillKit - Universal Skills for AI Coding Agents">
|
||||
<meta property="og:description" content="Write once, deploy to 32 AI coding agents. Skills for Claude Code, Cursor, Codex, Windsurf, GitHub Copilot, and more.">
|
||||
<meta property="og:description" content="Write once, deploy to 44 AI coding agents. Skills for Claude Code, Cursor, Codex, Windsurf, GitHub Copilot, and more.">
|
||||
<meta property="og:image" content="https://agenstskills.com/og-image.png">
|
||||
<meta property="og:image:width" content="1200">
|
||||
<meta property="og:image:height" content="630">
|
||||
@@ -20,7 +20,7 @@
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://agenstskills.com/">
|
||||
<meta name="twitter:title" content="SkillKit - Universal Skills for AI Coding Agents">
|
||||
<meta name="twitter:description" content="Write once, deploy to 32 AI coding agents. Skills for Claude Code, Cursor, Codex, Windsurf, GitHub Copilot, and more.">
|
||||
<meta name="twitter:description" content="Write once, deploy to 44 AI coding agents. Skills for Claude Code, Cursor, Codex, Windsurf, GitHub Copilot, and more.">
|
||||
<meta name="twitter:image" content="https://agenstskills.com/og-image.png">
|
||||
|
||||
<link rel="icon" type="image/svg+xml" href="/favicon.svg" />
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
{
|
||||
"name": "SkillKit",
|
||||
"description": "Supercharge Every AI Coding Agent. Translate, manage, and sync skills across Claude, Cursor, Windsurf, and 32 agents.",
|
||||
"description": "Supercharge Every AI Coding Agent. Translate, manage, and sync skills across Claude, Cursor, Windsurf, and 44 agents.",
|
||||
"requestFramePermissions": []
|
||||
}
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "skillkit",
|
||||
"private": true,
|
||||
"version": "1.14.0",
|
||||
"version": "1.19.0",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"dev": "vite",
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
"info": {
|
||||
"title": "SkillKit",
|
||||
"version": "1.12.0",
|
||||
"description": "Skills shouldn't require pre-installation. This API lets any agent, framework, or tool discover and retrieve skills on demand.\n\n15,000+ skills across 32 AI coding agents. Results ranked by a multi-signal scoring system (content 40pts, query match 30pts, popularity 15pts, references 15pts).\n\n## Quick Start\n\n```bash\nnpx skillkit serve\n```\n\nThe API is now running at http://localhost:3737\n\n## MCP Server\n\nFor agent-native discovery (Claude Desktop, Cursor):\n\n```json\n{\n \"mcpServers\": {\n \"skillkit\": { \"command\": \"npx\", \"args\": [\"@skillkit/mcp\"] }\n }\n}\n```\n\n## Python Client\n\n```bash\npip install skillkit-client\n```",
|
||||
"description": "Skills shouldn't require pre-installation. This API lets any agent, framework, or tool discover and retrieve skills on demand.\n\n15,000+ skills across 44 AI coding agents. Results ranked by a multi-signal scoring system (content 40pts, query match 30pts, popularity 15pts, references 15pts).\n\n## Quick Start\n\n```bash\nnpx skillkit serve\n```\n\nThe API is now running at http://localhost:3737\n\n## MCP Server\n\nFor agent-native discovery (Claude Desktop, Cursor):\n\n```json\n{\n \"mcpServers\": {\n \"skillkit\": { \"command\": \"npx\", \"args\": [\"@skillkit/mcp\"] }\n }\n}\n```\n\n## Python Client\n\n```bash\npip install skillkit-client\n```",
|
||||
"license": {
|
||||
"name": "Apache-2.0",
|
||||
"url": "https://opensource.org/licenses/Apache-2.0"
|
||||
|
||||
@@ -0,0 +1,76 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Privacy Policy — SkillKit</title>
|
||||
<style>
|
||||
* { margin: 0; padding: 0; box-sizing: border-box; }
|
||||
body { background: #09090b; color: #d4d4d8; font-family: 'Inter', -apple-system, BlinkMacSystemFont, sans-serif; line-height: 1.7; }
|
||||
.container { max-width: 640px; margin: 0 auto; padding: 48px 24px; }
|
||||
h1 { color: #fafafa; font-size: 28px; font-weight: 700; margin-bottom: 8px; font-family: 'JetBrains Mono', monospace; }
|
||||
.updated { color: #71717a; font-size: 13px; margin-bottom: 32px; }
|
||||
h2 { color: #fafafa; font-size: 18px; font-weight: 600; margin-top: 32px; margin-bottom: 12px; }
|
||||
p { margin-bottom: 16px; font-size: 15px; }
|
||||
ul { margin-bottom: 16px; padding-left: 24px; }
|
||||
li { margin-bottom: 8px; font-size: 15px; }
|
||||
a { color: #fafafa; text-decoration: underline; text-underline-offset: 2px; }
|
||||
a:hover { color: #a1a1aa; }
|
||||
.back { display: inline-block; margin-bottom: 24px; color: #71717a; font-size: 13px; text-decoration: none; font-family: 'JetBrains Mono', monospace; }
|
||||
.back:hover { color: #fafafa; }
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="container">
|
||||
<a href="/" class="back">← Back to SkillKit</a>
|
||||
<h1>Privacy Policy</h1>
|
||||
<p class="updated">Last updated: February 14, 2026</p>
|
||||
|
||||
<h2>Overview</h2>
|
||||
<p>SkillKit ("we", "our", "us") is an open-source CLI tool and Chrome extension for managing AI agent skills. We are committed to protecting your privacy. This policy explains what data we collect (or don't) across all SkillKit products.</p>
|
||||
|
||||
<h2>Chrome Extension — "SkillKit - Save as Skill"</h2>
|
||||
<p>The Chrome extension helps you save webpages as AI agent skill files.</p>
|
||||
<ul>
|
||||
<li><strong>What data is sent:</strong> When you click "Save as Skill", the extension sends the URL of the current page to our server at <code>agenstskills.com/api/save-skill</code>. This is required to fetch and convert the webpage content into a skill file.</li>
|
||||
<li><strong>What data is NOT sent:</strong> We do not send page content, browsing history, personal information, cookies, authentication tokens, or any data beyond the single URL you choose to save.</li>
|
||||
<li><strong>No data stored on server:</strong> The URL is processed in real time to extract content, generate tags, and build the skill file. No URLs, page content, or user data are stored, logged, or retained on the server after the response is returned.</li>
|
||||
<li><strong>Selection saves are local:</strong> When you save selected text via the right-click menu, the skill file is built entirely in the browser with no network requests.</li>
|
||||
<li><strong>No analytics or tracking:</strong> We do not use any analytics, telemetry, or tracking services.</li>
|
||||
<li><strong>No user accounts:</strong> No login, API key, or account is required.</li>
|
||||
<li><strong>Downloads:</strong> Generated skill files are saved to your local filesystem via the Chrome Downloads API. No files are uploaded anywhere.</li>
|
||||
</ul>
|
||||
|
||||
<h2>Permissions Used</h2>
|
||||
<ul>
|
||||
<li><strong>activeTab:</strong> Read the URL and title of the tab you are viewing when you click the extension. Only accessed when you actively use the extension.</li>
|
||||
<li><strong>contextMenus:</strong> Add "Save page as Skill" and "Save selection as Skill" to the right-click menu.</li>
|
||||
<li><strong>downloads:</strong> Save the generated SKILL.md file to your Downloads folder.</li>
|
||||
</ul>
|
||||
|
||||
<h2>CLI Tool</h2>
|
||||
<p>The SkillKit CLI runs entirely on your local machine. It does not phone home, collect telemetry, or transmit any data to external servers unless you explicitly use network features (e.g., <code>skillkit install</code> fetches public GitHub repositories).</p>
|
||||
|
||||
<h2>MCP Server</h2>
|
||||
<p>The SkillKit MCP server runs locally and provides skill discovery over the Model Context Protocol. It loads skill data from a bundled JSON file and does not make external network requests or collect user data.</p>
|
||||
|
||||
<h2>Website</h2>
|
||||
<p>The SkillKit website (<a href="https://agenstskills.com">agenstskills.com</a>) is a static site hosted on Vercel. We do not use cookies, analytics trackers, or collect personal information. Vercel may collect standard web server logs (IP address, user agent) as described in their <a href="https://vercel.com/legal/privacy-policy">privacy policy</a>.</p>
|
||||
|
||||
<h2>Third-Party Services</h2>
|
||||
<p>The Chrome extension communicates with <code>agenstskills.com</code> (our own server, hosted on Vercel) to process webpage URLs. No third-party data processors, advertising networks, or analytics services are used.</p>
|
||||
|
||||
<h2>Data Retention</h2>
|
||||
<p>We do not retain any user data. URLs sent to the API are processed in memory and discarded immediately after the response.</p>
|
||||
|
||||
<h2>Changes to This Policy</h2>
|
||||
<p>We may update this privacy policy from time to time. Changes will be posted on this page with an updated revision date.</p>
|
||||
|
||||
<h2>Contact</h2>
|
||||
<p>If you have questions about this privacy policy, contact us at <a href="mailto:ghumare64@gmail.com">ghumare64@gmail.com</a>.</p>
|
||||
|
||||
<h2>Open Source</h2>
|
||||
<p>SkillKit is open source under the Apache 2.0 license. You can review all source code at <a href="https://github.com/rohitg00/skillkit">github.com/rohitg00/skillkit</a>.</p>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -44,7 +44,7 @@ describe('E2E: Onboarding UI', () => {
|
||||
expect(result.success).toBe(true);
|
||||
});
|
||||
|
||||
it('should display all 32 agents', async () => {
|
||||
it('should display all 44 agents', async () => {
|
||||
const result = await runCli(['init', '--list']);
|
||||
const output = result.stdout + result.stderr;
|
||||
|
||||
@@ -81,6 +81,18 @@ describe('E2E: Onboarding UI', () => {
|
||||
'Qwen',
|
||||
'Vercel',
|
||||
'Zencoder',
|
||||
'Devin',
|
||||
'Aider',
|
||||
'Cody',
|
||||
'Amazon Q',
|
||||
'Augment',
|
||||
'Replit',
|
||||
'Bolt',
|
||||
'Lovable',
|
||||
'Tabby',
|
||||
'Tabnine',
|
||||
'CodeGPT',
|
||||
'PlayCode',
|
||||
];
|
||||
|
||||
for (const agent of agents) {
|
||||
|
||||
@@ -28,7 +28,7 @@ import {
|
||||
type CrossAgentSkill,
|
||||
} from '@skillkit/core';
|
||||
|
||||
// All 32 supported agents
|
||||
// All 44 supported agents
|
||||
const SUPPORTED_AGENTS = [
|
||||
'claude-code',
|
||||
'cursor',
|
||||
@@ -47,6 +47,33 @@ const SUPPORTED_AGENTS = [
|
||||
'trae',
|
||||
'windsurf',
|
||||
'universal',
|
||||
'cline',
|
||||
'codebuddy',
|
||||
'commandcode',
|
||||
'continue',
|
||||
'crush',
|
||||
'factory',
|
||||
'mcpjam',
|
||||
'mux',
|
||||
'neovate',
|
||||
'openhands',
|
||||
'pi',
|
||||
'qoder',
|
||||
'qwen',
|
||||
'vercel',
|
||||
'zencoder',
|
||||
'devin',
|
||||
'aider',
|
||||
'sourcegraph-cody',
|
||||
'amazon-q',
|
||||
'augment-code',
|
||||
'replit-agent',
|
||||
'bolt',
|
||||
'lovable',
|
||||
'tabby',
|
||||
'tabnine',
|
||||
'codegpt',
|
||||
'playcode-agent',
|
||||
] as const;
|
||||
|
||||
describe('E2E: Skill Translator - Parsing', () => {
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
* E2E Tests: Skill Translation Commands
|
||||
*
|
||||
* Tests for: translate, context, recommend
|
||||
* Validates translation to all 32 supported agents
|
||||
* Validates translation to all 44 supported agents
|
||||
*/
|
||||
|
||||
import { describe, it, expect, beforeEach, afterEach } from 'vitest';
|
||||
@@ -16,7 +16,7 @@ import {
|
||||
testFileExists,
|
||||
} from './helpers/cli-runner.js';
|
||||
|
||||
// All 32 supported agents
|
||||
// All 44 supported agents
|
||||
const SUPPORTED_AGENTS = [
|
||||
'claude-code',
|
||||
'cursor',
|
||||
@@ -50,6 +50,18 @@ const SUPPORTED_AGENTS = [
|
||||
'qwen',
|
||||
'vercel',
|
||||
'zencoder',
|
||||
'devin',
|
||||
'aider',
|
||||
'sourcegraph-cody',
|
||||
'amazon-q',
|
||||
'augment-code',
|
||||
'replit-agent',
|
||||
'bolt',
|
||||
'lovable',
|
||||
'tabby',
|
||||
'tabnine',
|
||||
'codegpt',
|
||||
'playcode-agent',
|
||||
] as const;
|
||||
|
||||
describe('E2E: Skill Translation', () => {
|
||||
|
||||
Generated
+2
-2
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "skillkit-monorepo",
|
||||
"version": "1.14.0",
|
||||
"version": "1.16.0",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "skillkit-monorepo",
|
||||
"version": "1.14.0",
|
||||
"version": "1.16.0",
|
||||
"license": "Apache-2.0",
|
||||
"devDependencies": {
|
||||
"@types/node": "^22.10.5",
|
||||
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "skillkit-monorepo",
|
||||
"version": "1.14.0",
|
||||
"version": "1.19.0",
|
||||
"private": true,
|
||||
"description": "The package manager for AI agent skills — install, translate, share across 32 coding agents",
|
||||
"type": "module",
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@skillkit/agents",
|
||||
"version": "1.14.0",
|
||||
"version": "1.19.0",
|
||||
"description": "Agent adapters for SkillKit - supports 32 AI coding agents",
|
||||
"type": "module",
|
||||
"main": "./dist/index.js",
|
||||
|
||||
@@ -1,22 +1,62 @@
|
||||
import { describe, it, expect } from 'vitest';
|
||||
import { getAllAdapters, getAdapter, detectAgent } from '../index.js';
|
||||
import { AGENT_CONFIG, AgentType } from '@skillkit/core';
|
||||
|
||||
const GENERIC_AGENTS: AgentType[] = [
|
||||
'cline',
|
||||
'codebuddy',
|
||||
'commandcode',
|
||||
'continue',
|
||||
'crush',
|
||||
'mcpjam',
|
||||
'mux',
|
||||
'neovate',
|
||||
'openhands',
|
||||
'pi',
|
||||
'qoder',
|
||||
'qwen',
|
||||
'vercel',
|
||||
'zencoder',
|
||||
'devin',
|
||||
'aider',
|
||||
'sourcegraph-cody',
|
||||
'amazon-q',
|
||||
'augment-code',
|
||||
'replit-agent',
|
||||
'bolt',
|
||||
'lovable',
|
||||
'tabby',
|
||||
'tabnine',
|
||||
'codegpt',
|
||||
'playcode-agent',
|
||||
];
|
||||
|
||||
const ALL_AGENTS = AgentType.options;
|
||||
|
||||
describe('Agent Adapters', () => {
|
||||
describe('getAllAdapters', () => {
|
||||
it('should return all registered adapters', () => {
|
||||
it('should return all 44 registered adapters', () => {
|
||||
const adapters = getAllAdapters();
|
||||
expect(adapters).toBeInstanceOf(Array);
|
||||
expect(adapters.length).toBeGreaterThan(0);
|
||||
expect(adapters.length).toBe(44);
|
||||
});
|
||||
|
||||
it('should include common agents', () => {
|
||||
const adapters = getAllAdapters();
|
||||
const types = adapters.map(a => a.type);
|
||||
|
||||
// Should include at least some well-known agents
|
||||
expect(types).toContain('claude-code');
|
||||
expect(types).toContain('cursor');
|
||||
});
|
||||
|
||||
it('should have an adapter for every AgentType', () => {
|
||||
const adapters = getAllAdapters();
|
||||
const types = new Set(adapters.map(a => a.type));
|
||||
|
||||
for (const agent of ALL_AGENTS) {
|
||||
expect(types.has(agent)).toBe(true);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
describe('getAdapter', () => {
|
||||
@@ -33,6 +73,67 @@ describe('Agent Adapters', () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe('GenericAgentAdapter correctness', () => {
|
||||
it.each(GENERIC_AGENTS)('%s adapter should have correct type', (agent) => {
|
||||
const adapter = getAdapter(agent);
|
||||
expect(adapter).toBeDefined();
|
||||
expect(adapter.type).toBe(agent);
|
||||
});
|
||||
|
||||
it.each(GENERIC_AGENTS)('%s adapter should use AGENT_CONFIG skillsDir', (agent) => {
|
||||
const adapter = getAdapter(agent);
|
||||
const config = AGENT_CONFIG[agent];
|
||||
expect(adapter.skillsDir).toBe(config.skillsDir);
|
||||
});
|
||||
|
||||
it.each(GENERIC_AGENTS)('%s adapter should use AGENT_CONFIG configFile', (agent) => {
|
||||
const adapter = getAdapter(agent);
|
||||
const config = AGENT_CONFIG[agent];
|
||||
expect(adapter.configFile).toBe(config.configFile);
|
||||
});
|
||||
|
||||
it.each(GENERIC_AGENTS)('%s adapter should not have universal name', (agent) => {
|
||||
const adapter = getAdapter(agent);
|
||||
expect(adapter.name).not.toBe('Universal (Any Agent)');
|
||||
});
|
||||
|
||||
it('devin adapter should have correct skillsDir', () => {
|
||||
const adapter = getAdapter('devin');
|
||||
expect(adapter.skillsDir).toBe('.devin/skills');
|
||||
});
|
||||
|
||||
it('sourcegraph-cody adapter should have correct skillsDir', () => {
|
||||
const adapter = getAdapter('sourcegraph-cody');
|
||||
expect(adapter.skillsDir).toBe('.cody/skills');
|
||||
});
|
||||
|
||||
it('amazon-q adapter should have correct skillsDir', () => {
|
||||
const adapter = getAdapter('amazon-q');
|
||||
expect(adapter.skillsDir).toBe('.amazonq/skills');
|
||||
});
|
||||
});
|
||||
|
||||
describe('AGENT_CONFIG completeness', () => {
|
||||
it('should have config for every AgentType', () => {
|
||||
for (const agent of ALL_AGENTS) {
|
||||
const config = AGENT_CONFIG[agent];
|
||||
expect(config).toBeDefined();
|
||||
expect(config.skillsDir).toBeTruthy();
|
||||
expect(config.configFile).toBeTruthy();
|
||||
expect(config.configFormat).toBeTruthy();
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
describe('universal adapter stays universal', () => {
|
||||
it('should have type universal', () => {
|
||||
const adapter = getAdapter('universal');
|
||||
expect(adapter.type).toBe('universal');
|
||||
expect(adapter.skillsDir).toBe('skills');
|
||||
expect(adapter.name).toBe('Universal (Any Agent)');
|
||||
});
|
||||
});
|
||||
|
||||
describe('detectAgent', () => {
|
||||
it('should return an agent type', async () => {
|
||||
const agent = await detectAgent();
|
||||
|
||||
@@ -0,0 +1,144 @@
|
||||
import { existsSync } from 'node:fs';
|
||||
import { join } from 'node:path';
|
||||
import { homedir } from 'node:os';
|
||||
import type { AgentAdapter } from './base.js';
|
||||
import { createSkillXml } from './base.js';
|
||||
import type { Skill, AgentType } from '@skillkit/core';
|
||||
import { AGENT_CONFIG } from '@skillkit/core';
|
||||
|
||||
const AGENT_DISPLAY_NAMES: Partial<Record<AgentType, string>> = {
|
||||
'cline': 'Cline',
|
||||
'codebuddy': 'CodeBuddy',
|
||||
'commandcode': 'CommandCode',
|
||||
'continue': 'Continue',
|
||||
'crush': 'Crush',
|
||||
'mcpjam': 'MCPJam',
|
||||
'mux': 'Mux',
|
||||
'neovate': 'Neovate',
|
||||
'openhands': 'OpenHands',
|
||||
'pi': 'Pi',
|
||||
'qoder': 'Qoder',
|
||||
'qwen': 'Qwen',
|
||||
'vercel': 'Vercel',
|
||||
'zencoder': 'Zencoder',
|
||||
'devin': 'Devin',
|
||||
'aider': 'Aider',
|
||||
'sourcegraph-cody': 'Sourcegraph Cody',
|
||||
'amazon-q': 'Amazon Q Developer',
|
||||
'augment-code': 'Augment Code',
|
||||
'replit-agent': 'Replit Agent',
|
||||
'bolt': 'Bolt',
|
||||
'lovable': 'Lovable',
|
||||
'tabby': 'Tabby',
|
||||
'tabnine': 'Tabnine',
|
||||
'codegpt': 'CodeGPT',
|
||||
'playcode-agent': 'PlayCode Agent',
|
||||
};
|
||||
|
||||
export class GenericAgentAdapter implements AgentAdapter {
|
||||
readonly type: AgentType;
|
||||
readonly name: string;
|
||||
readonly skillsDir: string;
|
||||
readonly configFile: string;
|
||||
|
||||
constructor(agentType: AgentType) {
|
||||
const config = AGENT_CONFIG[agentType];
|
||||
this.type = agentType;
|
||||
this.name = AGENT_DISPLAY_NAMES[agentType] ?? agentType;
|
||||
this.skillsDir = config.skillsDir;
|
||||
this.configFile = config.configFile;
|
||||
}
|
||||
|
||||
generateConfig(skills: Skill[]): string {
|
||||
const enabledSkills = skills.filter(s => s.enabled);
|
||||
if (enabledSkills.length === 0) {
|
||||
return '';
|
||||
}
|
||||
|
||||
const skillsXml = enabledSkills.map(createSkillXml).join('\n\n');
|
||||
const skillsList = enabledSkills
|
||||
.map(s => `- **${s.name}**: ${s.description}`)
|
||||
.join('\n');
|
||||
|
||||
return `# Skills System
|
||||
|
||||
<!-- SKILLKIT_SKILLS_START -->
|
||||
|
||||
## Available Skills
|
||||
|
||||
${skillsList}
|
||||
|
||||
## How to Use Skills
|
||||
|
||||
When a task matches one of the available skills, load it to get detailed instructions:
|
||||
|
||||
\`\`\`bash
|
||||
skillkit read <skill-name>
|
||||
\`\`\`
|
||||
|
||||
Or with npx:
|
||||
|
||||
\`\`\`bash
|
||||
npx skillkit read <skill-name>
|
||||
\`\`\`
|
||||
|
||||
## Skills Data
|
||||
|
||||
<skills_system>
|
||||
<usage>
|
||||
Skills provide specialized capabilities and domain knowledge.
|
||||
- Invoke: \`skillkit read <skill-name>\`
|
||||
- Base directory provided in output for resolving resources
|
||||
- Only use skills listed below
|
||||
- Each invocation is stateless
|
||||
</usage>
|
||||
|
||||
<available_skills>
|
||||
|
||||
${skillsXml}
|
||||
|
||||
</available_skills>
|
||||
</skills_system>
|
||||
|
||||
<!-- SKILLKIT_SKILLS_END -->
|
||||
`;
|
||||
}
|
||||
|
||||
parseConfig(content: string): string[] {
|
||||
const skillNames: string[] = [];
|
||||
|
||||
const skillRegex = /<name>([^<]+)<\/name>/g;
|
||||
let match;
|
||||
while ((match = skillRegex.exec(content)) !== null) {
|
||||
skillNames.push(match[1].trim());
|
||||
}
|
||||
|
||||
if (skillNames.length === 0) {
|
||||
const listRegex = /^- \*\*([a-z0-9-]+)\*\*:/gm;
|
||||
while ((match = listRegex.exec(content)) !== null) {
|
||||
skillNames.push(match[1].trim());
|
||||
}
|
||||
}
|
||||
|
||||
return skillNames;
|
||||
}
|
||||
|
||||
getInvokeCommand(skillName: string): string {
|
||||
return `skillkit read ${skillName}`;
|
||||
}
|
||||
|
||||
async isDetected(): Promise<boolean> {
|
||||
const agentDir = this.skillsDir.split('/')[0];
|
||||
const projectDir = join(process.cwd(), agentDir);
|
||||
const config = AGENT_CONFIG[this.type];
|
||||
|
||||
if (existsSync(projectDir)) return true;
|
||||
|
||||
if (config.globalSkillsDir) {
|
||||
const globalDir = config.globalSkillsDir.replace(/^~/, homedir());
|
||||
if (existsSync(globalDir)) return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
}
|
||||
@@ -18,6 +18,7 @@ import { RooAdapter } from './roo.js';
|
||||
import { TraeAdapter } from './trae.js';
|
||||
import { WindsurfAdapter } from './windsurf.js';
|
||||
import { UniversalAdapter } from './universal.js';
|
||||
import { GenericAgentAdapter } from './generic.js';
|
||||
|
||||
export * from './base.js';
|
||||
export * from './claude-code.js';
|
||||
@@ -38,6 +39,7 @@ export * from './roo.js';
|
||||
export * from './trae.js';
|
||||
export * from './windsurf.js';
|
||||
export * from './universal.js';
|
||||
export * from './generic.js';
|
||||
|
||||
// Agent features
|
||||
export * from './features/index.js';
|
||||
@@ -60,21 +62,33 @@ const adapters: Record<AgentType, AgentAdapter> = {
|
||||
trae: new TraeAdapter(),
|
||||
windsurf: new WindsurfAdapter(),
|
||||
universal: new UniversalAdapter(),
|
||||
cline: new UniversalAdapter(),
|
||||
codebuddy: new UniversalAdapter(),
|
||||
commandcode: new UniversalAdapter(),
|
||||
continue: new UniversalAdapter(),
|
||||
crush: new UniversalAdapter(),
|
||||
factory: new FactoryAdapter(),
|
||||
mcpjam: new UniversalAdapter(),
|
||||
mux: new UniversalAdapter(),
|
||||
neovate: new UniversalAdapter(),
|
||||
openhands: new UniversalAdapter(),
|
||||
pi: new UniversalAdapter(),
|
||||
qoder: new UniversalAdapter(),
|
||||
qwen: new UniversalAdapter(),
|
||||
vercel: new UniversalAdapter(),
|
||||
zencoder: new UniversalAdapter(),
|
||||
cline: new GenericAgentAdapter('cline'),
|
||||
codebuddy: new GenericAgentAdapter('codebuddy'),
|
||||
commandcode: new GenericAgentAdapter('commandcode'),
|
||||
continue: new GenericAgentAdapter('continue'),
|
||||
crush: new GenericAgentAdapter('crush'),
|
||||
mcpjam: new GenericAgentAdapter('mcpjam'),
|
||||
mux: new GenericAgentAdapter('mux'),
|
||||
neovate: new GenericAgentAdapter('neovate'),
|
||||
openhands: new GenericAgentAdapter('openhands'),
|
||||
pi: new GenericAgentAdapter('pi'),
|
||||
qoder: new GenericAgentAdapter('qoder'),
|
||||
qwen: new GenericAgentAdapter('qwen'),
|
||||
vercel: new GenericAgentAdapter('vercel'),
|
||||
zencoder: new GenericAgentAdapter('zencoder'),
|
||||
devin: new GenericAgentAdapter('devin'),
|
||||
aider: new GenericAgentAdapter('aider'),
|
||||
'sourcegraph-cody': new GenericAgentAdapter('sourcegraph-cody'),
|
||||
'amazon-q': new GenericAgentAdapter('amazon-q'),
|
||||
'augment-code': new GenericAgentAdapter('augment-code'),
|
||||
'replit-agent': new GenericAgentAdapter('replit-agent'),
|
||||
bolt: new GenericAgentAdapter('bolt'),
|
||||
lovable: new GenericAgentAdapter('lovable'),
|
||||
tabby: new GenericAgentAdapter('tabby'),
|
||||
tabnine: new GenericAgentAdapter('tabnine'),
|
||||
codegpt: new GenericAgentAdapter('codegpt'),
|
||||
'playcode-agent': new GenericAgentAdapter('playcode-agent'),
|
||||
};
|
||||
|
||||
export function getAdapter(type: AgentType): AgentAdapter {
|
||||
@@ -126,6 +140,18 @@ export async function detectAgent(): Promise<AgentType> {
|
||||
'qwen',
|
||||
'vercel',
|
||||
'zencoder',
|
||||
'devin',
|
||||
'aider',
|
||||
'sourcegraph-cody',
|
||||
'amazon-q',
|
||||
'augment-code',
|
||||
'replit-agent',
|
||||
'bolt',
|
||||
'lovable',
|
||||
'tabby',
|
||||
'tabnine',
|
||||
'codegpt',
|
||||
'playcode-agent',
|
||||
'universal',
|
||||
];
|
||||
|
||||
@@ -138,6 +164,3 @@ export async function detectAgent(): Promise<AgentType> {
|
||||
|
||||
return 'universal';
|
||||
}
|
||||
|
||||
// getSkillsDir and getConfigFile are now re-exported from @skillkit/core above
|
||||
// This ensures a single source of truth for agent configurations
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@skillkit/api",
|
||||
"version": "1.14.0",
|
||||
"version": "1.19.0",
|
||||
"description": "REST API server for SkillKit skill discovery",
|
||||
"type": "module",
|
||||
"main": "./dist/index.js",
|
||||
|
||||
@@ -5,7 +5,7 @@ const OPENAPI_SPEC = {
|
||||
info: {
|
||||
title: 'SkillKit',
|
||||
version: '1.12.0',
|
||||
description: 'Skill Discovery API for AI coding agents. Search, browse, and retrieve skills from the SkillKit marketplace (15,000+ skills across 32 agents).',
|
||||
description: 'Skill Discovery API for AI coding agents. Search, browse, and retrieve skills from the SkillKit marketplace (15,000+ skills across 44 agents).',
|
||||
license: { name: 'Apache-2.0', url: 'https://opensource.org/licenses/Apache-2.0' },
|
||||
contact: { name: 'SkillKit', url: 'https://github.com/rohitg00/skillkit' },
|
||||
},
|
||||
|
||||
@@ -0,0 +1,95 @@
|
||||
import { Hono } from 'hono';
|
||||
import { ContentExtractor, SkillGenerator, AutoTagger } from '@skillkit/core';
|
||||
|
||||
interface SaveRequest {
|
||||
url?: string;
|
||||
text?: string;
|
||||
name?: string;
|
||||
global?: boolean;
|
||||
}
|
||||
|
||||
const MAX_TEXT_LENGTH = 500_000;
|
||||
|
||||
const BLOCKED_HOSTS = new Set(['localhost', '127.0.0.1', '[::1]', '::1', '0.0.0.0']);
|
||||
|
||||
function isAllowedUrl(url: string): boolean {
|
||||
try {
|
||||
const parsed = new URL(url);
|
||||
if (parsed.protocol !== 'http:' && parsed.protocol !== 'https:') return false;
|
||||
|
||||
const hostname = parsed.hostname.toLowerCase();
|
||||
const bare = hostname.replace(/^\[|\]$/g, '');
|
||||
|
||||
if (BLOCKED_HOSTS.has(hostname) || BLOCKED_HOSTS.has(bare)) return false;
|
||||
if (bare.startsWith('::ffff:')) return isAllowedUrl(`http://${bare.slice(7)}`);
|
||||
if (/^127\./.test(bare) || /^0\./.test(bare)) return false;
|
||||
if (bare.startsWith('10.') || bare.startsWith('192.168.')) return false;
|
||||
if (/^172\.(1[6-9]|2\d|3[01])\./.test(bare)) return false;
|
||||
if (bare.startsWith('169.254.')) return false;
|
||||
if (bare.startsWith('fe80:') || bare.startsWith('fc') || bare.startsWith('fd')) return false;
|
||||
if (/^(22[4-9]|23\d|24\d|25[0-5])\./.test(bare)) return false;
|
||||
if (bare.startsWith('ff')) return false;
|
||||
return true;
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
export function saveRoutes() {
|
||||
const app = new Hono();
|
||||
const extractor = new ContentExtractor();
|
||||
const generator = new SkillGenerator();
|
||||
const tagger = new AutoTagger();
|
||||
|
||||
app.post('/save', async (c) => {
|
||||
let body: SaveRequest;
|
||||
try {
|
||||
body = await c.req.json();
|
||||
} catch {
|
||||
return c.json({ error: 'Invalid JSON body' }, 400);
|
||||
}
|
||||
|
||||
if (!body.url && !body.text) {
|
||||
return c.json({ error: 'Either "url" or "text" is required' }, 400);
|
||||
}
|
||||
|
||||
if (body.url && !isAllowedUrl(body.url)) {
|
||||
return c.json({ error: 'URL must be a public HTTP(S) address' }, 400);
|
||||
}
|
||||
|
||||
if (body.text && body.text.length > MAX_TEXT_LENGTH) {
|
||||
return c.json({ error: `Text exceeds maximum length of ${MAX_TEXT_LENGTH} characters` }, 400);
|
||||
}
|
||||
|
||||
try {
|
||||
const content = body.url
|
||||
? await extractor.extractFromUrl(body.url)
|
||||
: extractor.extractFromText(body.text!);
|
||||
|
||||
const result = generator.generate(content, {
|
||||
name: body.name,
|
||||
global: body.global ?? true,
|
||||
});
|
||||
|
||||
return c.json({
|
||||
name: result.name,
|
||||
skillPath: result.skillPath,
|
||||
skillMd: result.skillMd,
|
||||
tags: tagger.detectTags(content),
|
||||
});
|
||||
} catch (err) {
|
||||
const message = err instanceof Error ? err.message : 'Unknown error';
|
||||
const isTimeout =
|
||||
(err instanceof DOMException && err.name === 'TimeoutError') ||
|
||||
(err instanceof Error && (err.name === 'TimeoutError' || err.name === 'AbortError'));
|
||||
|
||||
if (isTimeout) {
|
||||
return c.json({ error: `Fetch timeout: ${message}` }, 504);
|
||||
}
|
||||
|
||||
return c.json({ error: `Extraction failed: ${message}` }, 422);
|
||||
}
|
||||
});
|
||||
|
||||
return app;
|
||||
}
|
||||
@@ -8,6 +8,7 @@ import { skillRoutes } from './routes/skills.js';
|
||||
import { trendingRoutes } from './routes/trending.js';
|
||||
import { categoryRoutes } from './routes/categories.js';
|
||||
import { docsRoutes } from './routes/docs.js';
|
||||
import { saveRoutes } from './routes/save.js';
|
||||
import type { ApiSkill, SearchResponse } from './types.js';
|
||||
|
||||
export interface ServerOptions {
|
||||
@@ -37,6 +38,7 @@ export function createApp(options: ServerOptions = {}) {
|
||||
app.route('/', trendingRoutes(skills));
|
||||
app.route('/', categoryRoutes(skills));
|
||||
app.route('/', docsRoutes());
|
||||
app.route('/', saveRoutes());
|
||||
|
||||
return { app, cache };
|
||||
}
|
||||
|
||||
@@ -159,6 +159,20 @@ skillkit command generate <agent> # Generate agent-native commands
|
||||
skillkit command list <agent> # List available commands
|
||||
```
|
||||
|
||||
### Security Scanning
|
||||
|
||||
```bash
|
||||
skillkit scan <path> # Scan skill for vulnerabilities
|
||||
skillkit scan <path> --format json # Output as JSON
|
||||
skillkit scan <path> --format sarif # SARIF for GitHub Code Scanning
|
||||
skillkit scan <path> --fail-on high # Exit code 1 if HIGH+ findings
|
||||
skillkit scan <path> --skip-rules UC001,UC002 # Skip specific rules
|
||||
```
|
||||
|
||||
Detects: prompt injection, command injection, data exfiltration, tool abuse, hardcoded secrets, unicode steganography.
|
||||
|
||||
Skills are automatically scanned during `install` (use `--no-scan` to skip) and `publish`.
|
||||
|
||||
### Utilities
|
||||
|
||||
```bash
|
||||
@@ -184,6 +198,7 @@ skillkit install ./local/path # Local directory
|
||||
--yes # Skip confirmation prompts
|
||||
--global # Install globally
|
||||
--force # Overwrite existing
|
||||
--no-scan # Skip security scan
|
||||
--agent=cursor,windsurf # Install to specific agents
|
||||
```
|
||||
|
||||
@@ -207,6 +222,12 @@ await installCommand('anthropics/skills', {
|
||||
// List installed skills
|
||||
const skills = await listCommand({ json: true });
|
||||
|
||||
// Security scan
|
||||
import { SkillScanner, formatResult } from '@skillkit/core';
|
||||
const scanner = new SkillScanner({ failOnSeverity: 'high' });
|
||||
const result = await scanner.scan('./my-skill');
|
||||
console.log(formatResult(result, 'summary'));
|
||||
|
||||
// Sync to agent
|
||||
await syncCommand({ all: true });
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@skillkit/cli",
|
||||
"version": "1.14.0",
|
||||
"version": "1.19.0",
|
||||
"description": "CLI commands for SkillKit",
|
||||
"type": "module",
|
||||
"main": "./dist/index.js",
|
||||
|
||||
@@ -20,6 +20,16 @@ describe('CLI Commands', () => {
|
||||
expect(commands.TranslateCommand).toBeDefined();
|
||||
expect(commands.ContextCommand).toBeDefined();
|
||||
expect(commands.RecommendCommand).toBeDefined();
|
||||
|
||||
expect(commands.ActivityCommand).toBeDefined();
|
||||
expect(commands.DoctorCommand).toBeDefined();
|
||||
expect(commands.IssuePlanCommand).toBeDefined();
|
||||
expect(commands.IssueListCommand).toBeDefined();
|
||||
expect(commands.SessionSnapshotSaveCommand).toBeDefined();
|
||||
expect(commands.SessionSnapshotRestoreCommand).toBeDefined();
|
||||
expect(commands.SessionSnapshotListCommand).toBeDefined();
|
||||
expect(commands.SessionSnapshotDeleteCommand).toBeDefined();
|
||||
expect(commands.SessionExplainCommand).toBeDefined();
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
@@ -0,0 +1,232 @@
|
||||
import { describe, it, expect, beforeEach, afterEach } from 'vitest';
|
||||
import { execSync } from 'node:child_process';
|
||||
import { mkdirSync, rmSync, existsSync, readFileSync, writeFileSync } from 'node:fs';
|
||||
import { join } from 'node:path';
|
||||
import { tmpdir } from 'node:os';
|
||||
import { stringify } from 'yaml';
|
||||
|
||||
const CLI = join(__dirname, '../../../../apps/skillkit/dist/cli.js');
|
||||
|
||||
function run(args: string, cwd: string): string {
|
||||
try {
|
||||
return execSync(`node ${CLI} ${args}`, {
|
||||
cwd,
|
||||
encoding: 'utf-8',
|
||||
timeout: 15000,
|
||||
env: { ...process.env, NO_COLOR: '1' },
|
||||
});
|
||||
} catch (err: any) {
|
||||
return err.stdout || err.stderr || err.message;
|
||||
}
|
||||
}
|
||||
|
||||
describe('E2E: Session Features', () => {
|
||||
let testDir: string;
|
||||
|
||||
beforeEach(() => {
|
||||
testDir = join(tmpdir(), `skillkit-e2e-${Date.now()}`);
|
||||
mkdirSync(testDir, { recursive: true });
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
rmSync(testDir, { recursive: true, force: true });
|
||||
});
|
||||
|
||||
describe('skillkit activity', () => {
|
||||
it('should show empty state message', () => {
|
||||
const output = run('activity', testDir);
|
||||
expect(output).toContain('No activity recorded');
|
||||
});
|
||||
|
||||
it('should return empty JSON array', () => {
|
||||
const output = run('activity --json', testDir);
|
||||
const parsed = JSON.parse(output.trim());
|
||||
expect(parsed).toEqual([]);
|
||||
});
|
||||
|
||||
it('should accept --skill filter without error', () => {
|
||||
const output = run('activity --skill code-simplifier', testDir);
|
||||
expect(output).toContain('No activity recorded');
|
||||
});
|
||||
|
||||
it('should accept --limit flag without error', () => {
|
||||
const output = run('activity --limit 5', testDir);
|
||||
expect(output).toContain('No activity recorded');
|
||||
});
|
||||
});
|
||||
|
||||
describe('skillkit session snapshot', () => {
|
||||
it('should list no snapshots initially', () => {
|
||||
const output = run('session snapshot list', testDir);
|
||||
expect(output).toContain('No snapshots found');
|
||||
});
|
||||
|
||||
it('should return empty JSON for snapshot list', () => {
|
||||
const output = run('session snapshot list --json', testDir);
|
||||
const parsed = JSON.parse(output.trim());
|
||||
expect(parsed).toEqual([]);
|
||||
});
|
||||
|
||||
it('should fail to save without active session', () => {
|
||||
const output = run('session snapshot save test-snap', testDir);
|
||||
expect(output).toContain('No active session');
|
||||
});
|
||||
|
||||
it('should fail to restore nonexistent snapshot', () => {
|
||||
const output = run('session snapshot restore nonexistent', testDir);
|
||||
expect(output).toContain('not found');
|
||||
});
|
||||
|
||||
it('should fail to delete nonexistent snapshot', () => {
|
||||
const output = run('session snapshot delete nonexistent', testDir);
|
||||
expect(output).toContain('not found');
|
||||
});
|
||||
|
||||
it('should save and restore snapshot with active session', () => {
|
||||
const skillkitDir = join(testDir, '.skillkit');
|
||||
mkdirSync(skillkitDir, { recursive: true });
|
||||
|
||||
const sessionState = {
|
||||
version: 1,
|
||||
lastActivity: new Date().toISOString(),
|
||||
projectPath: testDir,
|
||||
currentExecution: {
|
||||
skillName: 'code-simplifier',
|
||||
skillSource: 'local',
|
||||
currentStep: 1,
|
||||
totalSteps: 2,
|
||||
status: 'running',
|
||||
startedAt: new Date().toISOString(),
|
||||
tasks: [
|
||||
{
|
||||
id: 'task-1',
|
||||
name: 'Test task',
|
||||
type: 'auto',
|
||||
status: 'completed',
|
||||
},
|
||||
],
|
||||
},
|
||||
history: [],
|
||||
decisions: [{ key: 'test-key', value: 'test-value', madeAt: new Date().toISOString() }],
|
||||
};
|
||||
|
||||
writeFileSync(
|
||||
join(skillkitDir, 'session.yaml'),
|
||||
stringify(sessionState)
|
||||
);
|
||||
|
||||
const saveOutput = run('session snapshot save my-test-snap --desc "E2E test"', testDir);
|
||||
expect(saveOutput).toContain('Snapshot saved: my-test-snap');
|
||||
|
||||
const snapshotFile = join(skillkitDir, 'snapshots', 'my-test-snap.yaml');
|
||||
expect(existsSync(snapshotFile)).toBe(true);
|
||||
|
||||
const listOutput = run('session snapshot list', testDir);
|
||||
expect(listOutput).toContain('my-test-snap');
|
||||
expect(listOutput).toContain('E2E test');
|
||||
|
||||
const restoreOutput = run('session snapshot restore my-test-snap', testDir);
|
||||
expect(restoreOutput).toContain('Snapshot restored: my-test-snap');
|
||||
|
||||
const deleteOutput = run('session snapshot delete my-test-snap', testDir);
|
||||
expect(deleteOutput).toContain('Snapshot deleted: my-test-snap');
|
||||
|
||||
expect(existsSync(snapshotFile)).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe('skillkit session explain', () => {
|
||||
it('should show empty session summary', () => {
|
||||
const output = run('session explain --no-git', testDir);
|
||||
expect(output).toContain('Session Summary');
|
||||
expect(output).toContain('Agent:');
|
||||
expect(output).toContain('Files Modified: 0 files');
|
||||
});
|
||||
|
||||
it('should return valid JSON', () => {
|
||||
const output = run('session explain --json --no-git', testDir);
|
||||
const parsed = JSON.parse(output.trim());
|
||||
expect(parsed.date).toBeDefined();
|
||||
expect(parsed.agent).toBe('unknown');
|
||||
expect(parsed.skillsUsed).toEqual([]);
|
||||
expect(parsed.observationCounts).toBeDefined();
|
||||
expect(typeof parsed.observationCounts.errors).toBe('number');
|
||||
expect(typeof parsed.observationCounts.solutions).toBe('number');
|
||||
expect(typeof parsed.observationCounts.patterns).toBe('number');
|
||||
});
|
||||
|
||||
it('should explain session with active execution', () => {
|
||||
const skillkitDir = join(testDir, '.skillkit');
|
||||
mkdirSync(skillkitDir, { recursive: true });
|
||||
|
||||
const sessionState = {
|
||||
version: 1,
|
||||
lastActivity: new Date().toISOString(),
|
||||
projectPath: testDir,
|
||||
currentExecution: {
|
||||
skillName: 'remotion-best-practices',
|
||||
skillSource: 'claude-code',
|
||||
currentStep: 2,
|
||||
totalSteps: 3,
|
||||
status: 'running',
|
||||
startedAt: new Date(Date.now() - 3600000).toISOString(),
|
||||
tasks: [
|
||||
{
|
||||
id: 't1',
|
||||
name: 'Setup video',
|
||||
type: 'auto',
|
||||
status: 'completed',
|
||||
startedAt: new Date(Date.now() - 3600000).toISOString(),
|
||||
completedAt: new Date(Date.now() - 1800000).toISOString(),
|
||||
filesModified: ['src/video.tsx'],
|
||||
},
|
||||
{
|
||||
id: 't2',
|
||||
name: 'Add effects',
|
||||
type: 'auto',
|
||||
status: 'in_progress',
|
||||
startedAt: new Date(Date.now() - 1800000).toISOString(),
|
||||
},
|
||||
],
|
||||
},
|
||||
history: [],
|
||||
decisions: [
|
||||
{ key: 'codec', value: 'h264', madeAt: new Date().toISOString() },
|
||||
],
|
||||
};
|
||||
|
||||
writeFileSync(
|
||||
join(skillkitDir, 'session.yaml'),
|
||||
stringify(sessionState)
|
||||
);
|
||||
|
||||
const output = run('session explain --no-git', testDir);
|
||||
expect(output).toContain('Session Summary');
|
||||
expect(output).toContain('Duration:');
|
||||
expect(output).toContain('claude-code');
|
||||
expect(output).toContain('remotion-best-practices');
|
||||
expect(output).toContain('Setup video');
|
||||
expect(output).toContain('Add effects');
|
||||
expect(output).toContain('codec');
|
||||
|
||||
const jsonOutput = run('session explain --json --no-git', testDir);
|
||||
const parsed = JSON.parse(jsonOutput.trim());
|
||||
expect(parsed.skillsUsed).toHaveLength(1);
|
||||
expect(parsed.skillsUsed[0].name).toBe('remotion-best-practices');
|
||||
expect(parsed.tasks).toHaveLength(2);
|
||||
expect(parsed.decisions).toHaveLength(1);
|
||||
expect(parsed.filesModified).toContain('src/video.tsx');
|
||||
});
|
||||
});
|
||||
|
||||
describe('skillkit session (help)', () => {
|
||||
it('should list all subcommands including new ones', () => {
|
||||
const output = run('session', testDir);
|
||||
expect(output).toContain('session explain');
|
||||
expect(output).toContain('session snapshot save');
|
||||
expect(output).toContain('session snapshot restore');
|
||||
expect(output).toContain('session snapshot list');
|
||||
expect(output).toContain('session snapshot delete');
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -96,11 +96,10 @@ describe('Onboarding Module', () => {
|
||||
it('should generate full logo with version', async () => {
|
||||
const { getFullLogo } = await import('../onboarding/logo.js');
|
||||
|
||||
const logo = getFullLogo('1.7.2', 32);
|
||||
// Full logo uses block characters (███), not literal text
|
||||
expect(logo).toContain('\u2588'); // █ block character
|
||||
const logo = getFullLogo('1.7.2', 44);
|
||||
expect(logo).toContain('\u2588');
|
||||
expect(logo).toContain('v1.7.2');
|
||||
expect(logo).toContain('32 agents');
|
||||
expect(logo).toContain('44 agents');
|
||||
});
|
||||
|
||||
it('should generate compact logo', async () => {
|
||||
|
||||
@@ -0,0 +1,94 @@
|
||||
import { Command, Option } from 'clipanion';
|
||||
import chalk from 'chalk';
|
||||
import { ActivityLog } from '@skillkit/core';
|
||||
|
||||
export class ActivityCommand extends Command {
|
||||
static override paths = [['activity']];
|
||||
|
||||
static override usage = Command.Usage({
|
||||
description: 'Show skill activity log for git commits',
|
||||
examples: [
|
||||
['Show recent activity', '$0 activity'],
|
||||
['Filter by skill', '$0 activity --skill code-simplifier'],
|
||||
['JSON output', '$0 activity --json'],
|
||||
],
|
||||
});
|
||||
|
||||
skill = Option.String('--skill,-s', {
|
||||
description: 'Filter by skill name',
|
||||
});
|
||||
|
||||
limit = Option.String('--limit,-l', {
|
||||
description: 'Number of entries to show (default: 10)',
|
||||
});
|
||||
|
||||
json = Option.Boolean('--json,-j', false, {
|
||||
description: 'Output as JSON',
|
||||
});
|
||||
|
||||
async execute(): Promise<number> {
|
||||
const projectPath = process.cwd();
|
||||
const log = new ActivityLog(projectPath);
|
||||
const parsed = this.limit ? parseInt(this.limit, 10) : 10;
|
||||
const limit = Number.isFinite(parsed) && parsed > 0 ? parsed : 10;
|
||||
|
||||
const activities = this.skill
|
||||
? log.getBySkill(this.skill)
|
||||
: log.getRecent(limit);
|
||||
|
||||
if (this.json) {
|
||||
console.log(JSON.stringify(activities.slice(0, limit), null, 2));
|
||||
return 0;
|
||||
}
|
||||
|
||||
if (activities.length === 0) {
|
||||
console.log(chalk.yellow('No activity recorded'));
|
||||
console.log(
|
||||
chalk.dim(
|
||||
'Activity is recorded when skills are active during git commits.'
|
||||
)
|
||||
);
|
||||
return 0;
|
||||
}
|
||||
|
||||
console.log(chalk.cyan(' Recent Skill Activity\n'));
|
||||
|
||||
const displayed = activities.slice(0, limit);
|
||||
|
||||
for (const activity of displayed) {
|
||||
const shortSha = activity.commitSha.slice(0, 7);
|
||||
const skills = activity.activeSkills.join(', ');
|
||||
const files = activity.filesChanged.join(', ');
|
||||
const ago = formatTimeAgo(activity.committedAt);
|
||||
|
||||
console.log(` ${chalk.bold(shortSha)} ${activity.message}`);
|
||||
console.log(` Skills: ${chalk.green(skills)}`);
|
||||
console.log(
|
||||
` Files: ${files} ${chalk.dim(`(${ago})`)}`
|
||||
);
|
||||
console.log();
|
||||
}
|
||||
|
||||
const topSkills = log.getMostUsedSkills().slice(0, 5);
|
||||
if (topSkills.length > 0) {
|
||||
const formatted = topSkills
|
||||
.map((s) => `${s.skill} (${s.count})`)
|
||||
.join(', ');
|
||||
console.log(` Top Skills: ${formatted}`);
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
|
||||
function formatTimeAgo(isoDate: string): string {
|
||||
const diff = Date.now() - new Date(isoDate).getTime();
|
||||
const minutes = Math.floor(diff / 60000);
|
||||
const hours = Math.floor(minutes / 60);
|
||||
const days = Math.floor(hours / 24);
|
||||
|
||||
if (days > 0) return `${days}d ago`;
|
||||
if (hours > 0) return `${hours}h ago`;
|
||||
if (minutes > 0) return `${minutes}m ago`;
|
||||
return 'just now';
|
||||
}
|
||||
@@ -0,0 +1,123 @@
|
||||
import { existsSync, readFileSync, writeFileSync } from 'node:fs';
|
||||
import { join } from 'node:path';
|
||||
import chalk from 'chalk';
|
||||
import { Command } from 'clipanion';
|
||||
import { AgentsMdGenerator, AgentsMdParser } from '@skillkit/core';
|
||||
|
||||
export class AgentsMdCommand extends Command {
|
||||
static override paths = [['agents']];
|
||||
|
||||
static override usage = Command.Usage({
|
||||
description: 'Manage AGENTS.md for project-specific agent context',
|
||||
details: `
|
||||
Sub-commands:
|
||||
agents init - Generate initial AGENTS.md
|
||||
agents sync - Update managed sections in existing AGENTS.md
|
||||
agents show - Display current AGENTS.md content
|
||||
`,
|
||||
examples: [
|
||||
['Generate AGENTS.md', '$0 agents init'],
|
||||
['Update skills section', '$0 agents sync'],
|
||||
['Show AGENTS.md', '$0 agents show'],
|
||||
],
|
||||
});
|
||||
|
||||
async execute(): Promise<number> {
|
||||
this.context.stdout.write(this.cli.usage(AgentsMdCommand, { detailed: true }));
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
|
||||
export class AgentsMdInitCommand extends Command {
|
||||
static override paths = [['agents', 'init']];
|
||||
|
||||
static override usage = Command.Usage({
|
||||
description: 'Generate initial AGENTS.md in current directory',
|
||||
});
|
||||
|
||||
async execute(): Promise<number> {
|
||||
const projectPath = process.cwd();
|
||||
const agentsPath = join(projectPath, 'AGENTS.md');
|
||||
|
||||
if (existsSync(agentsPath)) {
|
||||
console.log(chalk.yellow('AGENTS.md already exists. Use `skillkit agents sync` to update.'));
|
||||
return 1;
|
||||
}
|
||||
|
||||
try {
|
||||
const generator = new AgentsMdGenerator({ projectPath });
|
||||
const result = generator.generate();
|
||||
|
||||
console.log(chalk.dim('Preview:'));
|
||||
console.log('');
|
||||
console.log(result.content);
|
||||
|
||||
writeFileSync(agentsPath, result.content, 'utf-8');
|
||||
console.log(chalk.green(`Created ${agentsPath}`));
|
||||
return 0;
|
||||
} catch (err) {
|
||||
console.log(chalk.red(`Failed to generate AGENTS.md: ${err instanceof Error ? err.message : String(err)}`));
|
||||
return 1;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export class AgentsMdSyncCommand extends Command {
|
||||
static override paths = [['agents', 'sync']];
|
||||
|
||||
static override usage = Command.Usage({
|
||||
description: 'Update managed sections in existing AGENTS.md',
|
||||
});
|
||||
|
||||
async execute(): Promise<number> {
|
||||
const projectPath = process.cwd();
|
||||
const agentsPath = join(projectPath, 'AGENTS.md');
|
||||
|
||||
if (!existsSync(agentsPath)) {
|
||||
console.log(chalk.yellow('No AGENTS.md found. Run `skillkit agents init` first.'));
|
||||
return 1;
|
||||
}
|
||||
|
||||
try {
|
||||
const existing = readFileSync(agentsPath, 'utf-8');
|
||||
const parser = new AgentsMdParser();
|
||||
|
||||
if (!parser.hasManagedSections(existing)) {
|
||||
console.log(chalk.yellow('No managed sections found in AGENTS.md. Nothing to update.'));
|
||||
return 0;
|
||||
}
|
||||
|
||||
const generator = new AgentsMdGenerator({ projectPath });
|
||||
const result = generator.generate();
|
||||
const managedSections = result.sections.filter(s => s.managed);
|
||||
const updated = parser.updateManagedSections(existing, managedSections);
|
||||
|
||||
writeFileSync(agentsPath, updated, 'utf-8');
|
||||
console.log(chalk.green(`Updated ${managedSections.length} managed section(s) in AGENTS.md`));
|
||||
return 0;
|
||||
} catch (err) {
|
||||
console.log(chalk.red(`Failed to sync AGENTS.md: ${err instanceof Error ? err.message : String(err)}`));
|
||||
return 1;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export class AgentsMdShowCommand extends Command {
|
||||
static override paths = [['agents', 'show']];
|
||||
|
||||
static override usage = Command.Usage({
|
||||
description: 'Display current AGENTS.md content',
|
||||
});
|
||||
|
||||
async execute(): Promise<number> {
|
||||
const agentsPath = join(process.cwd(), 'AGENTS.md');
|
||||
|
||||
if (!existsSync(agentsPath)) {
|
||||
console.log(chalk.yellow('No AGENTS.md found. Run `skillkit agents init` to create one.'));
|
||||
return 1;
|
||||
}
|
||||
|
||||
console.log(readFileSync(agentsPath, 'utf-8'));
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,297 @@
|
||||
import { Command, Option } from 'clipanion';
|
||||
import { execFileSync } from 'node:child_process';
|
||||
import { existsSync, lstatSync, readlinkSync, readdirSync, mkdirSync, unlinkSync } from 'node:fs';
|
||||
import { resolve, join } from 'node:path';
|
||||
import { homedir } from 'node:os';
|
||||
import { detectAgent, getAdapter } from '@skillkit/agents';
|
||||
import { AgentType, findAllSkills, validateSkill, loadConfig, getProjectConfigPath, getGlobalSkillsDir } from '@skillkit/core';
|
||||
import type { AgentType as AgentTypeT } from '@skillkit/core';
|
||||
import { getSearchDirs } from '../helpers.js';
|
||||
import { colors, symbols } from '../onboarding/index.js';
|
||||
|
||||
interface CheckResult {
|
||||
name: string;
|
||||
status: 'pass' | 'warn' | 'fail';
|
||||
message: string;
|
||||
fix?: string;
|
||||
}
|
||||
|
||||
export class DoctorCommand extends Command {
|
||||
static override paths = [['doctor']];
|
||||
|
||||
static override usage = Command.Usage({
|
||||
description: 'Diagnose setup issues and check environment health',
|
||||
details: `
|
||||
Runs a series of checks to verify your SkillKit setup is correct,
|
||||
including environment, agent detection, skills health, and configuration.
|
||||
`,
|
||||
examples: [
|
||||
['Run health checks', '$0 doctor'],
|
||||
['JSON output', '$0 doctor --json'],
|
||||
['Auto-fix issues', '$0 doctor --fix'],
|
||||
],
|
||||
});
|
||||
|
||||
json = Option.Boolean('--json,-j', false, {
|
||||
description: 'Output in JSON format',
|
||||
});
|
||||
|
||||
fix = Option.Boolean('--fix', false, {
|
||||
description: 'Auto-fix issues where possible',
|
||||
});
|
||||
|
||||
async execute(): Promise<number> {
|
||||
const results: CheckResult[] = [];
|
||||
|
||||
// --- Environment ---
|
||||
const nodeVersion = process.version;
|
||||
const nodeMajor = parseInt(nodeVersion.slice(1).split('.')[0], 10);
|
||||
if (nodeMajor >= 18) {
|
||||
results.push({ name: 'Node.js version', status: 'pass', message: `Node.js ${nodeVersion}` });
|
||||
} else {
|
||||
results.push({ name: 'Node.js version', status: 'fail', message: `Node.js ${nodeVersion} — upgrade to >=18 required` });
|
||||
}
|
||||
|
||||
const npmVersion = this.whichVersion('npm');
|
||||
if (npmVersion) {
|
||||
results.push({ name: 'npm available', status: 'pass', message: `npm v${npmVersion}` });
|
||||
} else {
|
||||
results.push({ name: 'npm available', status: 'warn', message: 'npm not found' });
|
||||
}
|
||||
|
||||
const pnpmVersion = this.whichVersion('pnpm');
|
||||
if (pnpmVersion) {
|
||||
results.push({ name: 'pnpm available', status: 'pass', message: `pnpm v${pnpmVersion}` });
|
||||
}
|
||||
|
||||
const skillkitVersion = this.cli.binaryVersion ?? 'unknown';
|
||||
results.push({ name: 'SkillKit version', status: 'pass', message: `skillkit v${skillkitVersion}` });
|
||||
|
||||
// --- Configuration ---
|
||||
const configPath = getProjectConfigPath();
|
||||
const hasConfig = existsSync(configPath);
|
||||
if (hasConfig) {
|
||||
try {
|
||||
const agent = loadConfig().agent;
|
||||
results.push({ name: 'Config file', status: 'pass', message: `skillkit.yaml (agent: ${agent})` });
|
||||
} catch {
|
||||
results.push({ name: 'Config file', status: 'warn', message: 'skillkit.yaml found but has parse errors' });
|
||||
}
|
||||
} else {
|
||||
results.push({ name: 'Config file', status: 'warn', message: 'No config file (using defaults)' });
|
||||
}
|
||||
|
||||
// --- Agent Detection ---
|
||||
let detectedAgent: AgentTypeT = 'universal';
|
||||
try {
|
||||
detectedAgent = await detectAgent();
|
||||
results.push({ name: 'Detected agent', status: 'pass', message: `Detected: ${detectedAgent}` });
|
||||
} catch {
|
||||
results.push({ name: 'Detected agent', status: 'warn', message: 'No agent detected (using universal)' });
|
||||
}
|
||||
|
||||
const otherDetected: string[] = [];
|
||||
try {
|
||||
for (const agentType of AgentType.options) {
|
||||
if (agentType === detectedAgent || agentType === 'universal') continue;
|
||||
try {
|
||||
const agentAdapter = getAdapter(agentType);
|
||||
if (await agentAdapter.isDetected()) {
|
||||
otherDetected.push(agentType);
|
||||
}
|
||||
} catch {
|
||||
// skip
|
||||
}
|
||||
}
|
||||
if (otherDetected.length > 0) {
|
||||
results.push({ name: 'Other agents', status: 'warn', message: `Also detected: ${otherDetected.join(', ')}` });
|
||||
}
|
||||
} catch {
|
||||
// skip
|
||||
}
|
||||
|
||||
// --- Skills ---
|
||||
const adapter = getAdapter(detectedAgent);
|
||||
const skillsDir = resolve(adapter.skillsDir);
|
||||
const skillsDirExists = existsSync(skillsDir);
|
||||
|
||||
if (skillsDirExists) {
|
||||
const entries = readdirSync(skillsDir).filter(e => !e.startsWith('.'));
|
||||
results.push({ name: 'Project skills dir', status: 'pass', message: `${adapter.skillsDir} (${entries.length} entries)` });
|
||||
} else {
|
||||
if (this.fix) {
|
||||
mkdirSync(skillsDir, { recursive: true });
|
||||
results.push({ name: 'Project skills dir', status: 'pass', message: `${adapter.skillsDir} (created)` });
|
||||
} else {
|
||||
results.push({
|
||||
name: 'Project skills dir',
|
||||
status: 'warn',
|
||||
message: `${adapter.skillsDir} missing`,
|
||||
fix: 'Run with --fix to create it',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const globalSkillsDirRaw = getGlobalSkillsDir(detectedAgent);
|
||||
const globalSkillsDir = globalSkillsDirRaw ? globalSkillsDirRaw.replace(/^~/, homedir()) : null;
|
||||
if (globalSkillsDir && existsSync(globalSkillsDir)) {
|
||||
const entries = readdirSync(globalSkillsDir).filter(e => !e.startsWith('.'));
|
||||
results.push({ name: 'Global skills dir', status: 'pass', message: `${globalSkillsDir} (${entries.length} entries)` });
|
||||
} else {
|
||||
results.push({ name: 'Global skills dir', status: 'pass', message: 'No global skills directory' });
|
||||
}
|
||||
|
||||
// Skill validation
|
||||
let searchDirs: string[] = [];
|
||||
try {
|
||||
searchDirs = getSearchDirs(detectedAgent);
|
||||
} catch {
|
||||
searchDirs = skillsDirExists ? [skillsDir] : [];
|
||||
}
|
||||
|
||||
const allSkills = findAllSkills(searchDirs);
|
||||
const invalidSkills: string[] = [];
|
||||
|
||||
for (const skill of allSkills) {
|
||||
const validation = validateSkill(skill.path);
|
||||
if (!validation.valid) {
|
||||
invalidSkills.push(`${skill.name}: ${validation.errors.join(', ')}`);
|
||||
}
|
||||
}
|
||||
|
||||
if (allSkills.length === 0) {
|
||||
results.push({ name: 'Installed skills', status: 'pass', message: 'No skills installed' });
|
||||
} else if (invalidSkills.length === 0) {
|
||||
results.push({ name: 'Installed skills', status: 'pass', message: `${allSkills.length} skills, all valid` });
|
||||
} else {
|
||||
results.push({
|
||||
name: 'Installed skills',
|
||||
status: 'fail',
|
||||
message: `${invalidSkills.length} of ${allSkills.length} skills have errors`,
|
||||
fix: invalidSkills.join('; '),
|
||||
});
|
||||
}
|
||||
|
||||
// Broken symlinks
|
||||
const brokenSymlinks: string[] = [];
|
||||
for (const dir of searchDirs) {
|
||||
if (!existsSync(dir)) continue;
|
||||
try {
|
||||
const entries = readdirSync(dir);
|
||||
for (const entry of entries) {
|
||||
const fullPath = join(dir, entry);
|
||||
try {
|
||||
const stat = lstatSync(fullPath);
|
||||
if (stat.isSymbolicLink()) {
|
||||
const target = readlinkSync(fullPath);
|
||||
const resolvedTarget = resolve(dir, target);
|
||||
if (!existsSync(resolvedTarget)) {
|
||||
brokenSymlinks.push(fullPath);
|
||||
}
|
||||
}
|
||||
} catch {
|
||||
// skip
|
||||
}
|
||||
}
|
||||
} catch {
|
||||
// skip
|
||||
}
|
||||
}
|
||||
|
||||
if (brokenSymlinks.length > 0) {
|
||||
if (this.fix) {
|
||||
let removed = 0;
|
||||
const failed: string[] = [];
|
||||
for (const link of brokenSymlinks) {
|
||||
try {
|
||||
unlinkSync(link);
|
||||
removed++;
|
||||
} catch {
|
||||
failed.push(link);
|
||||
}
|
||||
}
|
||||
if (failed.length > 0) {
|
||||
results.push({ name: 'Broken symlinks', status: 'warn', message: `Removed ${removed}, failed to remove ${failed.length}` });
|
||||
} else {
|
||||
results.push({ name: 'Broken symlinks', status: 'pass', message: `Removed ${brokenSymlinks.length} broken symlink(s)` });
|
||||
}
|
||||
} else {
|
||||
results.push({
|
||||
name: 'Broken symlinks',
|
||||
status: 'fail',
|
||||
message: `${brokenSymlinks.length} broken symlink(s) found`,
|
||||
fix: brokenSymlinks.map(l => ` ${l}`).join('\n'),
|
||||
});
|
||||
}
|
||||
} else {
|
||||
results.push({ name: 'Broken symlinks', status: 'pass', message: 'No broken symlinks' });
|
||||
}
|
||||
|
||||
// --- Output ---
|
||||
if (this.json) {
|
||||
const summary = {
|
||||
checks: results,
|
||||
passed: results.filter(r => r.status === 'pass').length,
|
||||
warnings: results.filter(r => r.status === 'warn').length,
|
||||
errors: results.filter(r => r.status === 'fail').length,
|
||||
};
|
||||
console.log(JSON.stringify(summary, null, 2));
|
||||
return summary.errors > 0 ? 1 : 0;
|
||||
}
|
||||
|
||||
console.log('');
|
||||
console.log(colors.primary('skillkit doctor'));
|
||||
console.log('');
|
||||
|
||||
const sections: Record<string, string[]> = {
|
||||
Environment: ['Node.js version', 'npm available', 'pnpm available', 'SkillKit version'],
|
||||
Configuration: ['Config file', 'Detected agent', 'Other agents'],
|
||||
Skills: ['Project skills dir', 'Global skills dir', 'Installed skills', 'Broken symlinks'],
|
||||
};
|
||||
|
||||
for (const [section, checkNames] of Object.entries(sections)) {
|
||||
const sectionResults = results.filter(r => checkNames.includes(r.name));
|
||||
if (sectionResults.length === 0) continue;
|
||||
|
||||
console.log(` ${colors.primary(section)}`);
|
||||
for (const result of sectionResults) {
|
||||
const icon = this.statusIcon(result.status);
|
||||
console.log(` ${icon} ${result.message}`);
|
||||
if (result.fix && result.status !== 'pass') {
|
||||
console.log(` ${colors.muted(result.fix)}`);
|
||||
}
|
||||
}
|
||||
console.log('');
|
||||
}
|
||||
|
||||
const passed = results.filter(r => r.status === 'pass').length;
|
||||
const warnings = results.filter(r => r.status === 'warn').length;
|
||||
const errors = results.filter(r => r.status === 'fail').length;
|
||||
|
||||
const parts = [`${passed} passed`];
|
||||
if (warnings > 0) parts.push(`${warnings} warning(s)`);
|
||||
if (errors > 0) parts.push(`${errors} error(s)`);
|
||||
console.log(` ${colors.muted('Summary:')} ${parts.join(', ')}`);
|
||||
console.log('');
|
||||
|
||||
return errors > 0 ? 1 : 0;
|
||||
}
|
||||
|
||||
private statusIcon(status: CheckResult['status']): string {
|
||||
switch (status) {
|
||||
case 'pass': return colors.success(symbols.success);
|
||||
case 'warn': return colors.warning(symbols.warning);
|
||||
case 'fail': return colors.error(symbols.error);
|
||||
}
|
||||
}
|
||||
|
||||
private whichVersion(cmd: string): string | null {
|
||||
try {
|
||||
return execFileSync(cmd, ['--version'], { encoding: 'utf-8', timeout: 5000 })
|
||||
.trim()
|
||||
.replace(/^v/, '');
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -90,7 +90,13 @@ export {
|
||||
SessionNoteCommand,
|
||||
SessionCompleteCommand,
|
||||
SessionInProgressCommand,
|
||||
SessionSnapshotSaveCommand,
|
||||
SessionSnapshotRestoreCommand,
|
||||
SessionSnapshotListCommand,
|
||||
SessionSnapshotDeleteCommand,
|
||||
SessionExplainCommand,
|
||||
} from './session.js';
|
||||
export { ActivityCommand } from './activity.js';
|
||||
export {
|
||||
ProfileCommand,
|
||||
ProfileListCommand,
|
||||
@@ -118,3 +124,13 @@ export { SkillMdValidateCommand, SkillMdInitCommand, SkillMdCheckCommand } from
|
||||
|
||||
// API server
|
||||
export { ServeCommand } from './serve.js';
|
||||
export { ScanCommand } from './scan.js';
|
||||
export { IssuePlanCommand, IssueListCommand } from './issue.js';
|
||||
export { DoctorCommand } from './doctor.js';
|
||||
export { SaveCommand } from './save.js';
|
||||
export {
|
||||
AgentsMdCommand,
|
||||
AgentsMdInitCommand,
|
||||
AgentsMdSyncCommand,
|
||||
AgentsMdShowCommand,
|
||||
} from './agents-md.js';
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
import { existsSync, mkdirSync, cpSync, rmSync, symlinkSync } from 'node:fs';
|
||||
import { existsSync, mkdirSync, cpSync, rmSync, symlinkSync, readFileSync, writeFileSync } from 'node:fs';
|
||||
import { join } from 'node:path';
|
||||
import { execFile } from 'node:child_process';
|
||||
import { promisify } from 'node:util';
|
||||
|
||||
const execFileAsync = promisify(execFile);
|
||||
import { Command, Option } from 'clipanion';
|
||||
import { detectProvider, isLocalPath, getProvider, evaluateSkillDirectory } from '@skillkit/core';
|
||||
import { detectProvider, isLocalPath, getProvider, evaluateSkillDirectory, SkillScanner, formatSummary, Severity, WellKnownProvider, AgentsMdParser, AgentsMdGenerator } from '@skillkit/core';
|
||||
import type { SkillMetadata, GitProvider, AgentType } from '@skillkit/core';
|
||||
import { isPathInside } from '@skillkit/core';
|
||||
import { getAdapter, detectAgent, getAllAdapters } from '@skillkit/agents';
|
||||
@@ -94,6 +94,10 @@ export class InstallCommand extends Command {
|
||||
description: 'Minimal output (no logo)',
|
||||
});
|
||||
|
||||
scan = Option.Boolean('--scan', true, {
|
||||
description: 'Run security scan before installing (default: true)',
|
||||
});
|
||||
|
||||
async execute(): Promise<number> {
|
||||
const isInteractive = process.stdin.isTTY && !this.skills && !this.all && !this.yes;
|
||||
const s = spinner();
|
||||
@@ -105,6 +109,25 @@ export class InstallCommand extends Command {
|
||||
}
|
||||
|
||||
let providerAdapter = detectProvider(this.source);
|
||||
let result: { success: boolean; path?: string; tempRoot?: string; error?: string; skills?: string[]; discoveredSkills?: Array<{ name: string; dirName: string; path: string }> } | null = null;
|
||||
|
||||
const isUrl = this.source.startsWith('http://') || this.source.startsWith('https://');
|
||||
if (isUrl && !this.provider && !providerAdapter) {
|
||||
s.start('Checking for well-known skills...');
|
||||
const wellKnown = new WellKnownProvider();
|
||||
const discovery = await wellKnown.discoverFromUrl(this.source);
|
||||
if (discovery.success) {
|
||||
s.stop(`Found ${discovery.skills?.length || 0} skill(s) via well-known discovery`);
|
||||
providerAdapter = wellKnown;
|
||||
result = discovery;
|
||||
} else {
|
||||
s.stop('No well-known skills found');
|
||||
warn(`No well-known skills found at ${this.source}`);
|
||||
console.log(colors.muted('You can save this URL as a skill instead:'));
|
||||
console.log(colors.muted(` skillkit save ${this.source}`));
|
||||
return 1;
|
||||
}
|
||||
}
|
||||
|
||||
if (this.provider) {
|
||||
providerAdapter = getProvider(this.provider as GitProvider);
|
||||
@@ -120,18 +143,20 @@ export class InstallCommand extends Command {
|
||||
return 1;
|
||||
}
|
||||
|
||||
s.start(`Fetching from ${providerAdapter.name}...`);
|
||||
if (!result) {
|
||||
s.start(`Fetching from ${providerAdapter.name}...`);
|
||||
result = await providerAdapter.clone(this.source, '', { depth: 1 });
|
||||
|
||||
const result = await providerAdapter.clone(this.source, '', { depth: 1 });
|
||||
if (!result.success || !result.path) {
|
||||
s.stop(colors.error(result.error || 'Failed to fetch source'));
|
||||
return 1;
|
||||
}
|
||||
|
||||
if (!result.success || !result.path) {
|
||||
s.stop(colors.error(result.error || 'Failed to fetch source'));
|
||||
return 1;
|
||||
s.stop(`Found ${result.skills?.length || 0} skill(s)`);
|
||||
}
|
||||
|
||||
s.stop(`Found ${result.skills?.length || 0} skill(s)`);
|
||||
|
||||
const discoveredSkills = result.discoveredSkills || [];
|
||||
const cloneResult = result!;
|
||||
const discoveredSkills = cloneResult.discoveredSkills || [];
|
||||
|
||||
// List mode - just show skills and exit
|
||||
if (this.list) {
|
||||
@@ -151,7 +176,7 @@ export class InstallCommand extends Command {
|
||||
console.log(colors.muted('To install: skillkit install <source> --skill=name'));
|
||||
}
|
||||
|
||||
const cleanupPath = result.tempRoot || result.path;
|
||||
const cleanupPath = cloneResult.tempRoot || cloneResult.path;
|
||||
if (!isLocalPath(this.source) && cleanupPath && existsSync(cleanupPath)) {
|
||||
rmSync(cleanupPath, { recursive: true, force: true });
|
||||
}
|
||||
@@ -259,6 +284,29 @@ export class InstallCommand extends Command {
|
||||
}
|
||||
}
|
||||
|
||||
if (this.scan) {
|
||||
const scanner = new SkillScanner({ failOnSeverity: Severity.HIGH });
|
||||
for (const skill of skillsToInstall) {
|
||||
const scanResult = await scanner.scan(skill.path);
|
||||
|
||||
if (scanResult.verdict === 'fail' && !this.force) {
|
||||
error(`Security scan FAILED for "${skill.name}"`);
|
||||
console.log(formatSummary(scanResult));
|
||||
console.log(colors.muted('Use --force to install anyway, or --no-scan to skip scanning'));
|
||||
|
||||
const cleanupPath = cloneResult.tempRoot || cloneResult.path;
|
||||
if (!isLocalPath(this.source) && cleanupPath && existsSync(cleanupPath)) {
|
||||
rmSync(cleanupPath, { recursive: true, force: true });
|
||||
}
|
||||
return 1;
|
||||
}
|
||||
|
||||
if (scanResult.verdict === 'warn' && !this.quiet) {
|
||||
warn(`Security warnings for "${skill.name}" (${scanResult.stats.medium} medium, ${scanResult.stats.low} low)`);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Confirm installation
|
||||
if (isInteractive && !this.yes) {
|
||||
console.log('');
|
||||
@@ -316,8 +364,8 @@ export class InstallCommand extends Command {
|
||||
continue;
|
||||
}
|
||||
|
||||
const securityRoot = result.tempRoot || result.path;
|
||||
if (!isPathInside(sourcePath, securityRoot)) {
|
||||
const securityRoot = cloneResult.tempRoot || cloneResult.path || '';
|
||||
if (!securityRoot || !isPathInside(sourcePath, securityRoot)) {
|
||||
error(`Skipping ${skillName} (path traversal detected)`);
|
||||
continue;
|
||||
}
|
||||
@@ -387,11 +435,29 @@ export class InstallCommand extends Command {
|
||||
}
|
||||
|
||||
// Cleanup temp directory
|
||||
const cleanupPath = result.tempRoot || result.path;
|
||||
const cleanupPath = cloneResult.tempRoot || cloneResult.path;
|
||||
if (!isLocalPath(this.source) && cleanupPath && existsSync(cleanupPath)) {
|
||||
rmSync(cleanupPath, { recursive: true, force: true });
|
||||
}
|
||||
|
||||
if (totalInstalled > 0) {
|
||||
try {
|
||||
const agentsMdPath = join(process.cwd(), 'AGENTS.md');
|
||||
if (existsSync(agentsMdPath)) {
|
||||
const parser = new AgentsMdParser();
|
||||
const existing = readFileSync(agentsMdPath, 'utf-8');
|
||||
if (parser.hasManagedSections(existing)) {
|
||||
const gen = new AgentsMdGenerator({ projectPath: process.cwd() });
|
||||
const genResult = gen.generate();
|
||||
const updated = parser.updateManagedSections(existing, genResult.sections.filter(s => s.managed));
|
||||
writeFileSync(agentsMdPath, updated, 'utf-8');
|
||||
}
|
||||
}
|
||||
} catch {
|
||||
warn('Failed to update AGENTS.md');
|
||||
}
|
||||
}
|
||||
|
||||
// Show summary
|
||||
if (totalInstalled > 0) {
|
||||
if (isInteractive) {
|
||||
|
||||
@@ -0,0 +1,284 @@
|
||||
import { Command, Option } from 'clipanion';
|
||||
import { execFileSync } from 'node:child_process';
|
||||
import { writeFile, mkdir } from 'node:fs/promises';
|
||||
import { resolve, dirname } from 'node:path';
|
||||
import {
|
||||
createIssuePlanner,
|
||||
createPlanGenerator,
|
||||
createPlanValidator,
|
||||
} from '@skillkit/core';
|
||||
|
||||
export class IssuePlanCommand extends Command {
|
||||
static paths = [['issue', 'plan']];
|
||||
|
||||
static usage = Command.Usage({
|
||||
category: 'Development',
|
||||
description: 'Generate a structured plan from a GitHub Issue',
|
||||
details: `
|
||||
Fetches a GitHub Issue and generates a StructuredPlan that can be
|
||||
validated and executed with existing plan commands.
|
||||
|
||||
Requires the \`gh\` CLI to be installed and authenticated.
|
||||
|
||||
Examples:
|
||||
$ skillkit issue plan "#42"
|
||||
$ skillkit issue plan rohitg00/skillkit#42
|
||||
$ skillkit issue plan "#42" --agent cursor --no-tests
|
||||
$ skillkit issue plan "#42" --json
|
||||
`,
|
||||
examples: [
|
||||
['Plan from current repo issue', '$0 issue plan "#42"'],
|
||||
['Plan from specific repo', '$0 issue plan rohitg00/skillkit#42'],
|
||||
['Plan with JSON output', '$0 issue plan "#42" --json'],
|
||||
],
|
||||
});
|
||||
|
||||
ref = Option.String({ required: true });
|
||||
agent = Option.String('--agent,-a', 'claude-code', {
|
||||
description: 'Target agent',
|
||||
});
|
||||
output = Option.String('--output,-o', {
|
||||
description: 'Output file path (default: .skillkit/plans/issue-<n>.md)',
|
||||
});
|
||||
noTests = Option.Boolean('--no-tests', false, {
|
||||
description: 'Skip adding test steps',
|
||||
});
|
||||
json = Option.Boolean('--json', false, {
|
||||
description: 'Output as JSON',
|
||||
});
|
||||
techStack = Option.String('--tech-stack', {
|
||||
description: 'Comma-separated tech stack',
|
||||
});
|
||||
|
||||
async execute(): Promise<number> {
|
||||
try {
|
||||
execFileSync('gh', ['--version'], { encoding: 'utf-8', timeout: 5_000 });
|
||||
} catch {
|
||||
this.context.stderr.write(
|
||||
'Error: GitHub CLI (gh) is not installed or not in PATH.\n' +
|
||||
'Install it from https://cli.github.com/\n'
|
||||
);
|
||||
return 1;
|
||||
}
|
||||
|
||||
const planner = createIssuePlanner();
|
||||
|
||||
let issue;
|
||||
try {
|
||||
issue = planner.fetchIssue(this.ref);
|
||||
} catch (err) {
|
||||
const message = err instanceof Error ? err.message : String(err);
|
||||
this.context.stderr.write(`Error fetching issue: ${message}\n`);
|
||||
return 1;
|
||||
}
|
||||
|
||||
const techStackArr = this.techStack
|
||||
? this.techStack.split(',').map((s) => s.trim())
|
||||
: undefined;
|
||||
|
||||
const plan = planner.generatePlan(issue, {
|
||||
agent: this.agent,
|
||||
techStack: techStackArr,
|
||||
includeTests: !this.noTests,
|
||||
});
|
||||
|
||||
const validator = createPlanValidator();
|
||||
const validation = validator.validate(plan);
|
||||
|
||||
const generator = createPlanGenerator();
|
||||
const markdown = generator.toMarkdown(plan);
|
||||
|
||||
const outputPath =
|
||||
this.output || resolve(`.skillkit/plans/issue-${issue.number}.md`);
|
||||
|
||||
await mkdir(dirname(outputPath), { recursive: true });
|
||||
await writeFile(outputPath, markdown, 'utf-8');
|
||||
|
||||
if (this.json) {
|
||||
this.context.stdout.write(
|
||||
JSON.stringify(
|
||||
{
|
||||
issue: {
|
||||
number: issue.number,
|
||||
title: issue.title,
|
||||
url: issue.url,
|
||||
state: issue.state,
|
||||
labels: issue.labels,
|
||||
},
|
||||
plan: {
|
||||
name: plan.name,
|
||||
goal: plan.goal,
|
||||
tasks: plan.tasks.map((t) => ({
|
||||
id: t.id,
|
||||
name: t.name,
|
||||
files: t.files,
|
||||
steps: t.steps.length,
|
||||
status: t.status,
|
||||
})),
|
||||
metadata: plan.metadata,
|
||||
},
|
||||
validation: {
|
||||
valid: validation.valid,
|
||||
issues: validation.issues.length,
|
||||
stats: validation.stats,
|
||||
},
|
||||
outputPath,
|
||||
},
|
||||
null,
|
||||
2
|
||||
) + '\n'
|
||||
);
|
||||
} else {
|
||||
this.context.stdout.write(`\n Issue #${issue.number}: ${issue.title}\n\n`);
|
||||
this.context.stdout.write(` Generated Plan: ${outputPath}\n\n`);
|
||||
this.context.stdout.write(` Tasks (${plan.tasks.length})\n`);
|
||||
for (const task of plan.tasks) {
|
||||
const fileList: string[] = [];
|
||||
if (task.files.create) {
|
||||
fileList.push(...task.files.create.map((f) => `${f} (create)`));
|
||||
}
|
||||
if (task.files.modify) {
|
||||
fileList.push(...task.files.modify.map((f) => `${f} (modify)`));
|
||||
}
|
||||
this.context.stdout.write(` ${task.id}. ${task.name}\n`);
|
||||
if (fileList.length > 0) {
|
||||
this.context.stdout.write(
|
||||
` Files: ${fileList.join(', ')}\n`
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
if (plan.tags && plan.tags.length > 0) {
|
||||
this.context.stdout.write(
|
||||
`\n Labels: ${issue.labels.join(', ')} -> ${plan.tags.join(', ')}\n`
|
||||
);
|
||||
}
|
||||
this.context.stdout.write(` Agent: ${this.agent}\n\n`);
|
||||
|
||||
if (!validation.valid) {
|
||||
this.context.stdout.write(
|
||||
` Warnings: ${validation.issues.length}\n`
|
||||
);
|
||||
}
|
||||
|
||||
this.context.stdout.write(
|
||||
` Next: skillkit plan validate -f ${outputPath}\n` +
|
||||
` skillkit plan execute -f ${outputPath} --dry-run\n\n`
|
||||
);
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
|
||||
export class IssueListCommand extends Command {
|
||||
static paths = [['issue', 'list']];
|
||||
|
||||
static usage = Command.Usage({
|
||||
category: 'Development',
|
||||
description: 'List open GitHub Issues',
|
||||
details: `
|
||||
Lists open issues from a GitHub repository. Useful for picking
|
||||
which issue to plan.
|
||||
|
||||
Examples:
|
||||
$ skillkit issue list
|
||||
$ skillkit issue list --repo rohitg00/skillkit --label bug
|
||||
$ skillkit issue list --limit 20 --json
|
||||
`,
|
||||
examples: [
|
||||
['List issues in current repo', '$0 issue list'],
|
||||
['Filter by label', '$0 issue list --label enhancement'],
|
||||
],
|
||||
});
|
||||
|
||||
repo = Option.String('--repo,-r', {
|
||||
description: 'Repository (owner/repo)',
|
||||
});
|
||||
label = Option.String('--label,-l', {
|
||||
description: 'Filter by label',
|
||||
});
|
||||
limit = Option.String('--limit', '10', {
|
||||
description: 'Maximum issues to list',
|
||||
});
|
||||
json = Option.Boolean('--json', false, {
|
||||
description: 'Output as JSON',
|
||||
});
|
||||
|
||||
async execute(): Promise<number> {
|
||||
try {
|
||||
execFileSync('gh', ['--version'], { encoding: 'utf-8', timeout: 5_000 });
|
||||
} catch {
|
||||
this.context.stderr.write(
|
||||
'Error: GitHub CLI (gh) is not installed or not in PATH.\n'
|
||||
);
|
||||
return 1;
|
||||
}
|
||||
|
||||
const args = [
|
||||
'issue',
|
||||
'list',
|
||||
'--limit',
|
||||
this.limit,
|
||||
'--json',
|
||||
'number,title,labels,assignees',
|
||||
'--state',
|
||||
'open',
|
||||
];
|
||||
|
||||
if (this.repo) {
|
||||
args.push('--repo', this.repo);
|
||||
}
|
||||
if (this.label) {
|
||||
args.push('--label', this.label);
|
||||
}
|
||||
|
||||
let result: string;
|
||||
try {
|
||||
result = execFileSync('gh', args, {
|
||||
encoding: 'utf-8',
|
||||
timeout: 15_000,
|
||||
});
|
||||
} catch (err) {
|
||||
const message = err instanceof Error ? err.message : String(err);
|
||||
this.context.stderr.write(`Error listing issues: ${message}\n`);
|
||||
return 1;
|
||||
}
|
||||
|
||||
let issues: Array<{
|
||||
number: number;
|
||||
title: string;
|
||||
labels: Array<{ name: string }>;
|
||||
assignees: Array<{ login: string }>;
|
||||
}>;
|
||||
try {
|
||||
issues = JSON.parse(result);
|
||||
} catch {
|
||||
this.context.stderr.write('Error: Failed to parse GitHub CLI response.\n');
|
||||
return 1;
|
||||
}
|
||||
|
||||
if (this.json) {
|
||||
this.context.stdout.write(JSON.stringify(issues, null, 2) + '\n');
|
||||
} else {
|
||||
if (issues.length === 0) {
|
||||
this.context.stdout.write(' No open issues found.\n');
|
||||
return 0;
|
||||
}
|
||||
|
||||
this.context.stdout.write('\n Open Issues\n\n');
|
||||
for (const issue of issues) {
|
||||
const labels = issue.labels.map((l) => l.name).join(', ');
|
||||
const labelStr = labels ? ` [${labels}]` : '';
|
||||
this.context.stdout.write(
|
||||
` #${issue.number} ${issue.title}${labelStr}\n`
|
||||
);
|
||||
}
|
||||
this.context.stdout.write(
|
||||
`\n Use: skillkit issue plan "#<number>" to generate a plan\n\n`
|
||||
);
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
@@ -22,13 +22,13 @@ export class PrimerCommand extends Command {
|
||||
for AI coding agents.
|
||||
|
||||
By default, it generates instructions for detected agents in your project.
|
||||
Use --all-agents to generate for all 32 supported agents.
|
||||
Use --all-agents to generate for all 44 supported agents.
|
||||
|
||||
Inspired by github.com/pierceboggan/primer but extended for all SkillKit agents.
|
||||
`,
|
||||
examples: [
|
||||
['Generate for detected agents', '$0 primer'],
|
||||
['Generate for all 32 agents', '$0 primer --all-agents'],
|
||||
['Generate for all 44 agents', '$0 primer --all-agents'],
|
||||
['Generate for specific agents', '$0 primer --agent claude-code,cursor,github-copilot'],
|
||||
['Custom output directory', '$0 primer --output ./instructions'],
|
||||
['Preview without writing files', '$0 primer --dry-run'],
|
||||
@@ -42,7 +42,7 @@ export class PrimerCommand extends Command {
|
||||
});
|
||||
|
||||
allAgents = Option.Boolean('--all-agents,-A', false, {
|
||||
description: 'Generate for all 32 supported agents',
|
||||
description: 'Generate for all 44 supported agents',
|
||||
});
|
||||
|
||||
output = Option.String('--output,-o', {
|
||||
|
||||
@@ -2,7 +2,7 @@ import { existsSync, readFileSync, mkdirSync, writeFileSync, readdirSync, statSy
|
||||
import { join, basename, dirname, resolve } from 'node:path';
|
||||
import chalk from 'chalk';
|
||||
import { Command, Option } from 'clipanion';
|
||||
import { generateWellKnownIndex, type WellKnownSkill } from '@skillkit/core';
|
||||
import { generateWellKnownIndex, type WellKnownSkill, SkillScanner, formatSummary, Severity } from '@skillkit/core';
|
||||
|
||||
function sanitizeSkillName(name: string): string | null {
|
||||
if (!name || typeof name !== 'string') return null;
|
||||
@@ -55,6 +55,10 @@ export class PublishCommand extends Command {
|
||||
description: 'Show what would be generated without writing files',
|
||||
});
|
||||
|
||||
format = Option.String('--format', {
|
||||
description: 'Output format: "standard" (default) or "mintlify" (.well-known/skills/default/skill.md)',
|
||||
});
|
||||
|
||||
async execute(): Promise<number> {
|
||||
const basePath = this.skillPath || process.cwd();
|
||||
const outputDir = this.output || basePath;
|
||||
@@ -72,7 +76,6 @@ export class PublishCommand extends Command {
|
||||
console.log(chalk.white(`Found ${discoveredSkills.length} skill(s):\n`));
|
||||
|
||||
const wellKnownSkills: WellKnownSkill[] = [];
|
||||
|
||||
const validSkills: Array<{ name: string; safeName: string; description?: string; path: string }> = [];
|
||||
|
||||
for (const skill of discoveredSkills) {
|
||||
@@ -95,6 +98,20 @@ export class PublishCommand extends Command {
|
||||
});
|
||||
}
|
||||
|
||||
const scanner = new SkillScanner({ failOnSeverity: Severity.HIGH });
|
||||
for (const skill of validSkills) {
|
||||
const scanResult = await scanner.scan(skill.path);
|
||||
if (scanResult.verdict === 'fail') {
|
||||
console.error(chalk.red(`\nSecurity scan FAILED for "${skill.safeName}"`));
|
||||
console.error(formatSummary(scanResult));
|
||||
console.error(chalk.dim('Fix security issues before publishing.'));
|
||||
return 1;
|
||||
}
|
||||
if (scanResult.verdict === 'warn') {
|
||||
console.log(chalk.yellow(` Security warnings for "${skill.safeName}" (${scanResult.findings.length} findings)`));
|
||||
}
|
||||
}
|
||||
|
||||
if (validSkills.length === 0) {
|
||||
console.error(chalk.red('\nNo valid skills to publish'));
|
||||
return 1;
|
||||
@@ -102,6 +119,44 @@ export class PublishCommand extends Command {
|
||||
|
||||
console.log('');
|
||||
|
||||
if (this.format === 'mintlify') {
|
||||
if (this.dryRun) {
|
||||
console.log(chalk.yellow('Dry run - not writing files\n'));
|
||||
console.log(chalk.white('Would generate (Mintlify format):'));
|
||||
for (const skill of validSkills) {
|
||||
console.log(chalk.dim(` ${outputDir}/.well-known/skills/${skill.safeName}/skill.md`));
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
|
||||
const resolvedOutput = resolve(outputDir);
|
||||
for (const skill of validSkills) {
|
||||
const mintlifyDir = join(outputDir, '.well-known', 'skills', skill.safeName);
|
||||
const resolvedDir = resolve(mintlifyDir);
|
||||
if (!resolvedDir.startsWith(resolvedOutput)) {
|
||||
console.log(chalk.red(`Skipping ${skill.safeName} (path traversal detected)`));
|
||||
continue;
|
||||
}
|
||||
mkdirSync(mintlifyDir, { recursive: true });
|
||||
const skillMdPath = join(skill.path, 'SKILL.md');
|
||||
if (existsSync(skillMdPath)) {
|
||||
const content = readFileSync(skillMdPath, 'utf-8');
|
||||
writeFileSync(join(mintlifyDir, 'skill.md'), content);
|
||||
}
|
||||
}
|
||||
|
||||
console.log(chalk.green('Generated Mintlify well-known structure:\n'));
|
||||
for (const skill of validSkills) {
|
||||
console.log(chalk.dim(` ${outputDir}/.well-known/skills/${skill.safeName}/skill.md`));
|
||||
}
|
||||
console.log('');
|
||||
console.log(chalk.cyan('Next steps:'));
|
||||
console.log(chalk.dim(' 1. Deploy the .well-known directory to your web server'));
|
||||
console.log(chalk.dim(' 2. Users can install via: skillkit install https://your-domain.com'));
|
||||
console.log(chalk.dim(' 3. Skills auto-discovered from /.well-known/skills/{name}/skill.md'));
|
||||
return 0;
|
||||
}
|
||||
|
||||
if (this.dryRun) {
|
||||
console.log(chalk.yellow('Dry run - not writing files\n'));
|
||||
console.log(chalk.white('Would generate:'));
|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
import { existsSync, rmSync } from 'node:fs';
|
||||
import { existsSync, rmSync, readFileSync, writeFileSync } from 'node:fs';
|
||||
import { join } from 'node:path';
|
||||
import chalk from 'chalk';
|
||||
import { Command, Option } from 'clipanion';
|
||||
import { findSkill } from '@skillkit/core';
|
||||
import { findSkill, AgentsMdParser, AgentsMdGenerator } from '@skillkit/core';
|
||||
import { getSearchDirs } from '../helpers.js';
|
||||
|
||||
export class RemoveCommand extends Command {
|
||||
@@ -52,6 +53,22 @@ export class RemoveCommand extends Command {
|
||||
}
|
||||
|
||||
if (removed > 0) {
|
||||
try {
|
||||
const agentsMdPath = join(process.cwd(), 'AGENTS.md');
|
||||
if (existsSync(agentsMdPath)) {
|
||||
const parser = new AgentsMdParser();
|
||||
const existing = readFileSync(agentsMdPath, 'utf-8');
|
||||
if (parser.hasManagedSections(existing)) {
|
||||
const gen = new AgentsMdGenerator({ projectPath: process.cwd() });
|
||||
const genResult = gen.generate();
|
||||
const updated = parser.updateManagedSections(existing, genResult.sections.filter(s => s.managed));
|
||||
writeFileSync(agentsMdPath, updated, 'utf-8');
|
||||
}
|
||||
}
|
||||
} catch (error) {
|
||||
console.log(chalk.yellow('Warning: Failed to update AGENTS.md'));
|
||||
console.error(chalk.dim(error instanceof Error ? error.message : String(error)));
|
||||
}
|
||||
console.log(chalk.dim('\nRun `skillkit sync` to update your agent config'));
|
||||
}
|
||||
|
||||
|
||||
@@ -0,0 +1,120 @@
|
||||
import { cpSync, mkdirSync } from 'node:fs';
|
||||
import { dirname, join } from 'node:path';
|
||||
import chalk from 'chalk';
|
||||
import { Command, Option } from 'clipanion';
|
||||
import { ContentExtractor, SkillGenerator, AutoTagger } from '@skillkit/core';
|
||||
import type { AgentType } from '@skillkit/core';
|
||||
import { getAdapter } from '@skillkit/agents';
|
||||
import { spinner } from '../onboarding/index.js';
|
||||
|
||||
export class SaveCommand extends Command {
|
||||
static override paths = [['save']];
|
||||
|
||||
static override usage = Command.Usage({
|
||||
description: 'Save content from a URL, text, or file as a reusable skill',
|
||||
examples: [
|
||||
['Save a webpage as a skill', '$0 save https://example.com/guide'],
|
||||
['Save with a custom name', '$0 save https://example.com/guide --name my-guide'],
|
||||
['Save raw text', '$0 save --text "Always use TypeScript strict mode"'],
|
||||
['Save a local file', '$0 save --file ./notes.md'],
|
||||
['Save globally', '$0 save https://example.com/guide --global'],
|
||||
['Save and install to agents', '$0 save https://example.com/guide --agent claude-code,cursor'],
|
||||
],
|
||||
});
|
||||
|
||||
url = Option.String({ required: false });
|
||||
|
||||
name = Option.String('--name,-n', {
|
||||
description: 'Custom skill name',
|
||||
});
|
||||
|
||||
agent = Option.String('--agent,-a', {
|
||||
description: 'Comma-separated list of agents to install the skill to',
|
||||
});
|
||||
|
||||
global = Option.Boolean('--global,-g', false, {
|
||||
description: 'Save to global skills directory',
|
||||
});
|
||||
|
||||
text = Option.String('--text,-t', {
|
||||
description: 'Raw text to save as a skill',
|
||||
});
|
||||
|
||||
file = Option.String('--file,-f', {
|
||||
description: 'Local file path to save as a skill',
|
||||
});
|
||||
|
||||
async execute(): Promise<number> {
|
||||
const sources = [this.url, this.text, this.file].filter(Boolean);
|
||||
if (sources.length === 0) {
|
||||
console.log(chalk.red('Provide a URL, --text, or --file'));
|
||||
return 1;
|
||||
}
|
||||
if (sources.length > 1) {
|
||||
console.log(chalk.red('Provide only one of: URL, --text, or --file'));
|
||||
return 1;
|
||||
}
|
||||
|
||||
const extractor = new ContentExtractor();
|
||||
const generator = new SkillGenerator();
|
||||
const tagger = new AutoTagger();
|
||||
|
||||
const s = spinner();
|
||||
|
||||
try {
|
||||
s.start('Extracting content');
|
||||
|
||||
let content;
|
||||
if (this.url) {
|
||||
content = await extractor.extractFromUrl(this.url);
|
||||
} else if (this.text) {
|
||||
content = extractor.extractFromText(this.text);
|
||||
} else {
|
||||
content = extractor.extractFromFile(this.file!);
|
||||
}
|
||||
|
||||
const tags = tagger.detectTags(content);
|
||||
content.tags = tags;
|
||||
|
||||
s.message('Generating skill');
|
||||
|
||||
const result = generator.generate(content, {
|
||||
name: this.name,
|
||||
global: this.global,
|
||||
});
|
||||
|
||||
s.stop(chalk.green('Skill saved'));
|
||||
|
||||
console.log('');
|
||||
console.log(chalk.bold(' Name: ') + chalk.cyan(result.name));
|
||||
console.log(chalk.bold(' Path: ') + chalk.dim(result.skillPath));
|
||||
if (tags.length > 0) {
|
||||
console.log(chalk.bold(' Tags: ') + tags.map(t => chalk.yellow(t)).join(', '));
|
||||
}
|
||||
|
||||
if (this.agent) {
|
||||
const agents = this.agent.split(',').map(a => a.trim()).filter(Boolean);
|
||||
const skillDir = dirname(result.skillPath);
|
||||
|
||||
for (const agentName of agents) {
|
||||
try {
|
||||
const adapter = getAdapter(agentName as AgentType);
|
||||
const targetDir = join(adapter.skillsDir, result.name);
|
||||
mkdirSync(targetDir, { recursive: true });
|
||||
cpSync(skillDir, targetDir, { recursive: true });
|
||||
console.log(chalk.green(` Installed to ${agentName}: `) + chalk.dim(targetDir));
|
||||
} catch (err) {
|
||||
console.log(chalk.yellow(` Skipped ${agentName}: ${err instanceof Error ? err.message : String(err)}`));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
console.log('');
|
||||
return 0;
|
||||
} catch (err) {
|
||||
s.stop(chalk.red('Failed'));
|
||||
console.log(chalk.red(err instanceof Error ? err.message : String(err)));
|
||||
return 1;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,85 @@
|
||||
import { Command, Option } from 'clipanion';
|
||||
import { resolve } from 'node:path';
|
||||
import { existsSync } from 'node:fs';
|
||||
import { SkillScanner, formatResult, Severity } from '@skillkit/core';
|
||||
|
||||
const SEVERITY_MAP: Record<string, Severity> = {
|
||||
critical: Severity.CRITICAL,
|
||||
high: Severity.HIGH,
|
||||
medium: Severity.MEDIUM,
|
||||
low: Severity.LOW,
|
||||
info: Severity.INFO,
|
||||
};
|
||||
|
||||
export class ScanCommand extends Command {
|
||||
static override paths = [['scan']];
|
||||
|
||||
static override usage = Command.Usage({
|
||||
description: 'Scan a skill directory for security vulnerabilities',
|
||||
details: `
|
||||
Analyzes skill files for prompt injection, command injection, data exfiltration,
|
||||
tool abuse, hardcoded secrets, and unicode steganography.
|
||||
|
||||
Outputs findings in various formats including SARIF for GitHub Code Scanning.
|
||||
`,
|
||||
examples: [
|
||||
['Scan current directory', '$0 scan .'],
|
||||
['Scan a specific skill', '$0 scan ./my-skill'],
|
||||
['Output as JSON', '$0 scan ./my-skill --format json'],
|
||||
['Output as SARIF', '$0 scan ./my-skill --format sarif'],
|
||||
['Fail on high severity', '$0 scan ./my-skill --fail-on high'],
|
||||
['Skip unicode rules', '$0 scan ./my-skill --skip-rules UC001,UC002'],
|
||||
],
|
||||
});
|
||||
|
||||
skillPath = Option.String({ required: true, name: 'path' });
|
||||
|
||||
format = Option.String('--format,-f', 'summary', {
|
||||
description: 'Output format: summary, json, table, sarif',
|
||||
});
|
||||
|
||||
failOn = Option.String('--fail-on', {
|
||||
description: 'Exit with code 1 if findings at this severity or above (critical, high, medium, low)',
|
||||
});
|
||||
|
||||
skipRules = Option.String('--skip-rules', {
|
||||
description: 'Comma-separated rule IDs or categories to skip',
|
||||
});
|
||||
|
||||
async execute(): Promise<number> {
|
||||
const targetPath = resolve(this.skillPath);
|
||||
|
||||
if (!existsSync(targetPath)) {
|
||||
this.context.stderr.write(`Path not found: ${targetPath}\n`);
|
||||
return 1;
|
||||
}
|
||||
|
||||
const validFormats = ['summary', 'json', 'table', 'sarif'];
|
||||
if (!validFormats.includes(this.format)) {
|
||||
this.context.stderr.write(`Invalid format: "${this.format}". Must be one of: ${validFormats.join(', ')}\n`);
|
||||
return 1;
|
||||
}
|
||||
|
||||
const skipRules = this.skipRules?.split(',').map((s) => s.trim()) ?? [];
|
||||
|
||||
let failOnSeverity: Severity | undefined;
|
||||
if (this.failOn) {
|
||||
failOnSeverity = SEVERITY_MAP[this.failOn.toLowerCase()];
|
||||
if (!failOnSeverity) {
|
||||
this.context.stderr.write(`Invalid --fail-on value: "${this.failOn}". Must be one of: ${Object.keys(SEVERITY_MAP).join(', ')}\n`);
|
||||
return 1;
|
||||
}
|
||||
}
|
||||
|
||||
const scanner = new SkillScanner({
|
||||
failOnSeverity,
|
||||
skipRules,
|
||||
});
|
||||
|
||||
const result = await scanner.scan(targetPath);
|
||||
|
||||
this.context.stdout.write(formatResult(result, this.format) + '\n');
|
||||
|
||||
return result.verdict === 'fail' ? 1 : 0;
|
||||
}
|
||||
}
|
||||
@@ -7,7 +7,12 @@ import {
|
||||
updateSessionFile,
|
||||
listSessions,
|
||||
getMostRecentSession,
|
||||
SnapshotManager,
|
||||
SessionManager,
|
||||
SessionExplainer,
|
||||
ObservationStore,
|
||||
type SessionFile,
|
||||
type SessionSnapshot,
|
||||
} from '@skillkit/core';
|
||||
|
||||
export class SessionCommand extends Command {
|
||||
@@ -28,12 +33,17 @@ export class SessionCommand extends Command {
|
||||
|
||||
async execute(): Promise<number> {
|
||||
console.log(chalk.cyan('Session commands:\n'));
|
||||
console.log(' session status Show current session state');
|
||||
console.log(' session start Start a new session');
|
||||
console.log(' session load Load session from specific date');
|
||||
console.log(' session list List recent sessions');
|
||||
console.log(' session note Add note to current session');
|
||||
console.log(' session complete Mark task as completed');
|
||||
console.log(' session status Show current session state');
|
||||
console.log(' session start Start a new session');
|
||||
console.log(' session load Load session from specific date');
|
||||
console.log(' session list List recent sessions');
|
||||
console.log(' session note Add note to current session');
|
||||
console.log(' session complete Mark task as completed');
|
||||
console.log(' session explain Explain current session');
|
||||
console.log(' session snapshot save Save session snapshot');
|
||||
console.log(' session snapshot restore Restore session snapshot');
|
||||
console.log(' session snapshot list List snapshots');
|
||||
console.log(' session snapshot delete Delete snapshot');
|
||||
console.log();
|
||||
return 0;
|
||||
}
|
||||
@@ -319,3 +329,210 @@ export class SessionInProgressCommand extends Command {
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
|
||||
export class SessionSnapshotSaveCommand extends Command {
|
||||
static override paths = [['session', 'snapshot', 'save']];
|
||||
|
||||
static override usage = Command.Usage({
|
||||
description: 'Save current session state as a named snapshot',
|
||||
examples: [
|
||||
['Save snapshot', '$0 session snapshot save my-feature'],
|
||||
['With description', '$0 session snapshot save my-feature --desc "Before refactor"'],
|
||||
],
|
||||
});
|
||||
|
||||
name = Option.String({ required: true });
|
||||
|
||||
desc = Option.String('--desc,-d', {
|
||||
description: 'Snapshot description',
|
||||
});
|
||||
|
||||
async execute(): Promise<number> {
|
||||
const projectPath = process.cwd();
|
||||
const manager = new SnapshotManager(projectPath);
|
||||
const sessionMgr = new SessionManager(projectPath);
|
||||
|
||||
const state = sessionMgr.get();
|
||||
if (!state) {
|
||||
console.log(chalk.yellow('No active session to snapshot'));
|
||||
return 1;
|
||||
}
|
||||
|
||||
let observations: SessionSnapshot['observations'] = [];
|
||||
try {
|
||||
const raw = ObservationStore.readAll(projectPath);
|
||||
observations = raw.map((o) => ({
|
||||
id: o.id,
|
||||
timestamp: o.timestamp,
|
||||
sessionId: o.sessionId,
|
||||
agent: o.agent as string,
|
||||
type: o.type as string,
|
||||
content: { ...o.content } as Record<string, unknown>,
|
||||
relevance: o.relevance,
|
||||
}));
|
||||
} catch {
|
||||
// No observations available
|
||||
}
|
||||
|
||||
manager.save(this.name, state, observations, this.desc);
|
||||
console.log(chalk.green(`\u2713 Snapshot saved: ${this.name}`));
|
||||
if (this.desc) {
|
||||
console.log(chalk.dim(` ${this.desc}`));
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
|
||||
export class SessionSnapshotRestoreCommand extends Command {
|
||||
static override paths = [['session', 'snapshot', 'restore']];
|
||||
|
||||
static override usage = Command.Usage({
|
||||
description: 'Restore session state from a snapshot',
|
||||
examples: [['Restore snapshot', '$0 session snapshot restore my-feature']],
|
||||
});
|
||||
|
||||
name = Option.String({ required: true });
|
||||
|
||||
async execute(): Promise<number> {
|
||||
const projectPath = process.cwd();
|
||||
const manager = new SnapshotManager(projectPath);
|
||||
|
||||
if (!manager.exists(this.name)) {
|
||||
console.log(chalk.red(`Snapshot "${this.name}" not found`));
|
||||
return 1;
|
||||
}
|
||||
|
||||
const { sessionState, observations } = manager.restore(this.name);
|
||||
|
||||
const sessionMgr = new SessionManager(projectPath);
|
||||
const currentState = sessionMgr.getOrCreate();
|
||||
Object.assign(currentState, {
|
||||
currentExecution: sessionState.currentExecution,
|
||||
history: sessionState.history,
|
||||
decisions: sessionState.decisions,
|
||||
});
|
||||
sessionMgr.save();
|
||||
|
||||
try {
|
||||
if (observations && observations.length > 0) {
|
||||
const store = new ObservationStore(projectPath);
|
||||
for (const obs of observations) {
|
||||
store.add(
|
||||
obs.type as Parameters<ObservationStore['add']>[0],
|
||||
obs.content as unknown as Parameters<ObservationStore['add']>[1],
|
||||
obs.agent as Parameters<ObservationStore['add']>[2],
|
||||
obs.relevance,
|
||||
);
|
||||
}
|
||||
}
|
||||
} catch {
|
||||
// Non-critical: session state restored even if observations fail
|
||||
}
|
||||
|
||||
console.log(chalk.green(`\u2713 Snapshot restored: ${this.name}`));
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
|
||||
export class SessionSnapshotListCommand extends Command {
|
||||
static override paths = [['session', 'snapshot', 'list'], ['session', 'snapshot', 'ls']];
|
||||
|
||||
static override usage = Command.Usage({
|
||||
description: 'List all session snapshots',
|
||||
examples: [['List snapshots', '$0 session snapshot list']],
|
||||
});
|
||||
|
||||
json = Option.Boolean('--json,-j', false, {
|
||||
description: 'Output as JSON',
|
||||
});
|
||||
|
||||
async execute(): Promise<number> {
|
||||
const projectPath = process.cwd();
|
||||
const manager = new SnapshotManager(projectPath);
|
||||
const snapshots = manager.list();
|
||||
|
||||
if (this.json) {
|
||||
console.log(JSON.stringify(snapshots, null, 2));
|
||||
return 0;
|
||||
}
|
||||
|
||||
if (snapshots.length === 0) {
|
||||
console.log(chalk.yellow('No snapshots found'));
|
||||
console.log(chalk.dim('Save one with: skillkit session snapshot save <name>'));
|
||||
return 0;
|
||||
}
|
||||
|
||||
console.log(chalk.cyan(`Snapshots (${snapshots.length}):\n`));
|
||||
|
||||
for (const snap of snapshots) {
|
||||
console.log(` ${chalk.bold(snap.name)}`);
|
||||
console.log(` Created: ${snap.createdAt}`);
|
||||
if (snap.description) {
|
||||
console.log(` ${chalk.dim(snap.description)}`);
|
||||
}
|
||||
console.log(` Skills in history: ${snap.skillCount}`);
|
||||
console.log();
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
|
||||
export class SessionSnapshotDeleteCommand extends Command {
|
||||
static override paths = [['session', 'snapshot', 'delete']];
|
||||
|
||||
static override usage = Command.Usage({
|
||||
description: 'Delete a session snapshot',
|
||||
examples: [['Delete snapshot', '$0 session snapshot delete my-feature']],
|
||||
});
|
||||
|
||||
name = Option.String({ required: true });
|
||||
|
||||
async execute(): Promise<number> {
|
||||
const projectPath = process.cwd();
|
||||
const manager = new SnapshotManager(projectPath);
|
||||
|
||||
if (!manager.delete(this.name)) {
|
||||
console.log(chalk.red(`Snapshot "${this.name}" not found`));
|
||||
return 1;
|
||||
}
|
||||
|
||||
console.log(chalk.green(`\u2713 Snapshot deleted: ${this.name}`));
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
|
||||
export class SessionExplainCommand extends Command {
|
||||
static override paths = [['session', 'explain']];
|
||||
|
||||
static override usage = Command.Usage({
|
||||
description: 'Explain what happened in the current session',
|
||||
examples: [
|
||||
['Explain session', '$0 session explain'],
|
||||
['JSON output', '$0 session explain --json'],
|
||||
['Skip git', '$0 session explain --no-git'],
|
||||
],
|
||||
});
|
||||
|
||||
json = Option.Boolean('--json,-j', false, {
|
||||
description: 'Output as JSON',
|
||||
});
|
||||
|
||||
noGit = Option.Boolean('--no-git', false, {
|
||||
description: 'Skip git analysis',
|
||||
});
|
||||
|
||||
async execute(): Promise<number> {
|
||||
const projectPath = process.cwd();
|
||||
const explainer = new SessionExplainer(projectPath);
|
||||
const explanation = explainer.explain({ includeGit: !this.noGit });
|
||||
|
||||
if (this.json) {
|
||||
console.log(explainer.formatJson(explanation));
|
||||
return 0;
|
||||
}
|
||||
|
||||
console.log(explainer.formatText(explanation));
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,7 +1,23 @@
|
||||
import { Command, Option } from 'clipanion';
|
||||
import { resolve } from 'node:path';
|
||||
import { existsSync } from 'node:fs';
|
||||
import chalk from 'chalk';
|
||||
import { SessionManager } from '@skillkit/core';
|
||||
import type { AgentType } from '@skillkit/core';
|
||||
import { SessionManager, findAllSkills, loadConfig, getProjectConfigPath } from '@skillkit/core';
|
||||
import { detectAgent, getAdapter } from '@skillkit/agents';
|
||||
import { getSearchDirs } from '../helpers.js';
|
||||
|
||||
interface StatusOverview {
|
||||
agent: string;
|
||||
config: string | null;
|
||||
configAgent: string;
|
||||
version: string;
|
||||
totalSkills: number;
|
||||
projectSkills: number;
|
||||
globalSkills: number;
|
||||
skillsDir: string;
|
||||
recentHistory: Array<{ status: string; skillName: string; completedAt: string }>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Status command - show current session state
|
||||
@@ -22,22 +38,18 @@ export class StatusCommand extends Command {
|
||||
],
|
||||
});
|
||||
|
||||
// Show history
|
||||
history = Option.Boolean('--history,-h', false, {
|
||||
description: 'Show execution history',
|
||||
});
|
||||
|
||||
// History limit
|
||||
limit = Option.String('--limit,-l', {
|
||||
description: 'Limit history entries (default: 10)',
|
||||
});
|
||||
|
||||
// JSON output
|
||||
json = Option.Boolean('--json,-j', false, {
|
||||
description: 'Output in JSON format',
|
||||
});
|
||||
|
||||
// Project path
|
||||
projectPath = Option.String('--path,-p', {
|
||||
description: 'Project path (default: current directory)',
|
||||
});
|
||||
@@ -47,14 +59,18 @@ export class StatusCommand extends Command {
|
||||
const manager = new SessionManager(targetPath);
|
||||
const state = manager.get();
|
||||
|
||||
if (this.json) {
|
||||
console.log(JSON.stringify(state || { message: 'No session found' }, null, 2));
|
||||
if (!state) {
|
||||
const overview = await this.buildOverview(manager);
|
||||
if (this.json) {
|
||||
console.log(JSON.stringify({ session: null, overview }, null, 2));
|
||||
return 0;
|
||||
}
|
||||
this.showOverview(overview);
|
||||
return 0;
|
||||
}
|
||||
|
||||
if (!state) {
|
||||
console.log(chalk.dim('No active session found.'));
|
||||
console.log(chalk.dim('Run a skill with "skillkit run <skill>" to start a session.'));
|
||||
if (this.json) {
|
||||
console.log(JSON.stringify(state, null, 2));
|
||||
return 0;
|
||||
}
|
||||
|
||||
@@ -134,6 +150,81 @@ export class StatusCommand extends Command {
|
||||
return 0;
|
||||
}
|
||||
|
||||
private async buildOverview(manager: SessionManager): Promise<StatusOverview> {
|
||||
let agent: AgentType = 'universal';
|
||||
try {
|
||||
agent = await detectAgent();
|
||||
} catch {
|
||||
// fallback
|
||||
}
|
||||
|
||||
const configPath = getProjectConfigPath();
|
||||
const hasConfig = existsSync(configPath);
|
||||
let configAgent = 'universal';
|
||||
if (hasConfig) {
|
||||
try {
|
||||
configAgent = loadConfig().agent;
|
||||
} catch {
|
||||
// ignore
|
||||
}
|
||||
}
|
||||
|
||||
const version = this.cli.binaryVersion ?? 'unknown';
|
||||
|
||||
let searchDirs: string[] = [];
|
||||
try {
|
||||
searchDirs = getSearchDirs(agent);
|
||||
} catch {
|
||||
// fallback
|
||||
}
|
||||
|
||||
const allSkills = findAllSkills(searchDirs);
|
||||
const projectSkills = allSkills.filter(s => s.location === 'project');
|
||||
const globalSkills = allSkills.filter(s => s.location === 'global');
|
||||
const adapter = getAdapter(agent);
|
||||
const recentHistory = manager.getHistory(3);
|
||||
|
||||
return {
|
||||
agent,
|
||||
config: hasConfig ? configPath : null,
|
||||
configAgent,
|
||||
version,
|
||||
totalSkills: allSkills.length,
|
||||
projectSkills: projectSkills.length,
|
||||
globalSkills: globalSkills.length,
|
||||
skillsDir: adapter.skillsDir,
|
||||
recentHistory,
|
||||
};
|
||||
}
|
||||
|
||||
private showOverview(overview: StatusOverview): void {
|
||||
console.log('');
|
||||
console.log(chalk.cyan(' Project Overview'));
|
||||
console.log(` Agent: ${chalk.bold(overview.agent)}`);
|
||||
console.log(` Config: ${overview.config ? chalk.green('skillkit.yaml') : chalk.dim('none (defaults)')}`);
|
||||
console.log(` Version: ${chalk.bold(overview.version)}`);
|
||||
console.log('');
|
||||
|
||||
console.log(chalk.cyan(` Skills (${overview.totalSkills} installed)`));
|
||||
console.log(` Project: ${overview.projectSkills} skills in ${overview.skillsDir}`);
|
||||
console.log(` Global: ${overview.globalSkills} skills`);
|
||||
console.log('');
|
||||
|
||||
console.log(chalk.cyan(' Recent Activity'));
|
||||
if (overview.recentHistory.length === 0) {
|
||||
console.log(chalk.dim(' No recent executions.'));
|
||||
} else {
|
||||
for (const entry of overview.recentHistory) {
|
||||
const statusColor = entry.status === 'completed' ? chalk.green : chalk.red;
|
||||
console.log(` ${statusColor('\u25cf')} ${entry.skillName} - ${new Date(entry.completedAt).toLocaleDateString()}`);
|
||||
}
|
||||
}
|
||||
console.log('');
|
||||
|
||||
console.log(chalk.dim(' Tip: Run "skillkit doctor" for a full health check.'));
|
||||
console.log('');
|
||||
}
|
||||
|
||||
private getStatusIcon(status: string): string {
|
||||
switch (status) {
|
||||
case 'completed':
|
||||
|
||||
@@ -9,8 +9,10 @@ import {
|
||||
isHighQuality,
|
||||
findAllSkills,
|
||||
benchmarkSkill,
|
||||
SpecValidator,
|
||||
type QualityScore,
|
||||
type BenchmarkResult,
|
||||
type SpecValidationResult,
|
||||
} from '@skillkit/core';
|
||||
import { getSearchDirs } from '../helpers.js';
|
||||
import {
|
||||
@@ -142,6 +144,22 @@ function printBenchmarkReport(benchmark: BenchmarkResult): void {
|
||||
}
|
||||
}
|
||||
|
||||
function printSpecReport(specResult: SpecValidationResult): void {
|
||||
console.log('');
|
||||
console.log(colors.bold('Spec Validation'));
|
||||
console.log(` ${colors.muted('Spec Version:')} ${specResult.specVersion}`);
|
||||
console.log(` ${colors.muted('Valid:')} ${specResult.valid ? colors.success('yes') : colors.error('no')}`);
|
||||
|
||||
if (specResult.checks.length > 0) {
|
||||
console.log('');
|
||||
for (const check of specResult.checks) {
|
||||
const icon = check.passed ? colors.success(symbols.success) : (check.severity === 'error' ? colors.error(symbols.error) : colors.warning(symbols.warning));
|
||||
console.log(` ${icon} ${check.message}`);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
function getOrdinal(n: number): string {
|
||||
const s = ['th', 'st', 'nd', 'rd'];
|
||||
const v = n % 100;
|
||||
@@ -198,6 +216,10 @@ export class ValidateCommand extends Command {
|
||||
description: 'Compare skill against category leaders',
|
||||
});
|
||||
|
||||
strict = Option.Boolean('--strict,-s', false, {
|
||||
description: 'Run strict spec validation checks',
|
||||
});
|
||||
|
||||
fix = Option.Boolean('--fix', false, {
|
||||
description: 'Automatically fix common quality issues (runs fix command)',
|
||||
});
|
||||
@@ -378,7 +400,7 @@ export class ValidateCommand extends Command {
|
||||
|
||||
filteredResults.sort((a, b) => (b.quality?.overall ?? 0) - (a.quality?.overall ?? 0));
|
||||
|
||||
for (const { name, quality, formatValid, formatErrors } of filteredResults) {
|
||||
for (const { name, quality, formatValid, formatErrors, path: skillPath } of filteredResults) {
|
||||
if (!formatValid) {
|
||||
console.log(`\n${colors.error(symbols.error)} ${colors.primary(name)}`);
|
||||
console.log(` ${colors.error('Format validation failed:')}`);
|
||||
@@ -395,6 +417,12 @@ export class ValidateCommand extends Command {
|
||||
printBenchmarkReport(benchmark);
|
||||
}
|
||||
}
|
||||
|
||||
if (this.strict && skillPath) {
|
||||
const specValidator = new SpecValidator();
|
||||
const specResult = specValidator.validate(skillPath, { strict: true });
|
||||
printSpecReport(specResult);
|
||||
}
|
||||
}
|
||||
|
||||
console.log('');
|
||||
|
||||
@@ -88,7 +88,7 @@ import {
|
||||
} from './preferences.js';
|
||||
|
||||
let VERSION = '1.7.6';
|
||||
let AGENT_COUNT = 32;
|
||||
let AGENT_COUNT = 44;
|
||||
|
||||
export function setVersion(version: string): void {
|
||||
VERSION = version;
|
||||
|
||||
@@ -17,6 +17,18 @@ export const AGENT_ICONS: Record<string, string> = {
|
||||
'trae': '\u25c6',
|
||||
'antigravity': '\u229b',
|
||||
'clawdbot': '\u27d0',
|
||||
'devin': '\u25a7',
|
||||
'aider': '\u25a8',
|
||||
'sourcegraph-cody': '\u25a9',
|
||||
'amazon-q': '\u25aa',
|
||||
'augment-code': '\u25ab',
|
||||
'replit-agent': '\u25b4',
|
||||
'bolt': '\u26a1',
|
||||
'lovable': '\u2665',
|
||||
'tabby': '\u25b9',
|
||||
'tabnine': '\u25ba',
|
||||
'codegpt': '\u25bb',
|
||||
'playcode-agent': '\u25bd',
|
||||
'universal': '\u25cf',
|
||||
};
|
||||
|
||||
@@ -37,6 +49,18 @@ export const AGENT_NAMES: Record<string, string> = {
|
||||
'trae': 'Trae',
|
||||
'antigravity': 'Antigravity',
|
||||
'clawdbot': 'Clawdbot',
|
||||
'devin': 'Devin',
|
||||
'aider': 'Aider',
|
||||
'sourcegraph-cody': 'Cody',
|
||||
'amazon-q': 'Amazon Q',
|
||||
'augment-code': 'Augment',
|
||||
'replit-agent': 'Replit',
|
||||
'bolt': 'Bolt',
|
||||
'lovable': 'Lovable',
|
||||
'tabby': 'Tabby',
|
||||
'tabnine': 'Tabnine',
|
||||
'codegpt': 'CodeGPT',
|
||||
'playcode-agent': 'PlayCode',
|
||||
'universal': 'Universal',
|
||||
};
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@skillkit/core",
|
||||
"version": "1.14.0",
|
||||
"version": "1.19.0",
|
||||
"description": "Core functionality for SkillKit - skill discovery, parsing, and translation",
|
||||
"type": "module",
|
||||
"main": "./dist/index.js",
|
||||
@@ -53,22 +53,25 @@
|
||||
"test": "vitest run"
|
||||
},
|
||||
"dependencies": {
|
||||
"@mozilla/readability": "^0.6.0",
|
||||
"minimatch": "^10.1.1",
|
||||
"turndown": "^7.2.2",
|
||||
"yaml": "^2.6.1",
|
||||
"zod": "^3.24.1"
|
||||
},
|
||||
"optionalDependencies": {
|
||||
"@anthropic-ai/sdk": "^0.39.0",
|
||||
"openai": "^4.0.0",
|
||||
"@google/genai": "^1.0.0",
|
||||
"ollama": "^0.5.0",
|
||||
"node-llama-cpp": "^3.15.0",
|
||||
"better-sqlite3": "^12.0.0",
|
||||
"node-llama-cpp": "^3.15.0",
|
||||
"ollama": "^0.5.0",
|
||||
"openai": "^4.0.0",
|
||||
"sqlite-vec": "^0.1.6"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/better-sqlite3": "^7.6.11",
|
||||
"@types/node": "^22.10.5",
|
||||
"@types/turndown": "^5.0.6",
|
||||
"tsup": "^8.3.5",
|
||||
"typescript": "^5.7.2",
|
||||
"vitest": "^2.1.8"
|
||||
|
||||
@@ -348,6 +348,119 @@ export const AGENT_CONFIG: Record<AgentType, AgentDirectoryConfig> = {
|
||||
usesFrontmatter: true,
|
||||
supportsAutoDiscovery: true,
|
||||
},
|
||||
|
||||
// Devin (Cognition Labs)
|
||||
devin: {
|
||||
skillsDir: '.devin/skills',
|
||||
configFile: 'AGENTS.md',
|
||||
configFormat: 'markdown',
|
||||
usesFrontmatter: true,
|
||||
supportsAutoDiscovery: true,
|
||||
},
|
||||
|
||||
// Aider
|
||||
aider: {
|
||||
skillsDir: '.aider/skills',
|
||||
configFile: 'AGENTS.md',
|
||||
globalSkillsDir: '~/.aider/skills',
|
||||
configFormat: 'markdown',
|
||||
usesFrontmatter: true,
|
||||
supportsAutoDiscovery: true,
|
||||
},
|
||||
|
||||
// Sourcegraph Cody
|
||||
'sourcegraph-cody': {
|
||||
skillsDir: '.cody/skills',
|
||||
configFile: 'AGENTS.md',
|
||||
globalSkillsDir: '~/.cody/skills',
|
||||
configFormat: 'markdown',
|
||||
usesFrontmatter: true,
|
||||
supportsAutoDiscovery: true,
|
||||
},
|
||||
|
||||
// Amazon Q Developer
|
||||
'amazon-q': {
|
||||
skillsDir: '.amazonq/skills',
|
||||
configFile: 'AGENTS.md',
|
||||
globalSkillsDir: '~/.amazonq/skills',
|
||||
configFormat: 'markdown',
|
||||
usesFrontmatter: true,
|
||||
supportsAutoDiscovery: true,
|
||||
},
|
||||
|
||||
// Augment Code
|
||||
'augment-code': {
|
||||
skillsDir: '.augment/skills',
|
||||
configFile: 'AGENTS.md',
|
||||
configFormat: 'markdown',
|
||||
usesFrontmatter: true,
|
||||
supportsAutoDiscovery: true,
|
||||
},
|
||||
|
||||
// Replit Agent
|
||||
'replit-agent': {
|
||||
skillsDir: '.replit/skills',
|
||||
configFile: 'AGENTS.md',
|
||||
configFormat: 'markdown',
|
||||
usesFrontmatter: true,
|
||||
supportsAutoDiscovery: true,
|
||||
},
|
||||
|
||||
// Bolt (Vercel)
|
||||
bolt: {
|
||||
skillsDir: '.bolt/skills',
|
||||
configFile: 'AGENTS.md',
|
||||
configFormat: 'markdown',
|
||||
usesFrontmatter: true,
|
||||
supportsAutoDiscovery: true,
|
||||
},
|
||||
|
||||
// Lovable
|
||||
lovable: {
|
||||
skillsDir: '.lovable/skills',
|
||||
configFile: 'AGENTS.md',
|
||||
configFormat: 'markdown',
|
||||
usesFrontmatter: true,
|
||||
supportsAutoDiscovery: true,
|
||||
},
|
||||
|
||||
// Tabby
|
||||
tabby: {
|
||||
skillsDir: '.tabby/skills',
|
||||
configFile: 'AGENTS.md',
|
||||
globalSkillsDir: '~/.tabby/skills',
|
||||
configFormat: 'markdown',
|
||||
usesFrontmatter: true,
|
||||
supportsAutoDiscovery: true,
|
||||
},
|
||||
|
||||
// Tabnine
|
||||
tabnine: {
|
||||
skillsDir: '.tabnine/skills',
|
||||
configFile: 'AGENTS.md',
|
||||
globalSkillsDir: '~/.tabnine/skills',
|
||||
configFormat: 'markdown',
|
||||
usesFrontmatter: true,
|
||||
supportsAutoDiscovery: true,
|
||||
},
|
||||
|
||||
// CodeGPT
|
||||
codegpt: {
|
||||
skillsDir: '.codegpt/skills',
|
||||
configFile: 'AGENTS.md',
|
||||
configFormat: 'markdown',
|
||||
usesFrontmatter: true,
|
||||
supportsAutoDiscovery: true,
|
||||
},
|
||||
|
||||
// PlayCode Agent
|
||||
'playcode-agent': {
|
||||
skillsDir: '.playcode/skills',
|
||||
configFile: 'AGENTS.md',
|
||||
configFormat: 'markdown',
|
||||
usesFrontmatter: true,
|
||||
supportsAutoDiscovery: true,
|
||||
},
|
||||
};
|
||||
|
||||
/**
|
||||
|
||||
@@ -0,0 +1,206 @@
|
||||
import { existsSync, readFileSync } from 'node:fs';
|
||||
import { join } from 'node:path';
|
||||
import { ProjectDetector } from '../context/detector.js';
|
||||
import { findAllSkills } from '../skills.js';
|
||||
import type { Skill } from '../types.js';
|
||||
import type { AgentsMdConfig, AgentsMdResult, AgentsMdSection } from './types.js';
|
||||
|
||||
function escapeTableCell(text: string): string {
|
||||
return text.replace(/\|/g, '\\|').replace(/\n/g, ' ');
|
||||
}
|
||||
|
||||
const MANAGED_START = '<!-- skillkit:managed:start -->';
|
||||
const MANAGED_END = '<!-- skillkit:managed:end -->';
|
||||
|
||||
export class AgentsMdGenerator {
|
||||
private config: AgentsMdConfig;
|
||||
private detector: ProjectDetector;
|
||||
|
||||
constructor(config: AgentsMdConfig) {
|
||||
this.config = config;
|
||||
this.detector = new ProjectDetector(config.projectPath);
|
||||
}
|
||||
|
||||
generate(): AgentsMdResult {
|
||||
this.detector.analyze();
|
||||
|
||||
const sections: AgentsMdSection[] = [];
|
||||
|
||||
sections.push({
|
||||
id: 'project-overview',
|
||||
title: 'Project Overview',
|
||||
content: this.generateProjectSection(),
|
||||
managed: true,
|
||||
});
|
||||
|
||||
sections.push({
|
||||
id: 'technology-stack',
|
||||
title: 'Technology Stack',
|
||||
content: this.generateStackSection(),
|
||||
managed: true,
|
||||
});
|
||||
|
||||
if (this.config.includeSkills !== false) {
|
||||
const skillsContent = this.generateSkillsSection(findAllSkills([join(this.config.projectPath, 'skills')]));
|
||||
if (skillsContent) {
|
||||
sections.push({
|
||||
id: 'installed-skills',
|
||||
title: 'Installed Skills',
|
||||
content: skillsContent,
|
||||
managed: true,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
if (this.config.includeBuildCommands !== false) {
|
||||
const buildContent = this.generateBuildSection();
|
||||
if (buildContent) {
|
||||
sections.push({
|
||||
id: 'build-test',
|
||||
title: 'Build & Test',
|
||||
content: buildContent,
|
||||
managed: true,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
if (this.config.includeCodeStyle !== false) {
|
||||
const styleContent = this.generateCodeStyleSection();
|
||||
if (styleContent) {
|
||||
sections.push({
|
||||
id: 'code-style',
|
||||
title: 'Code Style',
|
||||
content: styleContent,
|
||||
managed: true,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const lines: string[] = ['# AGENTS.md', '', MANAGED_START];
|
||||
for (const section of sections) {
|
||||
lines.push(`## ${section.title}`);
|
||||
lines.push(section.content);
|
||||
lines.push('');
|
||||
}
|
||||
lines.push(MANAGED_END, '');
|
||||
|
||||
const content = lines.join('\n');
|
||||
return {
|
||||
content,
|
||||
sections,
|
||||
path: join(this.config.projectPath, 'AGENTS.md'),
|
||||
};
|
||||
}
|
||||
|
||||
generateSkillsSection(skills: Skill[]): string {
|
||||
if (skills.length === 0) {
|
||||
return '';
|
||||
}
|
||||
|
||||
const lines: string[] = [
|
||||
'| Skill | Description | Tags |',
|
||||
'|-------|-------------|------|',
|
||||
];
|
||||
|
||||
for (const skill of skills) {
|
||||
const name = escapeTableCell(skill.name);
|
||||
const desc = escapeTableCell(skill.description);
|
||||
lines.push(`| ${name} | ${desc} | |`);
|
||||
}
|
||||
|
||||
return lines.join('\n');
|
||||
}
|
||||
|
||||
generateProjectSection(): string {
|
||||
const name = this.detector.getProjectName();
|
||||
const description = this.detector.getProjectDescription();
|
||||
const projectType = this.detector.detectProjectType();
|
||||
|
||||
const lines: string[] = [];
|
||||
lines.push(`- **Name**: ${name}`);
|
||||
if (description) {
|
||||
lines.push(`- **Description**: ${description}`);
|
||||
}
|
||||
lines.push(`- **Type**: ${projectType}`);
|
||||
|
||||
return lines.join('\n');
|
||||
}
|
||||
|
||||
generateBuildSection(): string {
|
||||
const packageJsonPath = join(this.config.projectPath, 'package.json');
|
||||
if (!existsSync(packageJsonPath)) {
|
||||
return '';
|
||||
}
|
||||
|
||||
try {
|
||||
const pkg = JSON.parse(readFileSync(packageJsonPath, 'utf-8'));
|
||||
const scripts = pkg.scripts as Record<string, string> | undefined;
|
||||
if (!scripts || Object.keys(scripts).length === 0) {
|
||||
return '';
|
||||
}
|
||||
|
||||
const relevantScripts = ['build', 'dev', 'start', 'test', 'lint', 'format', 'typecheck', 'check'];
|
||||
const lines: string[] = ['```bash'];
|
||||
|
||||
for (const key of relevantScripts) {
|
||||
if (scripts[key]) {
|
||||
lines.push(`# ${key}`);
|
||||
lines.push(scripts[key]);
|
||||
lines.push('');
|
||||
}
|
||||
}
|
||||
|
||||
if (lines.length === 1) {
|
||||
return '';
|
||||
}
|
||||
|
||||
lines.push('```');
|
||||
return lines.join('\n');
|
||||
} catch {
|
||||
return '';
|
||||
}
|
||||
}
|
||||
|
||||
generateCodeStyleSection(): string {
|
||||
const patterns = this.detector.detectPatterns();
|
||||
const lines: string[] = [];
|
||||
|
||||
if (patterns.linting) {
|
||||
lines.push(`- **Linting**: ${patterns.linting}`);
|
||||
}
|
||||
if (patterns.formatting) {
|
||||
lines.push(`- **Formatting**: ${patterns.formatting}`);
|
||||
}
|
||||
if (patterns.testing) {
|
||||
lines.push(`- **Testing**: ${patterns.testing}`);
|
||||
}
|
||||
if (patterns.styling) {
|
||||
lines.push(`- **Styling**: ${patterns.styling}`);
|
||||
}
|
||||
|
||||
return lines.length > 0 ? lines.join('\n') : '';
|
||||
}
|
||||
|
||||
private generateStackSection(): string {
|
||||
const stack = this.detector.analyze();
|
||||
const lines: string[] = [];
|
||||
|
||||
if (stack.languages.length > 0) {
|
||||
lines.push(`- **Languages**: ${stack.languages.map(l => l.version ? `${l.name} ${l.version}` : l.name).join(', ')}`);
|
||||
}
|
||||
if (stack.frameworks.length > 0) {
|
||||
lines.push(`- **Frameworks**: ${stack.frameworks.map(f => f.version ? `${f.name} ${f.version}` : f.name).join(', ')}`);
|
||||
}
|
||||
if (stack.libraries.length > 0) {
|
||||
lines.push(`- **Libraries**: ${stack.libraries.map(l => l.name).join(', ')}`);
|
||||
}
|
||||
if (stack.databases.length > 0) {
|
||||
lines.push(`- **Databases**: ${stack.databases.map(d => d.name).join(', ')}`);
|
||||
}
|
||||
if (stack.runtime.length > 0) {
|
||||
lines.push(`- **Runtime**: ${stack.runtime.map(r => r.version ? `${r.name} ${r.version}` : r.name).join(', ')}`);
|
||||
}
|
||||
|
||||
return lines.length > 0 ? lines.join('\n') : 'No technology stack detected.';
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,3 @@
|
||||
export { AgentsMdGenerator } from './generator.js';
|
||||
export { AgentsMdParser } from './parser.js';
|
||||
export type { AgentsMdConfig, AgentsMdSection, AgentsMdResult } from './types.js';
|
||||
@@ -0,0 +1,103 @@
|
||||
import type { AgentsMdSection } from './types.js';
|
||||
|
||||
const MANAGED_START = '<!-- skillkit:managed:start -->';
|
||||
const MANAGED_END = '<!-- skillkit:managed:end -->';
|
||||
|
||||
export class AgentsMdParser {
|
||||
parse(content: string): AgentsMdSection[] {
|
||||
const sections: AgentsMdSection[] = [];
|
||||
const lines = content.split('\n');
|
||||
|
||||
let inManaged = false;
|
||||
let currentSection: { id: string; title: string; lines: string[]; managed: boolean } | null = null;
|
||||
|
||||
for (const line of lines) {
|
||||
if (line.trim() === MANAGED_START) {
|
||||
inManaged = true;
|
||||
continue;
|
||||
}
|
||||
|
||||
if (line.trim() === MANAGED_END) {
|
||||
if (currentSection) {
|
||||
sections.push({
|
||||
id: currentSection.id,
|
||||
title: currentSection.title,
|
||||
content: currentSection.lines.join('\n').trim(),
|
||||
managed: currentSection.managed,
|
||||
});
|
||||
currentSection = null;
|
||||
}
|
||||
inManaged = false;
|
||||
continue;
|
||||
}
|
||||
|
||||
const headingMatch = line.match(/^##\s+(.+)$/);
|
||||
if (headingMatch) {
|
||||
if (currentSection) {
|
||||
sections.push({
|
||||
id: currentSection.id,
|
||||
title: currentSection.title,
|
||||
content: currentSection.lines.join('\n').trim(),
|
||||
managed: currentSection.managed,
|
||||
});
|
||||
}
|
||||
const title = headingMatch[1];
|
||||
currentSection = {
|
||||
id: title.toLowerCase().replace(/[^a-z0-9]+/g, '-').replace(/^-+|-+$/g, ''),
|
||||
title,
|
||||
lines: [],
|
||||
managed: inManaged,
|
||||
};
|
||||
continue;
|
||||
}
|
||||
|
||||
if (currentSection) {
|
||||
currentSection.lines.push(line);
|
||||
}
|
||||
}
|
||||
|
||||
if (currentSection) {
|
||||
sections.push({
|
||||
id: currentSection.id,
|
||||
title: currentSection.title,
|
||||
content: currentSection.lines.join('\n').trim(),
|
||||
managed: currentSection.managed,
|
||||
});
|
||||
}
|
||||
|
||||
return sections;
|
||||
}
|
||||
|
||||
hasManagedSections(content: string): boolean {
|
||||
return content.includes(MANAGED_START) && content.includes(MANAGED_END);
|
||||
}
|
||||
|
||||
updateManagedSections(existing: string, newManaged: AgentsMdSection[]): string {
|
||||
if (!this.hasManagedSections(existing)) {
|
||||
return existing;
|
||||
}
|
||||
|
||||
const startIdx = existing.indexOf(MANAGED_START);
|
||||
const endIdx = existing.indexOf(MANAGED_END);
|
||||
if (startIdx >= endIdx) {
|
||||
return existing;
|
||||
}
|
||||
|
||||
const managedBlock = this.buildManagedBlock(newManaged);
|
||||
const before = existing.substring(0, startIdx);
|
||||
const after = existing.substring(endIdx + MANAGED_END.length);
|
||||
|
||||
return `${before}${managedBlock}${after}`;
|
||||
}
|
||||
|
||||
private buildManagedBlock(sections: AgentsMdSection[]): string {
|
||||
const lines: string[] = [MANAGED_START];
|
||||
for (const section of sections) {
|
||||
lines.push(`## ${section.title}`);
|
||||
lines.push(section.content);
|
||||
lines.push('');
|
||||
}
|
||||
lines.push(MANAGED_END);
|
||||
return lines.join('\n');
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,19 @@
|
||||
export interface AgentsMdConfig {
|
||||
projectPath: string;
|
||||
includeSkills?: boolean;
|
||||
includeBuildCommands?: boolean;
|
||||
includeCodeStyle?: boolean;
|
||||
}
|
||||
|
||||
export interface AgentsMdSection {
|
||||
id: string;
|
||||
title: string;
|
||||
content: string;
|
||||
managed: boolean;
|
||||
}
|
||||
|
||||
export interface AgentsMdResult {
|
||||
content: string;
|
||||
sections: AgentsMdSection[];
|
||||
path: string;
|
||||
}
|
||||
@@ -251,6 +251,18 @@ export const AGENT_DISCOVERY_PATHS: Record<AgentType, string[]> = {
|
||||
'qwen': ['.qwen/agents'],
|
||||
'vercel': ['.vercel/agents'],
|
||||
'zencoder': ['.zencoder/agents'],
|
||||
'devin': ['.devin/agents'],
|
||||
'aider': ['.aider/agents'],
|
||||
'sourcegraph-cody': ['.cody/agents'],
|
||||
'amazon-q': ['.amazonq/agents'],
|
||||
'augment-code': ['.augment/agents'],
|
||||
'replit-agent': ['.replit/agents'],
|
||||
'bolt': ['.bolt/agents'],
|
||||
'lovable': ['.lovable/agents'],
|
||||
'tabby': ['.tabby/agents'],
|
||||
'tabnine': ['.tabnine/agents'],
|
||||
'codegpt': ['.codegpt/agents'],
|
||||
'playcode-agent': ['.playcode/agents'],
|
||||
};
|
||||
|
||||
/**
|
||||
@@ -298,6 +310,18 @@ export const ALL_AGENT_DISCOVERY_PATHS = [
|
||||
'.windsurf/agents',
|
||||
'.windsurf/workflows',
|
||||
'.zencoder/agents',
|
||||
'.devin/agents',
|
||||
'.aider/agents',
|
||||
'.cody/agents',
|
||||
'.amazonq/agents',
|
||||
'.augment/agents',
|
||||
'.replit/agents',
|
||||
'.bolt/agents',
|
||||
'.lovable/agents',
|
||||
'.tabby/agents',
|
||||
'.tabnine/agents',
|
||||
'.codegpt/agents',
|
||||
'.playcode/agents',
|
||||
];
|
||||
|
||||
/**
|
||||
@@ -336,4 +360,16 @@ export const CUSTOM_AGENT_FORMAT_MAP: Record<AgentType, AgentFormatCategory> = {
|
||||
'qwen': 'claude-agent',
|
||||
'vercel': 'claude-agent',
|
||||
'zencoder': 'claude-agent',
|
||||
'devin': 'universal',
|
||||
'aider': 'universal',
|
||||
'sourcegraph-cody': 'universal',
|
||||
'amazon-q': 'universal',
|
||||
'augment-code': 'universal',
|
||||
'replit-agent': 'universal',
|
||||
'bolt': 'universal',
|
||||
'lovable': 'universal',
|
||||
'tabby': 'universal',
|
||||
'tabnine': 'universal',
|
||||
'codegpt': 'universal',
|
||||
'playcode-agent': 'universal',
|
||||
};
|
||||
|
||||
@@ -241,6 +241,90 @@ const AGENT_FORMATS: Record<AgentType, AgentCommandFormat> = {
|
||||
supportsSlashCommands: true,
|
||||
supportsCommandFiles: true,
|
||||
},
|
||||
devin: {
|
||||
agent: 'devin',
|
||||
extension: '.md',
|
||||
directory: '.devin/commands',
|
||||
supportsSlashCommands: false,
|
||||
supportsCommandFiles: true,
|
||||
},
|
||||
aider: {
|
||||
agent: 'aider',
|
||||
extension: '.md',
|
||||
directory: '.aider/commands',
|
||||
supportsSlashCommands: false,
|
||||
supportsCommandFiles: true,
|
||||
},
|
||||
'sourcegraph-cody': {
|
||||
agent: 'sourcegraph-cody',
|
||||
extension: '.md',
|
||||
directory: '.cody/commands',
|
||||
supportsSlashCommands: false,
|
||||
supportsCommandFiles: true,
|
||||
},
|
||||
'amazon-q': {
|
||||
agent: 'amazon-q',
|
||||
extension: '.md',
|
||||
directory: '.amazonq/commands',
|
||||
supportsSlashCommands: false,
|
||||
supportsCommandFiles: true,
|
||||
},
|
||||
'augment-code': {
|
||||
agent: 'augment-code',
|
||||
extension: '.md',
|
||||
directory: '.augment/commands',
|
||||
supportsSlashCommands: false,
|
||||
supportsCommandFiles: true,
|
||||
},
|
||||
'replit-agent': {
|
||||
agent: 'replit-agent',
|
||||
extension: '.md',
|
||||
directory: '.replit/commands',
|
||||
supportsSlashCommands: false,
|
||||
supportsCommandFiles: true,
|
||||
},
|
||||
bolt: {
|
||||
agent: 'bolt',
|
||||
extension: '.md',
|
||||
directory: '.bolt/commands',
|
||||
supportsSlashCommands: false,
|
||||
supportsCommandFiles: true,
|
||||
},
|
||||
lovable: {
|
||||
agent: 'lovable',
|
||||
extension: '.md',
|
||||
directory: '.lovable/commands',
|
||||
supportsSlashCommands: false,
|
||||
supportsCommandFiles: true,
|
||||
},
|
||||
tabby: {
|
||||
agent: 'tabby',
|
||||
extension: '.md',
|
||||
directory: '.tabby/commands',
|
||||
supportsSlashCommands: false,
|
||||
supportsCommandFiles: true,
|
||||
},
|
||||
tabnine: {
|
||||
agent: 'tabnine',
|
||||
extension: '.md',
|
||||
directory: '.tabnine/commands',
|
||||
supportsSlashCommands: false,
|
||||
supportsCommandFiles: true,
|
||||
},
|
||||
codegpt: {
|
||||
agent: 'codegpt',
|
||||
extension: '.md',
|
||||
directory: '.codegpt/commands',
|
||||
supportsSlashCommands: false,
|
||||
supportsCommandFiles: true,
|
||||
},
|
||||
'playcode-agent': {
|
||||
agent: 'playcode-agent',
|
||||
extension: '.md',
|
||||
directory: '.playcode/commands',
|
||||
supportsSlashCommands: false,
|
||||
supportsCommandFiles: true,
|
||||
},
|
||||
};
|
||||
|
||||
/**
|
||||
|
||||
@@ -120,3 +120,15 @@ export type { SkillReference, ParsedSkillContent } from './parser/index.js';
|
||||
|
||||
// Runtime Skill Injection
|
||||
export * from './runtime/index.js';
|
||||
|
||||
// Security Scanner
|
||||
export * from './scanner/index.js';
|
||||
|
||||
// Spec Validation
|
||||
export * from './validation/index.js';
|
||||
|
||||
// AGENTS.md generator
|
||||
export * from './agents-md/index.js';
|
||||
|
||||
// Save (Content Extraction & Skill Generation)
|
||||
export * from './save/index.js';
|
||||
|
||||
@@ -181,6 +181,18 @@ export class ObservationStore {
|
||||
return this.load().observations;
|
||||
}
|
||||
|
||||
static readAll(projectPath: string): Observation[] {
|
||||
const filePath = join(projectPath, '.skillkit', 'memory', 'observations.yaml');
|
||||
if (!existsSync(filePath)) return [];
|
||||
try {
|
||||
const content = readFileSync(filePath, 'utf-8');
|
||||
const data = parseYaml(content) as ObservationStoreData;
|
||||
return data?.observations ?? [];
|
||||
} catch {
|
||||
return [];
|
||||
}
|
||||
}
|
||||
|
||||
getByType(type: ObservationType): Observation[] {
|
||||
return this.load().observations.filter((o) => o.type === type);
|
||||
}
|
||||
|
||||
@@ -0,0 +1,307 @@
|
||||
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
|
||||
import { IssuePlanner, createIssuePlanner } from '../issue-planner.js';
|
||||
import type { GitHubIssue } from '../issue-planner.js';
|
||||
|
||||
vi.mock('node:child_process', () => ({
|
||||
execFileSync: vi.fn(),
|
||||
}));
|
||||
|
||||
import { execFileSync } from 'node:child_process';
|
||||
const mockExecFileSync = vi.mocked(execFileSync);
|
||||
|
||||
describe('IssuePlanner', () => {
|
||||
let planner: IssuePlanner;
|
||||
|
||||
beforeEach(() => {
|
||||
planner = new IssuePlanner();
|
||||
vi.clearAllMocks();
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
vi.restoreAllMocks();
|
||||
});
|
||||
|
||||
describe('parseIssueRef', () => {
|
||||
it('should parse short ref #123', () => {
|
||||
const result = planner.parseIssueRef('#123');
|
||||
expect(result).toEqual({ number: 123 });
|
||||
});
|
||||
|
||||
it('should parse bare number 123', () => {
|
||||
const result = planner.parseIssueRef('123');
|
||||
expect(result).toEqual({ number: 123 });
|
||||
});
|
||||
|
||||
it('should parse owner/repo#123', () => {
|
||||
const result = planner.parseIssueRef('rohitg00/skillkit#42');
|
||||
expect(result).toEqual({
|
||||
owner: 'rohitg00',
|
||||
repo: 'skillkit',
|
||||
number: 42,
|
||||
});
|
||||
});
|
||||
|
||||
it('should parse full GitHub URL', () => {
|
||||
const result = planner.parseIssueRef(
|
||||
'https://github.com/rohitg00/skillkit/issues/42'
|
||||
);
|
||||
expect(result).toEqual({
|
||||
owner: 'rohitg00',
|
||||
repo: 'skillkit',
|
||||
number: 42,
|
||||
});
|
||||
});
|
||||
|
||||
it('should throw on invalid ref', () => {
|
||||
expect(() => planner.parseIssueRef('invalid')).toThrow(
|
||||
'Invalid issue reference'
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe('extractTasksFromBody', () => {
|
||||
it('should extract unchecked tasks', () => {
|
||||
const body = '- [ ] Add auth\n- [ ] Add tests\n';
|
||||
const tasks = planner.extractTasksFromBody(body);
|
||||
expect(tasks).toEqual([
|
||||
{ name: 'Add auth', checked: false },
|
||||
{ name: 'Add tests', checked: false },
|
||||
]);
|
||||
});
|
||||
|
||||
it('should extract checked tasks', () => {
|
||||
const body = '- [x] Setup project\n- [X] Add config\n';
|
||||
const tasks = planner.extractTasksFromBody(body);
|
||||
expect(tasks).toEqual([
|
||||
{ name: 'Setup project', checked: true },
|
||||
{ name: 'Add config', checked: true },
|
||||
]);
|
||||
});
|
||||
|
||||
it('should handle mixed tasks', () => {
|
||||
const body = '- [x] Done task\n- [ ] Pending task\n';
|
||||
const tasks = planner.extractTasksFromBody(body);
|
||||
expect(tasks).toHaveLength(2);
|
||||
expect(tasks[0].checked).toBe(true);
|
||||
expect(tasks[1].checked).toBe(false);
|
||||
});
|
||||
|
||||
it('should handle empty body', () => {
|
||||
expect(planner.extractTasksFromBody('')).toEqual([]);
|
||||
});
|
||||
|
||||
it('should ignore non-checkbox lines', () => {
|
||||
const body = '- Regular list item\n- [ ] Checkbox item\n';
|
||||
const tasks = planner.extractTasksFromBody(body);
|
||||
expect(tasks).toHaveLength(1);
|
||||
expect(tasks[0].name).toBe('Checkbox item');
|
||||
});
|
||||
|
||||
it('should handle indented checkboxes', () => {
|
||||
const body = ' - [ ] Indented task\n';
|
||||
const tasks = planner.extractTasksFromBody(body);
|
||||
expect(tasks).toHaveLength(1);
|
||||
expect(tasks[0].name).toBe('Indented task');
|
||||
});
|
||||
});
|
||||
|
||||
describe('extractFileMentions', () => {
|
||||
it('should extract file paths in backticks', () => {
|
||||
const text = 'Update `src/foo.ts` and `lib/bar.js`';
|
||||
const files = planner.extractFileMentions(text);
|
||||
expect(files).toContain('src/foo.ts');
|
||||
expect(files).toContain('lib/bar.js');
|
||||
});
|
||||
|
||||
it('should deduplicate file mentions', () => {
|
||||
const text = 'See `src/foo.ts` and also `src/foo.ts`';
|
||||
const files = planner.extractFileMentions(text);
|
||||
expect(files).toHaveLength(1);
|
||||
});
|
||||
|
||||
it('should handle text with no file mentions', () => {
|
||||
const text = 'No files here';
|
||||
expect(planner.extractFileMentions(text)).toEqual([]);
|
||||
});
|
||||
|
||||
it('should extract files with extensions', () => {
|
||||
const text = 'Check `config.json` and `README.md`';
|
||||
const files = planner.extractFileMentions(text);
|
||||
expect(files).toContain('config.json');
|
||||
expect(files).toContain('README.md');
|
||||
});
|
||||
});
|
||||
|
||||
describe('inferLabelsToTags', () => {
|
||||
it('should map known labels', () => {
|
||||
expect(planner.inferLabelsToTags(['bug'])).toEqual(['fix']);
|
||||
expect(planner.inferLabelsToTags(['enhancement'])).toEqual(['feature']);
|
||||
expect(planner.inferLabelsToTags(['documentation'])).toEqual(['docs']);
|
||||
});
|
||||
|
||||
it('should handle case insensitivity', () => {
|
||||
expect(planner.inferLabelsToTags(['Bug'])).toEqual(['fix']);
|
||||
expect(planner.inferLabelsToTags(['ENHANCEMENT'])).toEqual(['feature']);
|
||||
});
|
||||
|
||||
it('should skip unknown labels', () => {
|
||||
expect(planner.inferLabelsToTags(['unknown-label'])).toEqual([]);
|
||||
});
|
||||
|
||||
it('should deduplicate tags', () => {
|
||||
expect(planner.inferLabelsToTags(['bug', 'fix'])).toEqual(['fix']);
|
||||
});
|
||||
});
|
||||
|
||||
describe('fetchIssue', () => {
|
||||
it('should fetch issue from current repo', () => {
|
||||
const ghResponse = JSON.stringify({
|
||||
number: 42,
|
||||
title: 'Add dark mode',
|
||||
body: '- [ ] Add theme provider\n- [ ] Update styles',
|
||||
labels: [{ name: 'enhancement' }],
|
||||
assignees: [{ login: 'user1' }],
|
||||
url: 'https://github.com/test/repo/issues/42',
|
||||
state: 'OPEN',
|
||||
});
|
||||
|
||||
mockExecFileSync.mockReturnValue(ghResponse as any);
|
||||
|
||||
const issue = planner.fetchIssue('#42');
|
||||
|
||||
expect(mockExecFileSync).toHaveBeenCalledWith(
|
||||
'gh',
|
||||
[
|
||||
'issue',
|
||||
'view',
|
||||
'42',
|
||||
'--json',
|
||||
'number,title,body,labels,assignees,url,state',
|
||||
],
|
||||
expect.objectContaining({ encoding: 'utf-8' })
|
||||
);
|
||||
|
||||
expect(issue.number).toBe(42);
|
||||
expect(issue.title).toBe('Add dark mode');
|
||||
expect(issue.labels).toEqual(['enhancement']);
|
||||
expect(issue.assignees).toEqual(['user1']);
|
||||
});
|
||||
|
||||
it('should fetch issue from specific repo', () => {
|
||||
const ghResponse = JSON.stringify({
|
||||
number: 10,
|
||||
title: 'Fix bug',
|
||||
body: '',
|
||||
labels: [],
|
||||
assignees: [],
|
||||
url: 'https://github.com/owner/repo/issues/10',
|
||||
state: 'OPEN',
|
||||
});
|
||||
|
||||
mockExecFileSync.mockReturnValue(ghResponse as any);
|
||||
|
||||
planner.fetchIssue('owner/repo#10');
|
||||
|
||||
expect(mockExecFileSync).toHaveBeenCalledWith(
|
||||
'gh',
|
||||
[
|
||||
'issue',
|
||||
'view',
|
||||
'10',
|
||||
'--json',
|
||||
'number,title,body,labels,assignees,url,state',
|
||||
'--repo',
|
||||
'owner/repo',
|
||||
],
|
||||
expect.objectContaining({ encoding: 'utf-8' })
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe('generatePlan', () => {
|
||||
const baseIssue: GitHubIssue = {
|
||||
number: 42,
|
||||
title: 'Add dark mode support',
|
||||
body: 'We need dark mode.\n\n- [ ] Add theme context provider\n- [ ] Update component styles\n- [x] Research themes',
|
||||
labels: ['enhancement'],
|
||||
assignees: ['user1'],
|
||||
url: 'https://github.com/test/repo/issues/42',
|
||||
state: 'OPEN',
|
||||
};
|
||||
|
||||
it('should generate plan from issue with checklist', () => {
|
||||
const plan = planner.generatePlan(baseIssue);
|
||||
|
||||
expect(plan.name).toBe('Issue #42: Add dark mode support');
|
||||
expect(plan.goal).toBe('We need dark mode.');
|
||||
expect(plan.tasks).toHaveLength(3);
|
||||
expect(plan.tasks[0].name).toBe('Add theme context provider');
|
||||
expect(plan.tasks[1].name).toBe('Update component styles');
|
||||
expect(plan.tasks[2].name).toBe('Research themes');
|
||||
expect(plan.tasks[2].status).toBe('completed');
|
||||
});
|
||||
|
||||
it('should set metadata correctly', () => {
|
||||
const plan = planner.generatePlan(baseIssue, { agent: 'cursor' });
|
||||
|
||||
expect(plan.metadata).toBeDefined();
|
||||
expect(plan.metadata!.issueNumber).toBe(42);
|
||||
expect(plan.metadata!.issueUrl).toBe(
|
||||
'https://github.com/test/repo/issues/42'
|
||||
);
|
||||
expect(plan.metadata!.agent).toBe('cursor');
|
||||
expect(plan.metadata!.generatedAt).toBeDefined();
|
||||
});
|
||||
|
||||
it('should infer tags from labels', () => {
|
||||
const plan = planner.generatePlan(baseIssue);
|
||||
expect(plan.tags).toContain('feature');
|
||||
});
|
||||
|
||||
it('should create single task when no checklist', () => {
|
||||
const issue: GitHubIssue = {
|
||||
...baseIssue,
|
||||
body: 'Just a description with no checkboxes.\n\nUpdate `src/theme.ts`.',
|
||||
};
|
||||
|
||||
const plan = planner.generatePlan(issue);
|
||||
expect(plan.tasks).toHaveLength(1);
|
||||
expect(plan.tasks[0].name).toBe('Add dark mode support');
|
||||
expect(plan.tasks[0].files.modify).toContain('src/theme.ts');
|
||||
});
|
||||
|
||||
it('should extract file mentions into task files', () => {
|
||||
const issue: GitHubIssue = {
|
||||
...baseIssue,
|
||||
body: '- [ ] Update `src/components/App.tsx` for theming',
|
||||
};
|
||||
|
||||
const plan = planner.generatePlan(issue);
|
||||
expect(plan.tasks[0].files.modify).toContain(
|
||||
'src/components/App.tsx'
|
||||
);
|
||||
});
|
||||
|
||||
it('should respect includeTests option', () => {
|
||||
const plan = planner.generatePlan(baseIssue, { includeTests: false });
|
||||
for (const task of plan.tasks) {
|
||||
const hasTestStep = task.steps.some((s) => s.type === 'test');
|
||||
expect(hasTestStep).toBe(false);
|
||||
}
|
||||
});
|
||||
|
||||
it('should use custom tech stack', () => {
|
||||
const plan = planner.generatePlan(baseIssue, {
|
||||
techStack: ['React', 'TypeScript'],
|
||||
});
|
||||
expect(plan.techStack).toEqual(['React', 'TypeScript']);
|
||||
});
|
||||
});
|
||||
|
||||
describe('createIssuePlanner', () => {
|
||||
it('should create an IssuePlanner instance', () => {
|
||||
const p = createIssuePlanner();
|
||||
expect(p).toBeInstanceOf(IssuePlanner);
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -27,6 +27,10 @@ export type { TaskTemplate } from './generator.js';
|
||||
export { PlanExecutor, createPlanExecutor, dryRunExecutor, shellExecutor } from './executor.js';
|
||||
export type { StepExecutor } from './executor.js';
|
||||
|
||||
// Issue Planner
|
||||
export { IssuePlanner, createIssuePlanner } from './issue-planner.js';
|
||||
export type { GitHubIssue, IssuePlanOptions } from './issue-planner.js';
|
||||
|
||||
// Types
|
||||
export type {
|
||||
// Core types
|
||||
@@ -53,4 +57,7 @@ export type {
|
||||
// Events
|
||||
PlanEvent,
|
||||
PlanEventListener,
|
||||
|
||||
// Issue Plan
|
||||
IssuePlanMetadata,
|
||||
} from './types.js';
|
||||
|
||||
@@ -0,0 +1,252 @@
|
||||
import { execFileSync } from 'node:child_process';
|
||||
import { PlanGenerator } from './generator.js';
|
||||
import type { StructuredPlan, PlanTaskFiles, IssuePlanMetadata } from './types.js';
|
||||
|
||||
export type { IssuePlanMetadata };
|
||||
|
||||
export interface GitHubIssue {
|
||||
number: number;
|
||||
title: string;
|
||||
body: string;
|
||||
labels: string[];
|
||||
assignees: string[];
|
||||
url: string;
|
||||
state: string;
|
||||
}
|
||||
|
||||
export interface IssuePlanOptions {
|
||||
agent?: string;
|
||||
techStack?: string[];
|
||||
outputPath?: string;
|
||||
includeTests?: boolean;
|
||||
}
|
||||
|
||||
interface ParsedRef {
|
||||
owner?: string;
|
||||
repo?: string;
|
||||
number: number;
|
||||
}
|
||||
|
||||
interface ExtractedTask {
|
||||
name: string;
|
||||
checked: boolean;
|
||||
}
|
||||
|
||||
const LABEL_TAG_MAP: Record<string, string> = {
|
||||
bug: 'fix',
|
||||
fix: 'fix',
|
||||
enhancement: 'feature',
|
||||
feature: 'feature',
|
||||
documentation: 'docs',
|
||||
docs: 'docs',
|
||||
refactor: 'refactor',
|
||||
refactoring: 'refactor',
|
||||
test: 'test',
|
||||
testing: 'test',
|
||||
security: 'security',
|
||||
performance: 'performance',
|
||||
'good first issue': 'beginner',
|
||||
chore: 'chore',
|
||||
maintenance: 'chore',
|
||||
};
|
||||
|
||||
const FILE_PATH_REGEX = /`([a-zA-Z0-9_./\-]+\.[a-zA-Z0-9]+)`/g;
|
||||
|
||||
export class IssuePlanner {
|
||||
|
||||
parseIssueRef(ref: string): ParsedRef {
|
||||
const urlMatch = ref.match(
|
||||
/github\.com\/([^/]+)\/([^/]+)\/issues\/(\d+)/
|
||||
);
|
||||
if (urlMatch) {
|
||||
return {
|
||||
owner: urlMatch[1],
|
||||
repo: urlMatch[2],
|
||||
number: parseInt(urlMatch[3], 10),
|
||||
};
|
||||
}
|
||||
|
||||
const fullMatch = ref.match(/^([^/]+)\/([^#]+)#(\d+)$/);
|
||||
if (fullMatch) {
|
||||
return {
|
||||
owner: fullMatch[1],
|
||||
repo: fullMatch[2],
|
||||
number: parseInt(fullMatch[3], 10),
|
||||
};
|
||||
}
|
||||
|
||||
const shortMatch = ref.match(/^#?(\d+)$/);
|
||||
if (shortMatch) {
|
||||
return { number: parseInt(shortMatch[1], 10) };
|
||||
}
|
||||
|
||||
throw new Error(
|
||||
`Invalid issue reference: "${ref}". Use #123, owner/repo#123, or a GitHub URL.`
|
||||
);
|
||||
}
|
||||
|
||||
fetchIssue(ref: string): GitHubIssue {
|
||||
const parsed = this.parseIssueRef(ref);
|
||||
const args = [
|
||||
'issue',
|
||||
'view',
|
||||
String(parsed.number),
|
||||
'--json',
|
||||
'number,title,body,labels,assignees,url,state',
|
||||
];
|
||||
|
||||
if (parsed.owner && parsed.repo) {
|
||||
args.push('--repo', `${parsed.owner}/${parsed.repo}`);
|
||||
}
|
||||
|
||||
const result = execFileSync('gh', args, {
|
||||
encoding: 'utf-8',
|
||||
timeout: 15_000,
|
||||
});
|
||||
|
||||
let data: {
|
||||
number: number;
|
||||
title: string;
|
||||
body?: string;
|
||||
labels?: Array<{ name: string }>;
|
||||
assignees?: Array<{ login: string }>;
|
||||
url: string;
|
||||
state: string;
|
||||
};
|
||||
try {
|
||||
data = JSON.parse(result);
|
||||
} catch {
|
||||
throw new Error(`Failed to parse GitHub CLI response for issue ${parsed.number}`);
|
||||
}
|
||||
return {
|
||||
number: data.number,
|
||||
title: data.title,
|
||||
body: data.body || '',
|
||||
labels: (data.labels || []).map((l) => l.name),
|
||||
assignees: (data.assignees || []).map((a) => a.login),
|
||||
url: data.url,
|
||||
state: data.state,
|
||||
};
|
||||
}
|
||||
|
||||
extractTasksFromBody(body: string): ExtractedTask[] {
|
||||
const tasks: ExtractedTask[] = [];
|
||||
const lines = body.split('\n');
|
||||
for (const line of lines) {
|
||||
const match = line.match(/^[\s]*-\s*\[([ xX])\]\s+(.+)$/);
|
||||
if (match) {
|
||||
tasks.push({
|
||||
name: match[2].trim(),
|
||||
checked: match[1] !== ' ',
|
||||
});
|
||||
}
|
||||
}
|
||||
return tasks;
|
||||
}
|
||||
|
||||
extractFileMentions(text: string): string[] {
|
||||
const files = new Set<string>();
|
||||
let match: RegExpExecArray | null;
|
||||
const regex = new RegExp(FILE_PATH_REGEX.source, 'g');
|
||||
while ((match = regex.exec(text)) !== null) {
|
||||
const path = match[1];
|
||||
if (path.includes('/') || path.includes('.')) {
|
||||
files.add(path);
|
||||
}
|
||||
}
|
||||
return [...files];
|
||||
}
|
||||
|
||||
inferLabelsToTags(labels: string[]): string[] {
|
||||
const tags: string[] = [];
|
||||
for (const label of labels) {
|
||||
const tag = LABEL_TAG_MAP[label.toLowerCase()];
|
||||
if (tag && !tags.includes(tag)) {
|
||||
tags.push(tag);
|
||||
}
|
||||
}
|
||||
return tags;
|
||||
}
|
||||
|
||||
generatePlan(
|
||||
issue: GitHubIssue,
|
||||
options?: IssuePlanOptions
|
||||
): StructuredPlan {
|
||||
const agent = options?.agent || 'claude-code';
|
||||
const includeTests = options?.includeTests !== false;
|
||||
|
||||
const bodyFirstParagraph =
|
||||
issue.body.split('\n\n')[0]?.trim() || issue.title;
|
||||
|
||||
const generator = new PlanGenerator({
|
||||
includeTests,
|
||||
includeCommits: true,
|
||||
techStack: options?.techStack,
|
||||
});
|
||||
|
||||
const plan = generator.createPlan(
|
||||
`Issue #${issue.number}: ${issue.title}`,
|
||||
bodyFirstParagraph
|
||||
);
|
||||
|
||||
plan.tags = this.inferLabelsToTags(issue.labels);
|
||||
|
||||
const checklist = this.extractTasksFromBody(issue.body);
|
||||
const allFileMentions = this.extractFileMentions(issue.body);
|
||||
|
||||
if (checklist.length > 0) {
|
||||
for (const item of checklist) {
|
||||
const taskFiles = this.extractFileMentions(item.name);
|
||||
const files: PlanTaskFiles = {};
|
||||
if (taskFiles.length > 0) {
|
||||
files.modify = taskFiles;
|
||||
}
|
||||
|
||||
const task = generator.addTask(plan, item.name, {
|
||||
files,
|
||||
tags: item.checked ? ['done'] : undefined,
|
||||
steps: [
|
||||
{ type: 'implement', description: item.name },
|
||||
...(includeTests
|
||||
? [{ type: 'test' as const, description: `Write tests for ${item.name}` }]
|
||||
: []),
|
||||
],
|
||||
});
|
||||
|
||||
if (item.checked) {
|
||||
task.status = 'completed';
|
||||
}
|
||||
}
|
||||
} else {
|
||||
const files: PlanTaskFiles = {};
|
||||
if (allFileMentions.length > 0) {
|
||||
files.modify = allFileMentions;
|
||||
}
|
||||
|
||||
generator.addTask(plan, issue.title, {
|
||||
description: bodyFirstParagraph,
|
||||
files,
|
||||
steps: [
|
||||
{ type: 'implement', description: issue.title },
|
||||
...(includeTests
|
||||
? [{ type: 'test' as const, description: `Write tests for ${issue.title}` }]
|
||||
: []),
|
||||
],
|
||||
});
|
||||
}
|
||||
|
||||
plan.metadata = {
|
||||
issueNumber: issue.number,
|
||||
issueUrl: issue.url,
|
||||
issueLabels: issue.labels,
|
||||
agent,
|
||||
generatedAt: new Date().toISOString(),
|
||||
} satisfies IssuePlanMetadata;
|
||||
|
||||
return plan;
|
||||
}
|
||||
}
|
||||
|
||||
export function createIssuePlanner(): IssuePlanner {
|
||||
return new IssuePlanner();
|
||||
}
|
||||
@@ -270,3 +270,11 @@ export type PlanEventListener = (
|
||||
task?: PlanTask,
|
||||
result?: PlanTaskResult
|
||||
) => void | Promise<void>;
|
||||
|
||||
export interface IssuePlanMetadata {
|
||||
issueNumber: number;
|
||||
issueUrl: string;
|
||||
issueLabels: string[];
|
||||
agent: string;
|
||||
generatedAt: string;
|
||||
}
|
||||
|
||||
@@ -6,6 +6,18 @@ import type { GitProviderAdapter, CloneOptions } from './base.js';
|
||||
import { isGitUrl, isLocalPath } from './base.js';
|
||||
import type { GitProvider, CloneResult } from '../types.js';
|
||||
|
||||
function skillNameFromUrl(url: string): string {
|
||||
try {
|
||||
const parsed = new URL(url);
|
||||
const segments = parsed.pathname.split('/').filter(Boolean);
|
||||
return segments[segments.length - 1] || parsed.hostname.split('.')[0] || 'default';
|
||||
} catch {
|
||||
return basename(url) || 'default';
|
||||
}
|
||||
}
|
||||
|
||||
const FRONTMATTER_REGEX = /^---\s*\n[\s\S]*?name:\s*.+/;
|
||||
|
||||
function sanitizeSkillName(name: string): string | null {
|
||||
if (!name || typeof name !== 'string') return null;
|
||||
const base = basename(name);
|
||||
@@ -29,6 +41,12 @@ export interface WellKnownIndex {
|
||||
skills: WellKnownSkill[];
|
||||
}
|
||||
|
||||
const MINTLIFY_PATHS = [
|
||||
'/.well-known/skills/default/skill.md',
|
||||
'/skill.md',
|
||||
'/.well-known/skill.md',
|
||||
];
|
||||
|
||||
export class WellKnownProvider implements GitProviderAdapter {
|
||||
readonly type: GitProvider = 'wellknown';
|
||||
readonly name = 'Well-Known';
|
||||
@@ -66,6 +84,57 @@ export class WellKnownProvider implements GitProviderAdapter {
|
||||
return '';
|
||||
}
|
||||
|
||||
async discoverFromUrl(url: string): Promise<CloneResult> {
|
||||
const baseUrl = url.replace(/\/$/, '');
|
||||
const tempDir = join(tmpdir(), `skillkit-wellknown-${randomUUID()}`);
|
||||
|
||||
try {
|
||||
mkdirSync(tempDir, { recursive: true });
|
||||
|
||||
for (const mintlifyPath of MINTLIFY_PATHS) {
|
||||
const fullUrl = `${baseUrl}${mintlifyPath}`;
|
||||
try {
|
||||
const response = await fetch(fullUrl);
|
||||
if (response.ok) {
|
||||
const content = await response.text();
|
||||
if (FRONTMATTER_REGEX.test(content)) {
|
||||
const skillName = skillNameFromUrl(baseUrl);
|
||||
const safeName = sanitizeSkillName(skillName) ?? 'default';
|
||||
const skillDir = join(tempDir, safeName);
|
||||
mkdirSync(skillDir, { recursive: true });
|
||||
writeFileSync(join(skillDir, 'SKILL.md'), content);
|
||||
|
||||
return {
|
||||
success: true,
|
||||
path: tempDir,
|
||||
tempRoot: tempDir,
|
||||
skills: [safeName],
|
||||
discoveredSkills: [{ name: safeName, dirName: safeName, path: skillDir }],
|
||||
};
|
||||
}
|
||||
}
|
||||
} catch {
|
||||
continue;
|
||||
}
|
||||
}
|
||||
|
||||
const indexResult = await this.clone(baseUrl, '', {});
|
||||
if (indexResult.success) {
|
||||
rmSync(tempDir, { recursive: true, force: true });
|
||||
return indexResult;
|
||||
}
|
||||
|
||||
rmSync(tempDir, { recursive: true, force: true });
|
||||
return { success: false, error: 'No well-known skills found' };
|
||||
} catch (error) {
|
||||
if (existsSync(tempDir)) {
|
||||
rmSync(tempDir, { recursive: true, force: true });
|
||||
}
|
||||
const message = error instanceof Error ? error.message : String(error);
|
||||
return { success: false, error: `Failed to discover skills: ${message}` };
|
||||
}
|
||||
}
|
||||
|
||||
async clone(source: string, _targetDir: string, _options: CloneOptions = {}): Promise<CloneResult> {
|
||||
const tempDir = join(tmpdir(), `skillkit-wellknown-${randomUUID()}`);
|
||||
|
||||
@@ -95,6 +164,34 @@ export class WellKnownProvider implements GitProviderAdapter {
|
||||
}
|
||||
|
||||
if (!index || !index.skills || index.skills.length === 0) {
|
||||
for (const mintlifyPath of MINTLIFY_PATHS) {
|
||||
const fullUrl = `${baseUrl}${mintlifyPath}`;
|
||||
try {
|
||||
const response = await fetch(fullUrl);
|
||||
if (response.ok) {
|
||||
const content = await response.text();
|
||||
if (FRONTMATTER_REGEX.test(content)) {
|
||||
const skillName = skillNameFromUrl(baseUrl);
|
||||
const safeName = sanitizeSkillName(skillName) ?? 'default';
|
||||
const skillDir = join(tempDir, safeName);
|
||||
mkdirSync(skillDir, { recursive: true });
|
||||
writeFileSync(join(skillDir, 'SKILL.md'), content);
|
||||
|
||||
return {
|
||||
success: true,
|
||||
path: tempDir,
|
||||
tempRoot: tempDir,
|
||||
skills: [safeName],
|
||||
discoveredSkills: [{ name: safeName, dirName: safeName, path: skillDir }],
|
||||
};
|
||||
}
|
||||
}
|
||||
} catch {
|
||||
continue;
|
||||
}
|
||||
}
|
||||
|
||||
rmSync(tempDir, { recursive: true, force: true });
|
||||
return {
|
||||
success: false,
|
||||
error: `No skills found at ${baseUrl}/.well-known/skills/index.json`,
|
||||
|
||||
@@ -559,10 +559,39 @@ export function evaluateSkillFile(filePath: string): QualityScore | null {
|
||||
}
|
||||
}
|
||||
|
||||
function checkNameDirectoryMatch(content: string, dirPath: string): string | null {
|
||||
const frontmatter = extractFrontmatter(content);
|
||||
if (!frontmatter || typeof frontmatter.name !== 'string') return null;
|
||||
const dirName = basename(dirPath);
|
||||
if (frontmatter.name !== dirName) {
|
||||
return `Skill name "${frontmatter.name}" does not match directory "${dirName}"`;
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
function checkTokenBudget(content: string): string | null {
|
||||
const normalizedContent = content.replace(/\r\n/g, '\n').replace(/\r/g, '\n');
|
||||
const fmMatch = normalizedContent.match(/^---\s*\n[\s\S]*?\n---\s*\n?/);
|
||||
const body = fmMatch ? normalizedContent.slice(fmMatch[0].length) : normalizedContent;
|
||||
const bodyLines = body.split('\n').length;
|
||||
if (bodyLines > 500) {
|
||||
return `Body is ${bodyLines} lines (exceeds 500). Consider moving content to references/ directory`;
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
export function evaluateSkillDirectory(dirPath: string): QualityScore | null {
|
||||
const skillMdPath = join(dirPath, 'SKILL.md');
|
||||
if (existsSync(skillMdPath)) {
|
||||
return evaluateSkillFile(skillMdPath);
|
||||
const result = evaluateSkillFile(skillMdPath);
|
||||
if (result) {
|
||||
const content = readFileSync(skillMdPath, 'utf-8');
|
||||
const nameWarning = checkNameDirectoryMatch(content, dirPath);
|
||||
if (nameWarning) result.warnings.push(nameWarning);
|
||||
const budgetWarning = checkTokenBudget(content);
|
||||
if (budgetWarning) result.warnings.push(budgetWarning);
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
const mdcFiles = ['index.mdc', `${basename(dirPath)}.mdc`];
|
||||
|
||||
@@ -0,0 +1,196 @@
|
||||
import { existsSync, readFileSync } from 'node:fs';
|
||||
import { basename, extname } from 'node:path';
|
||||
import TurndownService from 'turndown';
|
||||
import type { ExtractedContent, ExtractionOptions } from './types.js';
|
||||
|
||||
const LANGUAGE_MAP: Record<string, string> = {
|
||||
'.ts': 'typescript',
|
||||
'.tsx': 'typescript',
|
||||
'.js': 'javascript',
|
||||
'.jsx': 'javascript',
|
||||
'.py': 'python',
|
||||
'.rb': 'ruby',
|
||||
'.go': 'go',
|
||||
'.rs': 'rust',
|
||||
'.java': 'java',
|
||||
'.kt': 'kotlin',
|
||||
'.swift': 'swift',
|
||||
'.c': 'c',
|
||||
'.cpp': 'cpp',
|
||||
'.cs': 'csharp',
|
||||
'.php': 'php',
|
||||
'.sh': 'shell',
|
||||
'.bash': 'shell',
|
||||
'.zsh': 'shell',
|
||||
'.yml': 'yaml',
|
||||
'.yaml': 'yaml',
|
||||
'.json': 'json',
|
||||
'.toml': 'toml',
|
||||
'.md': 'markdown',
|
||||
'.mdx': 'markdown',
|
||||
'.html': 'html',
|
||||
'.css': 'css',
|
||||
'.scss': 'scss',
|
||||
'.sql': 'sql',
|
||||
'.r': 'r',
|
||||
'.lua': 'lua',
|
||||
'.dart': 'dart',
|
||||
'.ex': 'elixir',
|
||||
'.exs': 'elixir',
|
||||
'.zig': 'zig',
|
||||
'.nim': 'nim',
|
||||
'.vue': 'vue',
|
||||
'.svelte': 'svelte',
|
||||
};
|
||||
|
||||
const GITHUB_URL_PATTERN = /^https?:\/\/github\.com\/([^/]+)\/([^/]+)\/blob\/([^/]+)\/(.+)$/;
|
||||
const GITHUB_RAW_PATTERN = /^https?:\/\/raw\.githubusercontent\.com\//;
|
||||
const FETCH_TIMEOUT = 30_000;
|
||||
|
||||
export class ContentExtractor {
|
||||
private turndown: TurndownService;
|
||||
|
||||
constructor() {
|
||||
this.turndown = new TurndownService({
|
||||
headingStyle: 'atx',
|
||||
codeBlockStyle: 'fenced',
|
||||
});
|
||||
}
|
||||
|
||||
async extractFromUrl(url: string, options?: ExtractionOptions): Promise<ExtractedContent> {
|
||||
if (this.isGitHubUrl(url)) {
|
||||
return this.fetchGitHubContent(url, options);
|
||||
}
|
||||
|
||||
const response = await fetch(url, { signal: AbortSignal.timeout(FETCH_TIMEOUT) });
|
||||
if (!response.ok) {
|
||||
throw new Error(`Failed to fetch ${url}: ${response.status} ${response.statusText}`);
|
||||
}
|
||||
|
||||
const contentType = response.headers.get('content-type') ?? '';
|
||||
const body = await response.text();
|
||||
|
||||
if (contentType.includes('text/html')) {
|
||||
const { title, content } = this.htmlToMarkdown(body, url);
|
||||
const finalContent = options?.maxLength ? content.slice(0, options.maxLength) : content;
|
||||
|
||||
return {
|
||||
title: options?.preferredTitle ?? title,
|
||||
content: finalContent,
|
||||
sourceUrl: url,
|
||||
tags: [],
|
||||
extractedAt: new Date().toISOString(),
|
||||
contentType: 'webpage',
|
||||
metadata: { url },
|
||||
};
|
||||
}
|
||||
|
||||
const title = options?.preferredTitle ?? new URL(url).pathname.split('/').pop() ?? 'Untitled';
|
||||
const finalContent = options?.maxLength ? body.slice(0, options.maxLength) : body;
|
||||
|
||||
return {
|
||||
title,
|
||||
content: finalContent,
|
||||
sourceUrl: url,
|
||||
tags: [],
|
||||
extractedAt: new Date().toISOString(),
|
||||
contentType: 'text',
|
||||
metadata: { url },
|
||||
};
|
||||
}
|
||||
|
||||
extractFromText(text: string, options?: ExtractionOptions): ExtractedContent {
|
||||
const firstLine = text.split('\n')[0]?.trim() ?? '';
|
||||
const title = options?.preferredTitle ?? (firstLine.length > 0 && firstLine.length <= 100 ? firstLine : 'Untitled');
|
||||
const content = options?.maxLength ? text.slice(0, options.maxLength) : text;
|
||||
|
||||
return {
|
||||
title,
|
||||
content,
|
||||
tags: [],
|
||||
extractedAt: new Date().toISOString(),
|
||||
contentType: 'text',
|
||||
metadata: {},
|
||||
};
|
||||
}
|
||||
|
||||
extractFromFile(filePath: string, options?: ExtractionOptions): ExtractedContent {
|
||||
if (!existsSync(filePath)) {
|
||||
throw new Error(`File not found: ${filePath}`);
|
||||
}
|
||||
|
||||
const raw = readFileSync(filePath, 'utf-8');
|
||||
const name = basename(filePath);
|
||||
const language = this.detectLanguage(name);
|
||||
const isCode = language !== undefined && language !== 'markdown';
|
||||
const title = options?.preferredTitle ?? name;
|
||||
const content = options?.maxLength ? raw.slice(0, options.maxLength) : raw;
|
||||
|
||||
return {
|
||||
title,
|
||||
content: isCode ? `\`\`\`${language}\n${content}\n\`\`\`` : content,
|
||||
sourcePath: filePath,
|
||||
tags: language ? [language] : [],
|
||||
extractedAt: new Date().toISOString(),
|
||||
contentType: isCode ? 'code' : 'file',
|
||||
language,
|
||||
metadata: { filename: name },
|
||||
};
|
||||
}
|
||||
|
||||
private isGitHubUrl(url: string): boolean {
|
||||
return GITHUB_URL_PATTERN.test(url) || GITHUB_RAW_PATTERN.test(url);
|
||||
}
|
||||
|
||||
private async fetchGitHubContent(url: string, options?: ExtractionOptions): Promise<ExtractedContent> {
|
||||
let rawUrl = url;
|
||||
const match = url.match(GITHUB_URL_PATTERN);
|
||||
if (match) {
|
||||
const [, owner, repo, branch, path] = match;
|
||||
rawUrl = `https://raw.githubusercontent.com/${owner}/${repo}/${branch}/${path}`;
|
||||
}
|
||||
|
||||
const response = await fetch(rawUrl, { signal: AbortSignal.timeout(FETCH_TIMEOUT) });
|
||||
if (!response.ok) {
|
||||
throw new Error(`Failed to fetch GitHub content: ${response.status} ${response.statusText}`);
|
||||
}
|
||||
|
||||
const body = await response.text();
|
||||
const filename = rawUrl.split('/').pop() ?? 'file';
|
||||
const language = this.detectLanguage(filename);
|
||||
const isCode = language !== undefined && language !== 'markdown';
|
||||
const title = options?.preferredTitle ?? filename;
|
||||
const content = options?.maxLength ? body.slice(0, options.maxLength) : body;
|
||||
|
||||
return {
|
||||
title,
|
||||
content: isCode ? `\`\`\`${language}\n${content}\n\`\`\`` : content,
|
||||
sourceUrl: url,
|
||||
tags: language ? ['github', language] : ['github'],
|
||||
extractedAt: new Date().toISOString(),
|
||||
contentType: 'github',
|
||||
language,
|
||||
metadata: {
|
||||
url,
|
||||
rawUrl,
|
||||
filename,
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
private htmlToMarkdown(html: string, url: string): { title: string; content: string } {
|
||||
const titleMatch = html.match(/<title[^>]*>([^<]+)<\/title>/i);
|
||||
const title = titleMatch?.[1]?.trim() ?? new URL(url).hostname;
|
||||
|
||||
const bodyMatch = html.match(/<body[^>]*>([\s\S]*)<\/body>/i);
|
||||
const bodyHtml = bodyMatch?.[1] ?? html;
|
||||
|
||||
const content = this.turndown.turndown(bodyHtml);
|
||||
return { title, content };
|
||||
}
|
||||
|
||||
private detectLanguage(filename: string): string | undefined {
|
||||
const ext = extname(filename).toLowerCase();
|
||||
return LANGUAGE_MAP[ext];
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,5 @@
|
||||
export { ContentExtractor } from './extractor.js';
|
||||
export { AutoTagger } from './tagger.js';
|
||||
export { SkillGenerator } from './skill-generator.js';
|
||||
export type { ExtractedContent, ExtractionOptions } from './types.js';
|
||||
export type { SaveGenerateOptions, SaveGeneratedSkill } from './skill-generator.js';
|
||||
@@ -0,0 +1,121 @@
|
||||
import { mkdirSync, writeFileSync } from 'node:fs';
|
||||
import { join } from 'node:path';
|
||||
import { homedir } from 'node:os';
|
||||
import type { ExtractedContent } from './types.js';
|
||||
import { AutoTagger } from './tagger.js';
|
||||
|
||||
export interface SaveGenerateOptions {
|
||||
name?: string;
|
||||
global?: boolean;
|
||||
outputDir?: string;
|
||||
}
|
||||
|
||||
export interface SaveGeneratedSkill {
|
||||
skillPath: string;
|
||||
skillMd: string;
|
||||
name: string;
|
||||
}
|
||||
|
||||
const MAX_NAME_LENGTH = 64;
|
||||
const SUMMARY_LINE_LIMIT = 100;
|
||||
const SPLIT_THRESHOLD = 500;
|
||||
const DESCRIPTION_MAX = 200;
|
||||
|
||||
export class SkillGenerator {
|
||||
private tagger = new AutoTagger();
|
||||
|
||||
generate(content: ExtractedContent, options: SaveGenerateOptions = {}): SaveGeneratedSkill {
|
||||
const name = options.name
|
||||
? this.slugify(options.name)
|
||||
: this.slugify(content.title || 'untitled-skill');
|
||||
|
||||
const tags = this.tagger.detectTags(content);
|
||||
const description = this.makeDescription(content.content);
|
||||
const source = content.sourceUrl ?? content.sourcePath ?? '';
|
||||
|
||||
const frontmatter = this.buildFrontmatter(name, description, tags, source);
|
||||
const lines = content.content.split('\n');
|
||||
const needsSplit = lines.length > SPLIT_THRESHOLD;
|
||||
|
||||
const body = needsSplit
|
||||
? lines.slice(0, SUMMARY_LINE_LIMIT).join('\n')
|
||||
: content.content;
|
||||
|
||||
const skillMd = `${frontmatter}\n${body}\n`;
|
||||
|
||||
const outputDir = options.outputDir ?? this.defaultOutputDir(name, options.global);
|
||||
mkdirSync(outputDir, { recursive: true });
|
||||
|
||||
const skillPath = join(outputDir, 'SKILL.md');
|
||||
writeFileSync(skillPath, skillMd, 'utf-8');
|
||||
|
||||
if (needsSplit) {
|
||||
const refsDir = join(outputDir, 'references');
|
||||
mkdirSync(refsDir, { recursive: true });
|
||||
writeFileSync(
|
||||
join(refsDir, 'full-content.md'),
|
||||
content.content,
|
||||
'utf-8',
|
||||
);
|
||||
}
|
||||
|
||||
return { skillPath, skillMd, name };
|
||||
}
|
||||
|
||||
private slugify(input: string): string {
|
||||
const slug = input
|
||||
.toLowerCase()
|
||||
.replace(/[^a-z0-9]+/g, '-')
|
||||
.replace(/^-+|-+$/g, '')
|
||||
.replace(/-{2,}/g, '-');
|
||||
|
||||
const trimmed = slug.slice(0, MAX_NAME_LENGTH).replace(/-+$/, '');
|
||||
return trimmed || 'untitled-skill';
|
||||
}
|
||||
|
||||
private makeDescription(content: string): string {
|
||||
const firstLine = content.split('\n').find((l) => l.trim().length > 0) ?? '';
|
||||
const cleaned = firstLine.replace(/^#+\s*/, '').trim();
|
||||
return cleaned.length > DESCRIPTION_MAX
|
||||
? cleaned.slice(0, DESCRIPTION_MAX - 3) + '...'
|
||||
: cleaned || 'Saved skill';
|
||||
}
|
||||
|
||||
private buildFrontmatter(
|
||||
name: string,
|
||||
description: string,
|
||||
tags: string[],
|
||||
source: string,
|
||||
): string {
|
||||
const yamlTags = tags.map((t) => ` - ${t}`).join('\n');
|
||||
const savedAt = new Date().toISOString();
|
||||
|
||||
const lines = [
|
||||
'---',
|
||||
`name: ${name}`,
|
||||
`description: ${this.yamlEscape(description)}`,
|
||||
tags.length > 0 ? `tags:\n${yamlTags}` : null,
|
||||
'metadata:',
|
||||
source ? ` source: ${source}` : null,
|
||||
` savedAt: ${savedAt}`,
|
||||
'---',
|
||||
].filter((l): l is string => l !== null);
|
||||
|
||||
return lines.join('\n') + '\n';
|
||||
}
|
||||
|
||||
private yamlEscape(value: string): string {
|
||||
const singleLine = value.replace(/\r?\n/g, ' ').trim();
|
||||
if (/[:#{}[\],&*?|>!%@`]/.test(singleLine) || singleLine.startsWith("'") || singleLine.startsWith('"')) {
|
||||
return `"${singleLine.replace(/\\/g, '\\\\').replace(/"/g, '\\"')}"`;
|
||||
}
|
||||
return singleLine;
|
||||
}
|
||||
|
||||
private defaultOutputDir(name: string, global?: boolean): string {
|
||||
if (global) {
|
||||
return join(homedir(), '.skillkit', 'skills', name);
|
||||
}
|
||||
return join('.skillkit', 'skills', name);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,98 @@
|
||||
import type { ExtractedContent } from './types.js';
|
||||
|
||||
const TECH_KEYWORDS = new Set([
|
||||
'react', 'vue', 'angular', 'svelte', 'nextjs', 'nuxt', 'remix',
|
||||
'typescript', 'javascript', 'python', 'rust', 'go', 'java', 'ruby',
|
||||
'node', 'deno', 'bun', 'docker', 'kubernetes', 'terraform',
|
||||
'aws', 'gcp', 'azure', 'vercel', 'netlify', 'cloudflare',
|
||||
'graphql', 'rest', 'grpc', 'websocket', 'redis', 'postgres',
|
||||
'mongodb', 'sqlite', 'mysql', 'prisma', 'drizzle',
|
||||
'tailwind', 'css', 'html', 'sass', 'webpack', 'vite', 'esbuild',
|
||||
'git', 'ci', 'cd', 'testing', 'security', 'authentication',
|
||||
'api', 'cli', 'sdk', 'mcp', 'llm', 'ai', 'ml', 'openai', 'anthropic',
|
||||
]);
|
||||
|
||||
const TAG_PATTERN = /^[a-z0-9]+(-[a-z0-9]+)*$/;
|
||||
|
||||
export class AutoTagger {
|
||||
detectTags(content: ExtractedContent): string[] {
|
||||
const tagCounts = new Map<string, number>();
|
||||
|
||||
this.extractFromUrl(content.sourceUrl, tagCounts);
|
||||
this.extractFromHeadings(content.content, tagCounts);
|
||||
this.extractFromCodeBlocks(content.content, tagCounts);
|
||||
this.extractFromKeywords(content.content, tagCounts);
|
||||
|
||||
if (content.language) {
|
||||
this.addTag(content.language.toLowerCase(), tagCounts, 3);
|
||||
}
|
||||
|
||||
if (content.contentType !== 'text') {
|
||||
this.addTag(content.contentType, tagCounts, 1);
|
||||
}
|
||||
|
||||
return Array.from(tagCounts.entries())
|
||||
.sort((a, b) => b[1] - a[1])
|
||||
.slice(0, 10)
|
||||
.map(([tag]) => tag);
|
||||
}
|
||||
|
||||
private extractFromUrl(url: string | undefined, counts: Map<string, number>): void {
|
||||
if (!url) return;
|
||||
try {
|
||||
const parsed = new URL(url);
|
||||
const segments = parsed.pathname
|
||||
.split('/')
|
||||
.filter(Boolean)
|
||||
.map((s) => s.toLowerCase().replace(/[^a-z0-9-]/g, ''));
|
||||
|
||||
for (const seg of segments) {
|
||||
if (seg.length >= 2 && seg.length <= 30 && TAG_PATTERN.test(seg)) {
|
||||
this.addTag(seg, counts, 2);
|
||||
}
|
||||
}
|
||||
} catch {
|
||||
// not a valid URL, skip
|
||||
}
|
||||
}
|
||||
|
||||
private extractFromHeadings(content: string, counts: Map<string, number>): void {
|
||||
const headingRe = /^#{1,2}\s+(.+)$/gm;
|
||||
let match: RegExpExecArray | null;
|
||||
while ((match = headingRe.exec(content)) !== null) {
|
||||
const words = match[1].toLowerCase().split(/\s+/);
|
||||
for (const word of words) {
|
||||
const cleaned = word.replace(/[^a-z0-9-]/g, '');
|
||||
if (cleaned.length >= 2 && TAG_PATTERN.test(cleaned)) {
|
||||
this.addTag(cleaned, counts, 2);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private extractFromCodeBlocks(content: string, counts: Map<string, number>): void {
|
||||
const codeBlockRe = /^```(\w+)/gm;
|
||||
let match: RegExpExecArray | null;
|
||||
while ((match = codeBlockRe.exec(content)) !== null) {
|
||||
const lang = match[1].toLowerCase();
|
||||
if (lang.length >= 2 && TAG_PATTERN.test(lang)) {
|
||||
this.addTag(lang, counts, 3);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private extractFromKeywords(content: string, counts: Map<string, number>): void {
|
||||
const lower = content.toLowerCase();
|
||||
for (const keyword of TECH_KEYWORDS) {
|
||||
const re = new RegExp(`\\b${keyword}\\b`, 'i');
|
||||
if (re.test(lower)) {
|
||||
this.addTag(keyword, counts, 1);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private addTag(tag: string, counts: Map<string, number>, weight: number): void {
|
||||
if (!TAG_PATTERN.test(tag)) return;
|
||||
counts.set(tag, (counts.get(tag) ?? 0) + weight);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,17 @@
|
||||
export interface ExtractedContent {
|
||||
title: string;
|
||||
content: string;
|
||||
sourceUrl?: string;
|
||||
sourcePath?: string;
|
||||
tags: string[];
|
||||
extractedAt: string;
|
||||
contentType: 'webpage' | 'github' | 'text' | 'code' | 'file';
|
||||
language?: string;
|
||||
metadata: Record<string, string>;
|
||||
}
|
||||
|
||||
export interface ExtractionOptions {
|
||||
includeImages?: boolean;
|
||||
maxLength?: number;
|
||||
preferredTitle?: string;
|
||||
}
|
||||
@@ -0,0 +1,6 @@
|
||||
import type { Finding } from '../types.js';
|
||||
|
||||
export interface Analyzer {
|
||||
name: string;
|
||||
analyze(skillPath: string, files: string[]): Promise<Finding[]>;
|
||||
}
|
||||
@@ -0,0 +1,212 @@
|
||||
import { readFile } from 'node:fs/promises';
|
||||
import { extname } from 'node:path';
|
||||
import type { Analyzer } from './base.js';
|
||||
import type { Finding } from '../types.js';
|
||||
import { Severity, ThreatCategory } from '../types.js';
|
||||
|
||||
const DANGEROUS_TOOLS = new Set(['Bash', 'bash', 'shell', 'terminal', 'exec', 'system']);
|
||||
|
||||
const IMPERSONATION_PATTERNS = [
|
||||
/official\s+(?:anthropic|openai|google|microsoft|meta)\s+(?:tool|skill|plugin)/i,
|
||||
/(?:anthropic|openai|google|microsoft|meta)\s+certified/i,
|
||||
/endorsed\s+by\s+(?:anthropic|openai|google|microsoft|meta)/i,
|
||||
];
|
||||
|
||||
const BINARY_EXTENSIONS = new Set([
|
||||
'.exe', '.dll', '.so', '.dylib', '.bin', '.dat',
|
||||
'.zip', '.tar', '.gz', '.rar', '.7z',
|
||||
'.wasm', '.pyc', '.pyo', '.class',
|
||||
]);
|
||||
|
||||
export class ManifestAnalyzer implements Analyzer {
|
||||
name = 'manifest';
|
||||
private findingCounter = 0;
|
||||
private skipRules: Set<string>;
|
||||
|
||||
constructor(skipRules?: string[]) {
|
||||
this.skipRules = new Set(skipRules ?? []);
|
||||
}
|
||||
|
||||
async analyze(_skillPath: string, files: string[]): Promise<Finding[]> {
|
||||
this.findingCounter = 0;
|
||||
const findings: Finding[] = [];
|
||||
|
||||
const skillMdFiles = files.filter((f) => f.toLowerCase().endsWith('skill.md'));
|
||||
|
||||
for (const skillMd of skillMdFiles) {
|
||||
let content: string;
|
||||
try {
|
||||
content = await readFile(skillMd, 'utf-8');
|
||||
} catch {
|
||||
continue;
|
||||
}
|
||||
|
||||
this.validateFrontmatter(content, skillMd, findings);
|
||||
this.checkImpersonation(content, skillMd, findings);
|
||||
}
|
||||
|
||||
this.checkBinaryFiles(files, findings);
|
||||
|
||||
return findings;
|
||||
}
|
||||
|
||||
private shouldSkip(ruleId: string): boolean {
|
||||
return this.skipRules.has(ruleId);
|
||||
}
|
||||
|
||||
private validateFrontmatter(content: string, filePath: string, findings: Finding[]): void {
|
||||
const fmMatch = content.match(/^---\r?\n([\s\S]*?)\r?\n---/);
|
||||
if (!fmMatch) {
|
||||
if (!this.shouldSkip('MF001')) {
|
||||
findings.push({
|
||||
id: `MF${++this.findingCounter}`,
|
||||
ruleId: 'MF001',
|
||||
category: ThreatCategory.POLICY_VIOLATION,
|
||||
severity: Severity.LOW,
|
||||
title: 'Missing SKILL.md frontmatter',
|
||||
description: 'SKILL.md should have YAML frontmatter with name, description, and allowed-tools',
|
||||
filePath,
|
||||
analyzer: this.name,
|
||||
remediation: 'Add YAML frontmatter with name, description, and allowed-tools fields.',
|
||||
});
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
const fm = fmMatch[1];
|
||||
|
||||
if (!/^name:/m.test(fm) && !this.shouldSkip('MF002')) {
|
||||
findings.push({
|
||||
id: `MF${++this.findingCounter}`,
|
||||
ruleId: 'MF002',
|
||||
category: ThreatCategory.POLICY_VIOLATION,
|
||||
severity: Severity.LOW,
|
||||
title: 'Missing skill name in frontmatter',
|
||||
description: 'SKILL.md frontmatter should include a name field',
|
||||
filePath,
|
||||
analyzer: this.name,
|
||||
remediation: 'Add a name field to the YAML frontmatter.',
|
||||
});
|
||||
}
|
||||
|
||||
const nameMatch = fm.match(/^name:\s*(.+)$/m);
|
||||
if (nameMatch) {
|
||||
const name = nameMatch[1].trim().replace(/^["']|["']$/g, '');
|
||||
if (!/^[a-z0-9][a-z0-9._-]*$/i.test(name) && !this.shouldSkip('MF003')) {
|
||||
findings.push({
|
||||
id: `MF${++this.findingCounter}`,
|
||||
ruleId: 'MF003',
|
||||
category: ThreatCategory.POLICY_VIOLATION,
|
||||
severity: Severity.LOW,
|
||||
title: 'Invalid skill name format',
|
||||
description: `Skill name "${name}" should use alphanumeric characters, dots, hyphens, or underscores`,
|
||||
filePath,
|
||||
analyzer: this.name,
|
||||
remediation: 'Use a name matching [a-z0-9][a-z0-9._-]* pattern.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const descMatch = fm.match(/^description:\s*(.+)$/m);
|
||||
if (!descMatch) {
|
||||
if (!this.shouldSkip('MF004')) {
|
||||
findings.push({
|
||||
id: `MF${++this.findingCounter}`,
|
||||
ruleId: 'MF004',
|
||||
category: ThreatCategory.POLICY_VIOLATION,
|
||||
severity: Severity.INFO,
|
||||
title: 'Missing skill description',
|
||||
description: 'SKILL.md should include a description for discoverability',
|
||||
filePath,
|
||||
analyzer: this.name,
|
||||
remediation: 'Add a description field to the YAML frontmatter.',
|
||||
});
|
||||
}
|
||||
} else {
|
||||
const desc = descMatch[1].trim().replace(/^["']|["']$/g, '');
|
||||
if (desc.length < 20 && !this.shouldSkip('MF005')) {
|
||||
findings.push({
|
||||
id: `MF${++this.findingCounter}`,
|
||||
ruleId: 'MF005',
|
||||
category: ThreatCategory.POLICY_VIOLATION,
|
||||
severity: Severity.INFO,
|
||||
title: 'Short skill description',
|
||||
description: `Description "${desc}" is too short (${desc.length} chars). Aim for at least 20 characters.`,
|
||||
filePath,
|
||||
analyzer: this.name,
|
||||
remediation: 'Provide a more detailed description.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const inlineToolsMatch = fm.match(/^allowed-tools:\s*\[([^\]]*)\]/m);
|
||||
const multiLineToolsMatch = fm.match(/^allowed-tools:\s*\n((?:\s+-\s+.+\n?)+)/m);
|
||||
|
||||
let tools: string[] = [];
|
||||
if (inlineToolsMatch) {
|
||||
tools = inlineToolsMatch[1].split(',').map((t) => t.trim().replace(/^["']|["']$/g, ''));
|
||||
} else if (multiLineToolsMatch) {
|
||||
tools = multiLineToolsMatch[1]
|
||||
.split('\n')
|
||||
.map((line) => line.replace(/^\s*-\s*/, '').trim().replace(/^["']|["']$/g, ''))
|
||||
.filter((t) => t.length > 0);
|
||||
}
|
||||
|
||||
for (const tool of tools) {
|
||||
if (DANGEROUS_TOOLS.has(tool) && !this.shouldSkip('MF006')) {
|
||||
findings.push({
|
||||
id: `MF${++this.findingCounter}`,
|
||||
ruleId: 'MF006',
|
||||
category: ThreatCategory.TOOL_ABUSE,
|
||||
severity: Severity.HIGH,
|
||||
title: `Dangerous tool in allowed-tools: ${tool}`,
|
||||
description: `The tool "${tool}" grants shell access. This is a significant security risk.`,
|
||||
filePath,
|
||||
analyzer: this.name,
|
||||
remediation: 'Restrict allowed-tools to the minimum needed. Avoid shell/exec tools.',
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private checkImpersonation(content: string, filePath: string, findings: Finding[]): void {
|
||||
for (const pattern of IMPERSONATION_PATTERNS) {
|
||||
const match = content.match(pattern);
|
||||
if (match && !this.shouldSkip('MF007')) {
|
||||
const lineNumber = content.substring(0, match.index).split('\n').length;
|
||||
findings.push({
|
||||
id: `MF${++this.findingCounter}`,
|
||||
ruleId: 'MF007',
|
||||
category: ThreatCategory.SOCIAL_ENGINEERING,
|
||||
severity: Severity.HIGH,
|
||||
title: 'Impersonation detected',
|
||||
description: `Skill claims official affiliation: "${match[0]}"`,
|
||||
filePath,
|
||||
lineNumber,
|
||||
snippet: match[0],
|
||||
analyzer: this.name,
|
||||
remediation: 'Remove false claims of official endorsement or certification.',
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private checkBinaryFiles(files: string[], findings: Finding[]): void {
|
||||
for (const file of files) {
|
||||
const ext = extname(file).toLowerCase();
|
||||
if (BINARY_EXTENSIONS.has(ext) && !this.shouldSkip('MF008')) {
|
||||
findings.push({
|
||||
id: `MF${++this.findingCounter}`,
|
||||
ruleId: 'MF008',
|
||||
category: ThreatCategory.POLICY_VIOLATION,
|
||||
severity: Severity.MEDIUM,
|
||||
title: `Binary file detected: ${ext}`,
|
||||
description: `Binary file found in skill directory. Skills should contain only text files.`,
|
||||
filePath: file,
|
||||
analyzer: this.name,
|
||||
remediation: 'Remove binary files from skill directory. Use package managers for dependencies.',
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,188 @@
|
||||
import { readFile } from 'node:fs/promises';
|
||||
import { basename } from 'node:path';
|
||||
import type { Analyzer } from './base.js';
|
||||
import type { Finding } from '../types.js';
|
||||
import { Severity, ThreatCategory } from '../types.js';
|
||||
|
||||
interface SecretPattern {
|
||||
id: string;
|
||||
name: string;
|
||||
pattern: RegExp;
|
||||
severity: Severity;
|
||||
}
|
||||
|
||||
const SECRET_PATTERNS: SecretPattern[] = [
|
||||
{
|
||||
id: 'SK001',
|
||||
name: 'OpenAI API key',
|
||||
pattern: /sk-(?!ant-)(?:proj-|admin-)?[A-Za-z0-9-]{20,}/,
|
||||
severity: Severity.CRITICAL,
|
||||
},
|
||||
{
|
||||
id: 'SK002',
|
||||
name: 'Stripe live key',
|
||||
pattern: /pk_live_[a-zA-Z0-9]{20,}/,
|
||||
severity: Severity.CRITICAL,
|
||||
},
|
||||
{
|
||||
id: 'SK003',
|
||||
name: 'Stripe secret key',
|
||||
pattern: /sk_live_[a-zA-Z0-9]{20,}/,
|
||||
severity: Severity.CRITICAL,
|
||||
},
|
||||
{
|
||||
id: 'SK004',
|
||||
name: 'GitHub personal access token',
|
||||
pattern: /ghp_[a-zA-Z0-9]{36}/,
|
||||
severity: Severity.CRITICAL,
|
||||
},
|
||||
{
|
||||
id: 'SK005',
|
||||
name: 'GitHub OAuth token',
|
||||
pattern: /gho_[a-zA-Z0-9]{36}/,
|
||||
severity: Severity.CRITICAL,
|
||||
},
|
||||
{
|
||||
id: 'SK006',
|
||||
name: 'AWS access key',
|
||||
pattern: /AKIA[0-9A-Z]{16}/,
|
||||
severity: Severity.CRITICAL,
|
||||
},
|
||||
{
|
||||
id: 'SK007',
|
||||
name: 'Slack bot token',
|
||||
pattern: /xoxb-[0-9]{10,}-[a-zA-Z0-9]{20,}/,
|
||||
severity: Severity.CRITICAL,
|
||||
},
|
||||
{
|
||||
id: 'SK008',
|
||||
name: 'Slack user token',
|
||||
pattern: /xoxp-[0-9]{10,}-[a-zA-Z0-9]{20,}/,
|
||||
severity: Severity.CRITICAL,
|
||||
},
|
||||
{
|
||||
id: 'SK009',
|
||||
name: 'Private key block',
|
||||
pattern: /-----BEGIN\s+(?:RSA\s+|EC\s+|DSA\s+|OPENSSH\s+)?PRIVATE\s+KEY-----/,
|
||||
severity: Severity.CRITICAL,
|
||||
},
|
||||
{
|
||||
id: 'SK010',
|
||||
name: 'Google API key',
|
||||
pattern: /AIza[0-9A-Za-z_-]{35}/,
|
||||
severity: Severity.HIGH,
|
||||
},
|
||||
{
|
||||
id: 'SK011',
|
||||
name: 'Anthropic API key',
|
||||
pattern: /sk-ant-[a-zA-Z0-9]{20,}/,
|
||||
severity: Severity.CRITICAL,
|
||||
},
|
||||
{
|
||||
id: 'SK012',
|
||||
name: 'npm token',
|
||||
pattern: /npm_[a-zA-Z0-9]{36}/,
|
||||
severity: Severity.HIGH,
|
||||
},
|
||||
{
|
||||
id: 'SK013',
|
||||
name: 'Heroku API key',
|
||||
pattern: /[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}/,
|
||||
severity: Severity.LOW,
|
||||
},
|
||||
];
|
||||
|
||||
const PLACEHOLDER_INDICATORS = [
|
||||
/your[-_]?api[-_]?key/i,
|
||||
/example/i,
|
||||
/sample/i,
|
||||
/dummy/i,
|
||||
/placeholder/i,
|
||||
/xxx+/i,
|
||||
/test[-_]?key/i,
|
||||
/fake/i,
|
||||
/replace[-_]?with/i,
|
||||
/\<.*key.*\>/i,
|
||||
];
|
||||
|
||||
const ENV_FILE_PATTERN = /^\.env/;
|
||||
|
||||
function isPlaceholder(line: string): boolean {
|
||||
return PLACEHOLDER_INDICATORS.some((p) => p.test(line));
|
||||
}
|
||||
|
||||
export class SecretsAnalyzer implements Analyzer {
|
||||
name = 'secrets';
|
||||
private findingCounter = 0;
|
||||
private skipRules: Set<string>;
|
||||
|
||||
constructor(skipRules?: string[]) {
|
||||
this.skipRules = new Set(skipRules ?? []);
|
||||
}
|
||||
|
||||
async analyze(_skillPath: string, files: string[]): Promise<Finding[]> {
|
||||
this.findingCounter = 0;
|
||||
const findings: Finding[] = [];
|
||||
|
||||
for (const file of files) {
|
||||
const name = basename(file);
|
||||
|
||||
if (ENV_FILE_PATTERN.test(name) && !this.skipRules.has('SK-ENV')) {
|
||||
findings.push({
|
||||
id: `SK${++this.findingCounter}`,
|
||||
ruleId: 'SK-ENV',
|
||||
category: ThreatCategory.HARDCODED_SECRETS,
|
||||
severity: Severity.HIGH,
|
||||
title: `Environment file included: ${name}`,
|
||||
description: 'Environment files should not be included in skill distributions',
|
||||
filePath: file,
|
||||
analyzer: this.name,
|
||||
remediation: 'Remove .env files from skill directory. Add to .gitignore.',
|
||||
});
|
||||
continue;
|
||||
}
|
||||
|
||||
let content: string;
|
||||
try {
|
||||
content = await readFile(file, 'utf-8');
|
||||
} catch {
|
||||
continue;
|
||||
}
|
||||
|
||||
if (content.length > 1_000_000) continue;
|
||||
|
||||
const lines = content.split('\n');
|
||||
|
||||
for (let i = 0; i < lines.length; i++) {
|
||||
const line = lines[i];
|
||||
if (isPlaceholder(line)) continue;
|
||||
|
||||
for (const secret of SECRET_PATTERNS) {
|
||||
if (this.skipRules.has(secret.id)) continue;
|
||||
if (secret.pattern.test(line)) {
|
||||
if (secret.id === 'SK013') {
|
||||
if (!/(?:key|token|secret|password|credential|api)/i.test(line)) continue;
|
||||
}
|
||||
|
||||
findings.push({
|
||||
id: `SK${++this.findingCounter}`,
|
||||
ruleId: secret.id,
|
||||
category: ThreatCategory.HARDCODED_SECRETS,
|
||||
severity: secret.severity,
|
||||
title: `${secret.name} detected`,
|
||||
description: `Potential ${secret.name} found in skill file`,
|
||||
filePath: file,
|
||||
lineNumber: i + 1,
|
||||
snippet: line.trim().replace(secret.pattern, '[REDACTED]').substring(0, 100),
|
||||
analyzer: this.name,
|
||||
remediation: 'Remove hardcoded secrets. Use environment variables or secret managers.',
|
||||
});
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return findings;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,166 @@
|
||||
import { readFile } from 'node:fs/promises';
|
||||
import { extname } from 'node:path';
|
||||
import type { Analyzer } from './base.js';
|
||||
import type { Finding, SecurityRule } from '../types.js';
|
||||
import { getAllRules } from '../rules/index.js';
|
||||
|
||||
const EXT_TO_FILETYPE: Record<string, string> = {
|
||||
'.ts': 'typescript',
|
||||
'.tsx': 'typescript',
|
||||
'.js': 'javascript',
|
||||
'.jsx': 'javascript',
|
||||
'.mjs': 'javascript',
|
||||
'.cjs': 'javascript',
|
||||
'.py': 'python',
|
||||
'.sh': 'bash',
|
||||
'.bash': 'bash',
|
||||
'.zsh': 'bash',
|
||||
'.md': 'markdown',
|
||||
'.mdx': 'markdown',
|
||||
};
|
||||
|
||||
const PLACEHOLDER_PATTERNS = [
|
||||
/your[-_]?api[-_]?key/i,
|
||||
/example[-_]?token/i,
|
||||
/sample[-_]?secret/i,
|
||||
/dummy[-_]?password/i,
|
||||
/placeholder/i,
|
||||
/xxx+/i,
|
||||
/\.\.\./,
|
||||
/TODO/,
|
||||
/FIXME/,
|
||||
];
|
||||
|
||||
const TEST_FILE_PATTERNS = [
|
||||
/\.test\.[jt]sx?$/,
|
||||
/\.spec\.[jt]sx?$/,
|
||||
/__tests__\//,
|
||||
/test\//,
|
||||
/tests\//,
|
||||
/\.stories\.[jt]sx?$/,
|
||||
];
|
||||
|
||||
function isTestFile(filePath: string): boolean {
|
||||
return TEST_FILE_PATTERNS.some((p) => p.test(filePath));
|
||||
}
|
||||
|
||||
function isPlaceholderLine(line: string): boolean {
|
||||
return PLACEHOLDER_PATTERNS.some((p) => p.test(line));
|
||||
}
|
||||
|
||||
function getFileType(filePath: string): string | undefined {
|
||||
return EXT_TO_FILETYPE[extname(filePath)];
|
||||
}
|
||||
|
||||
function ruleMatchesFileType(rule: SecurityRule, fileType: string | undefined): boolean {
|
||||
if (!rule.fileTypes || rule.fileTypes.length === 0) return true;
|
||||
if (!fileType) return true;
|
||||
return rule.fileTypes.includes(fileType);
|
||||
}
|
||||
|
||||
function matchesExcludePatterns(line: string, rule: SecurityRule): boolean {
|
||||
if (!rule.excludePatterns) return false;
|
||||
return rule.excludePatterns.some((p) => p.test(line));
|
||||
}
|
||||
|
||||
export class StaticAnalyzer implements Analyzer {
|
||||
name = 'static';
|
||||
private rules: SecurityRule[];
|
||||
private skipRules: Set<string>;
|
||||
private findingCounter = 0;
|
||||
|
||||
constructor(skipRules?: string[]) {
|
||||
this.rules = getAllRules();
|
||||
this.skipRules = new Set(skipRules ?? []);
|
||||
}
|
||||
|
||||
async analyze(_skillPath: string, files: string[]): Promise<Finding[]> {
|
||||
this.findingCounter = 0;
|
||||
const findings: Finding[] = [];
|
||||
|
||||
for (const file of files) {
|
||||
if (isTestFile(file)) continue;
|
||||
|
||||
const fileType = getFileType(file);
|
||||
const applicableRules = this.rules.filter(
|
||||
(r) => !this.skipRules.has(r.id) && ruleMatchesFileType(r, fileType)
|
||||
);
|
||||
|
||||
if (applicableRules.length === 0) continue;
|
||||
|
||||
let content: string;
|
||||
try {
|
||||
content = await readFile(file, 'utf-8');
|
||||
} catch {
|
||||
continue;
|
||||
}
|
||||
|
||||
const lines = content.split('\n');
|
||||
|
||||
for (const rule of applicableRules) {
|
||||
if (rule.multiline) {
|
||||
for (const pattern of rule.patterns) {
|
||||
pattern.lastIndex = 0;
|
||||
let match: RegExpExecArray | null;
|
||||
while ((match = pattern.exec(content)) !== null) {
|
||||
const lineNumber = content.substring(0, match.index).split('\n').length;
|
||||
const snippetStart = Math.max(0, match.index - 40);
|
||||
const snippet = content.substring(snippetStart, match.index + match[0].length + 40).trim().substring(0, 200);
|
||||
|
||||
if (isPlaceholderLine(snippet) || matchesExcludePatterns(snippet, rule)) {
|
||||
if (!pattern.global) break;
|
||||
continue;
|
||||
}
|
||||
|
||||
findings.push({
|
||||
id: `F${++this.findingCounter}`,
|
||||
ruleId: rule.id,
|
||||
category: rule.category,
|
||||
severity: rule.severity,
|
||||
title: rule.description,
|
||||
description: rule.description,
|
||||
filePath: file,
|
||||
lineNumber,
|
||||
snippet,
|
||||
remediation: rule.remediation,
|
||||
analyzer: this.name,
|
||||
});
|
||||
|
||||
if (!pattern.global) break;
|
||||
}
|
||||
}
|
||||
continue;
|
||||
}
|
||||
|
||||
for (let i = 0; i < lines.length; i++) {
|
||||
const line = lines[i];
|
||||
|
||||
if (isPlaceholderLine(line)) continue;
|
||||
if (matchesExcludePatterns(line, rule)) continue;
|
||||
|
||||
for (const pattern of rule.patterns) {
|
||||
pattern.lastIndex = 0;
|
||||
if (pattern.test(line)) {
|
||||
findings.push({
|
||||
id: `F${++this.findingCounter}`,
|
||||
ruleId: rule.id,
|
||||
category: rule.category,
|
||||
severity: rule.severity,
|
||||
title: rule.description,
|
||||
description: rule.description,
|
||||
filePath: file,
|
||||
lineNumber: i + 1,
|
||||
snippet: line.trim().substring(0, 200),
|
||||
remediation: rule.remediation,
|
||||
analyzer: this.name,
|
||||
});
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return findings;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,10 @@
|
||||
export { Severity, ThreatCategory } from './types.js';
|
||||
export type { SecurityRule, Finding, ScanResult, ScanOptions } from './types.js';
|
||||
export type { Analyzer } from './analyzers/base.js';
|
||||
export { StaticAnalyzer } from './analyzers/static.js';
|
||||
export { ManifestAnalyzer } from './analyzers/manifest.js';
|
||||
export { SecretsAnalyzer } from './analyzers/secrets.js';
|
||||
export { SkillScanner } from './scanner.js';
|
||||
export { formatResult, formatSummary, formatJson, formatTable, formatSarif } from './reporter.js';
|
||||
export { THREAT_TAXONOMY, getThreatInfo, getDefaultSeverity } from './taxonomy.js';
|
||||
export { getAllRules } from './rules/index.js';
|
||||
@@ -0,0 +1,182 @@
|
||||
import { basename } from 'node:path';
|
||||
import type { Finding, ScanResult } from './types.js';
|
||||
import { Severity } from './types.js';
|
||||
|
||||
declare const __PACKAGE_VERSION__: string;
|
||||
const SCANNER_VERSION = typeof __PACKAGE_VERSION__ !== 'undefined' ? __PACKAGE_VERSION__ : '0.0.0';
|
||||
|
||||
const SEVERITY_COLORS: Record<string, string> = {
|
||||
[Severity.CRITICAL]: '\x1b[91m',
|
||||
[Severity.HIGH]: '\x1b[31m',
|
||||
[Severity.MEDIUM]: '\x1b[33m',
|
||||
[Severity.LOW]: '\x1b[36m',
|
||||
[Severity.INFO]: '\x1b[37m',
|
||||
[Severity.SAFE]: '\x1b[32m',
|
||||
};
|
||||
const RESET = '\x1b[0m';
|
||||
const BOLD = '\x1b[1m';
|
||||
const DIM = '\x1b[2m';
|
||||
|
||||
const VERDICT_ICON: Record<string, string> = {
|
||||
pass: '\x1b[32m PASS \x1b[0m',
|
||||
warn: '\x1b[33m WARN \x1b[0m',
|
||||
fail: '\x1b[91m FAIL \x1b[0m',
|
||||
};
|
||||
|
||||
export function formatSummary(result: ScanResult): string {
|
||||
const lines: string[] = [];
|
||||
|
||||
lines.push('');
|
||||
lines.push(`${BOLD}Security Scan: ${result.skillName}${RESET}`);
|
||||
lines.push(`Verdict: ${VERDICT_ICON[result.verdict] ?? result.verdict}`);
|
||||
lines.push(`Duration: ${result.duration}ms | Analyzers: ${result.analyzersUsed.join(', ')}`);
|
||||
lines.push('');
|
||||
|
||||
const { critical, high, medium, low, info } = result.stats;
|
||||
const parts: string[] = [];
|
||||
if (critical) parts.push(`${SEVERITY_COLORS[Severity.CRITICAL]}${critical} critical${RESET}`);
|
||||
if (high) parts.push(`${SEVERITY_COLORS[Severity.HIGH]}${high} high${RESET}`);
|
||||
if (medium) parts.push(`${SEVERITY_COLORS[Severity.MEDIUM]}${medium} medium${RESET}`);
|
||||
if (low) parts.push(`${SEVERITY_COLORS[Severity.LOW]}${low} low${RESET}`);
|
||||
if (info) parts.push(`${SEVERITY_COLORS[Severity.INFO]}${info} info${RESET}`);
|
||||
|
||||
if (parts.length > 0) {
|
||||
lines.push(`Findings: ${parts.join(' | ')}`);
|
||||
lines.push('');
|
||||
} else {
|
||||
lines.push(`${SEVERITY_COLORS[Severity.SAFE]}No security findings${RESET}`);
|
||||
lines.push('');
|
||||
return lines.join('\n');
|
||||
}
|
||||
|
||||
for (const finding of result.findings) {
|
||||
const color = SEVERITY_COLORS[finding.severity] ?? '';
|
||||
const sev = finding.severity.toUpperCase().padEnd(8);
|
||||
lines.push(` ${color}${sev}${RESET} [${finding.ruleId}] ${finding.title}`);
|
||||
|
||||
if (finding.filePath) {
|
||||
const loc = finding.lineNumber ? `${finding.filePath}:${finding.lineNumber}` : finding.filePath;
|
||||
lines.push(` ${DIM}${loc}${RESET}`);
|
||||
}
|
||||
|
||||
if (finding.snippet) {
|
||||
lines.push(` ${DIM}> ${finding.snippet}${RESET}`);
|
||||
}
|
||||
|
||||
if (finding.remediation) {
|
||||
lines.push(` Fix: ${finding.remediation}`);
|
||||
}
|
||||
|
||||
lines.push('');
|
||||
}
|
||||
|
||||
return lines.join('\n');
|
||||
}
|
||||
|
||||
export function formatJson(result: ScanResult): string {
|
||||
return JSON.stringify(result, null, 2);
|
||||
}
|
||||
|
||||
export function formatTable(result: ScanResult): string {
|
||||
const lines: string[] = [];
|
||||
const header = ['Severity', 'Rule', 'Title', 'File', 'Line'];
|
||||
const widths = [10, 8, 50, 40, 6];
|
||||
|
||||
lines.push(header.map((h, i) => h.padEnd(widths[i])).join(' | '));
|
||||
lines.push(widths.map((w) => '-'.repeat(w)).join('-+-'));
|
||||
|
||||
for (const f of result.findings) {
|
||||
const row = [
|
||||
f.severity.toUpperCase().padEnd(widths[0]),
|
||||
f.ruleId.padEnd(widths[1]),
|
||||
f.title.substring(0, widths[2]).padEnd(widths[2]),
|
||||
(f.filePath ? basename(f.filePath) : '').substring(0, widths[3]).padEnd(widths[3]),
|
||||
String(f.lineNumber ?? '').padEnd(widths[4]),
|
||||
];
|
||||
lines.push(row.join(' | '));
|
||||
}
|
||||
|
||||
lines.push('');
|
||||
lines.push(`Total: ${result.findings.length} findings | Verdict: ${result.verdict.toUpperCase()}`);
|
||||
return lines.join('\n');
|
||||
}
|
||||
|
||||
export function formatSarif(result: ScanResult): string {
|
||||
const rules = new Map<string, Finding>();
|
||||
for (const f of result.findings) {
|
||||
if (!rules.has(f.ruleId)) rules.set(f.ruleId, f);
|
||||
}
|
||||
|
||||
const severityToSarif: Record<string, string> = {
|
||||
[Severity.CRITICAL]: 'error',
|
||||
[Severity.HIGH]: 'error',
|
||||
[Severity.MEDIUM]: 'warning',
|
||||
[Severity.LOW]: 'note',
|
||||
[Severity.INFO]: 'note',
|
||||
[Severity.SAFE]: 'none',
|
||||
};
|
||||
|
||||
const sarif = {
|
||||
$schema: 'https://raw.githubusercontent.com/oasis-tcs/sarif-spec/main/sarif-2.1/schema/sarif-schema-2.1.0.json',
|
||||
version: '2.1.0',
|
||||
runs: [
|
||||
{
|
||||
tool: {
|
||||
driver: {
|
||||
name: 'skillkit-scanner',
|
||||
version: SCANNER_VERSION,
|
||||
informationUri: 'https://agenstskills.com',
|
||||
rules: [...rules.values()].map((r) => ({
|
||||
id: r.ruleId,
|
||||
name: r.ruleId,
|
||||
shortDescription: { text: r.title },
|
||||
fullDescription: { text: r.description },
|
||||
helpUri: 'https://agenstskills.com/docs/security',
|
||||
defaultConfiguration: {
|
||||
level: severityToSarif[r.severity] ?? 'warning',
|
||||
},
|
||||
properties: {
|
||||
category: r.category,
|
||||
},
|
||||
})),
|
||||
},
|
||||
},
|
||||
results: result.findings.map((f) => ({
|
||||
ruleId: f.ruleId,
|
||||
level: severityToSarif[f.severity] ?? 'warning',
|
||||
message: { text: f.description },
|
||||
locations: f.filePath
|
||||
? [
|
||||
{
|
||||
physicalLocation: {
|
||||
artifactLocation: {
|
||||
uri: f.filePath.startsWith(result.skillPath)
|
||||
? f.filePath.slice(result.skillPath.length).replace(/^\//, '')
|
||||
: f.filePath,
|
||||
},
|
||||
region: f.lineNumber
|
||||
? { startLine: f.lineNumber }
|
||||
: undefined,
|
||||
},
|
||||
},
|
||||
]
|
||||
: [],
|
||||
fixes: f.remediation
|
||||
? [{ description: { text: f.remediation } }]
|
||||
: undefined,
|
||||
})),
|
||||
},
|
||||
],
|
||||
};
|
||||
|
||||
return JSON.stringify(sarif, null, 2);
|
||||
}
|
||||
|
||||
export function formatResult(result: ScanResult, format: string = 'summary'): string {
|
||||
switch (format) {
|
||||
case 'json': return formatJson(result);
|
||||
case 'table': return formatTable(result);
|
||||
case 'sarif': return formatSarif(result);
|
||||
default: return formatSummary(result);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,114 @@
|
||||
import { type SecurityRule, Severity, ThreatCategory } from '../types.js';
|
||||
|
||||
export const commandInjectionRules: SecurityRule[] = [
|
||||
{
|
||||
id: 'CI001',
|
||||
category: ThreatCategory.COMMAND_INJECTION,
|
||||
severity: Severity.CRITICAL,
|
||||
patterns: [/\beval\s*\(/],
|
||||
excludePatterns: [/\/\/.*\beval\b/, /#.*\beval\b/, /['"].*\beval\b.*['"]/],
|
||||
fileTypes: ['typescript', 'javascript', 'python'],
|
||||
description: 'eval() call: dynamic code execution',
|
||||
remediation: 'Replace eval() with safer alternatives like JSON.parse() or dedicated parsers.',
|
||||
},
|
||||
{
|
||||
id: 'CI002',
|
||||
category: ThreatCategory.COMMAND_INJECTION,
|
||||
severity: Severity.CRITICAL,
|
||||
patterns: [/new\s+Function\s*\(/, /\bFunction\s*\(\s*['"`]/],
|
||||
fileTypes: ['typescript', 'javascript'],
|
||||
description: 'Function() constructor: dynamic code generation',
|
||||
remediation: 'Avoid Function() constructor. Use static code structures.',
|
||||
},
|
||||
{
|
||||
id: 'CI003',
|
||||
category: ThreatCategory.COMMAND_INJECTION,
|
||||
severity: Severity.CRITICAL,
|
||||
patterns: [
|
||||
/child_process\s*['"]?\s*\)\s*\.\s*exec\s*\(/,
|
||||
/\bexec\s*\(\s*['"`].*\$\{/,
|
||||
/\bexecSync\s*\(/,
|
||||
/require\s*\(\s*['"]child_process['"]\s*\)/,
|
||||
],
|
||||
fileTypes: ['typescript', 'javascript'],
|
||||
description: 'child_process execution: shell command injection risk',
|
||||
remediation: 'Use execFile() with argument arrays instead of exec() with string interpolation.',
|
||||
},
|
||||
{
|
||||
id: 'CI004',
|
||||
category: ThreatCategory.COMMAND_INJECTION,
|
||||
severity: Severity.CRITICAL,
|
||||
patterns: [
|
||||
/subprocess\.(?:call|run|Popen)\s*\([^)]*shell\s*=\s*True/,
|
||||
/os\.system\s*\(/,
|
||||
/os\.popen\s*\(/,
|
||||
],
|
||||
fileTypes: ['python'],
|
||||
description: 'Python shell execution with shell=True or os.system()',
|
||||
remediation: 'Use subprocess.run() with shell=False and argument lists.',
|
||||
},
|
||||
{
|
||||
id: 'CI005',
|
||||
category: ThreatCategory.COMMAND_INJECTION,
|
||||
severity: Severity.MEDIUM,
|
||||
patterns: [/`[^`]*\$\{[^}]*\}[^`]*`/],
|
||||
excludePatterns: [/console\.log/, /logger\./, /throw\s+new/, /return\s+`/, /=\s*`/, /\+\s*`/, /\(\s*`/],
|
||||
fileTypes: ['typescript', 'javascript'],
|
||||
description: 'Template literal with dynamic content in potential command context',
|
||||
remediation: 'Avoid interpolating user input into command strings. Use argument arrays.',
|
||||
},
|
||||
{
|
||||
id: 'CI006',
|
||||
category: ThreatCategory.COMMAND_INJECTION,
|
||||
severity: Severity.MEDIUM,
|
||||
patterns: [/\.\.\//, /\.\.\\/],
|
||||
excludePatterns: [/import\s+.*from\s+['"]\.\.\//, /require\s*\(\s*['"]\.\.\//, /\/\/.*\.\.\//, /#.*\.\.\//, /\]\(\.\.\//, /href\s*=\s*['"]\.\.\//, /src\s*=\s*['"]\.\.\//, /include\s+['"]\.\.\//, /!\[.*\]\(\.\.\//, /\.\.\/node_modules/],
|
||||
fileTypes: ['typescript', 'javascript', 'python', 'bash'],
|
||||
description: 'Path traversal: relative path escaping directory boundaries',
|
||||
remediation: 'Use path.resolve() and validate paths are within expected directories.',
|
||||
},
|
||||
{
|
||||
id: 'CI007',
|
||||
category: ThreatCategory.COMMAND_INJECTION,
|
||||
severity: Severity.HIGH,
|
||||
patterns: [
|
||||
/;\s*(?:rm|cat|curl|wget|nc|ncat)\s+/,
|
||||
/\|\s*(?:sh|bash|zsh|dash)\b/,
|
||||
/&&\s*(?:rm|curl|wget)\s+/,
|
||||
],
|
||||
fileTypes: ['bash', 'markdown'],
|
||||
description: 'Shell command chaining with dangerous commands',
|
||||
remediation: 'Avoid chaining shell commands. Use discrete, validated command invocations.',
|
||||
},
|
||||
{
|
||||
id: 'CI008',
|
||||
category: ThreatCategory.COMMAND_INJECTION,
|
||||
severity: Severity.MEDIUM,
|
||||
patterns: [/\bexec\s*\(/, /\bspawn\s*\(/],
|
||||
excludePatterns: [/execFile\s*\(/, /\.exec\s*\(/, /RegExp.*\.exec/],
|
||||
fileTypes: ['typescript', 'javascript'],
|
||||
description: 'Process execution functions detected',
|
||||
remediation: 'Prefer execFile() over exec(). Validate all command arguments.',
|
||||
},
|
||||
{
|
||||
id: 'CI009',
|
||||
category: ThreatCategory.COMMAND_INJECTION,
|
||||
severity: Severity.HIGH,
|
||||
patterns: [
|
||||
/\b__import__\s*\(/,
|
||||
/\bcompile\s*\(\s*['"][^'"]*['"]\s*,\s*['"][^'"]*['"]\s*,\s*['"]exec['"]\s*\)/,
|
||||
],
|
||||
fileTypes: ['python'],
|
||||
description: 'Python dynamic import or code compilation',
|
||||
remediation: 'Use standard import statements. Avoid dynamic code compilation.',
|
||||
},
|
||||
{
|
||||
id: 'CI010',
|
||||
category: ThreatCategory.COMMAND_INJECTION,
|
||||
severity: Severity.MEDIUM,
|
||||
patterns: [/\bvm\.runIn(?:ThisContext|NewContext|Context)\s*\(/],
|
||||
fileTypes: ['typescript', 'javascript'],
|
||||
description: 'Node.js vm module: sandboxed but potentially dangerous code execution',
|
||||
remediation: 'Avoid vm module for untrusted code. Use proper sandboxing solutions.',
|
||||
},
|
||||
];
|
||||
@@ -0,0 +1,101 @@
|
||||
import { type SecurityRule, Severity, ThreatCategory } from '../types.js';
|
||||
|
||||
export const dataExfiltrationRules: SecurityRule[] = [
|
||||
{
|
||||
id: 'DE001',
|
||||
category: ThreatCategory.DATA_EXFILTRATION,
|
||||
severity: Severity.HIGH,
|
||||
patterns: [
|
||||
/https?:\/\/(?:discord(?:app)?\.com\/api\/webhooks|ptb\.discord\.com\/api\/webhooks)\//i,
|
||||
/https?:\/\/hooks\.slack\.com\/services\//i,
|
||||
/https?:\/\/api\.telegram\.org\/bot/i,
|
||||
],
|
||||
description: 'Webhook URL detected: Discord, Slack, or Telegram webhook endpoint',
|
||||
remediation: 'Remove hardcoded webhook URLs. Use environment variables or configuration files.',
|
||||
},
|
||||
{
|
||||
id: 'DE002',
|
||||
category: ThreatCategory.DATA_EXFILTRATION,
|
||||
severity: Severity.HIGH,
|
||||
patterns: [
|
||||
/(?:fetch|axios|request|got|ky|undici)\s*(?:\.\s*post)?\s*\([^)]*(?:process\.env|credentials|password|secret|token)/i,
|
||||
],
|
||||
description: 'HTTP request sending sensitive data: credentials or environment variables in request',
|
||||
remediation: 'Never send credentials or env vars to external services from skill code.',
|
||||
},
|
||||
{
|
||||
id: 'DE003',
|
||||
category: ThreatCategory.DATA_EXFILTRATION,
|
||||
severity: Severity.MEDIUM,
|
||||
patterns: [
|
||||
/process\.env\[/,
|
||||
/process\.env\./,
|
||||
/os\.environ/,
|
||||
/\$ENV\{/,
|
||||
],
|
||||
excludePatterns: [/process\.env\.NODE_ENV/, /process\.env\.HOME/, /process\.env\.PATH/],
|
||||
description: 'Environment variable access: skill reads environment variables',
|
||||
remediation: 'Skills should declare required env vars in manifest, not access them directly.',
|
||||
},
|
||||
{
|
||||
id: 'DE004',
|
||||
category: ThreatCategory.DATA_EXFILTRATION,
|
||||
severity: Severity.HIGH,
|
||||
patterns: [
|
||||
/readFile.*(?:\.env|credentials|\.aws|\.ssh|\.gnupg|\.netrc)/i,
|
||||
/open\s*\(\s*['"].*(?:\.env|credentials|\.aws|\.ssh|\.gnupg)/i,
|
||||
/cat\s+.*(?:\.env|credentials|id_rsa|\.aws\/)/i,
|
||||
],
|
||||
description: 'Sensitive file access: reading credential or configuration files',
|
||||
remediation: 'Skills should not read user credential files.',
|
||||
},
|
||||
{
|
||||
id: 'DE005',
|
||||
category: ThreatCategory.DATA_EXFILTRATION,
|
||||
severity: Severity.MEDIUM,
|
||||
patterns: [
|
||||
/new\s+WebSocket\s*\(\s*['"`]/,
|
||||
/\bio\.connect\s*\(/,
|
||||
],
|
||||
description: 'WebSocket connection: potential covert data channel',
|
||||
remediation: 'Document all network connections. Avoid persistent connections in skills.',
|
||||
},
|
||||
{
|
||||
id: 'DE006',
|
||||
category: ThreatCategory.DATA_EXFILTRATION,
|
||||
severity: Severity.HIGH,
|
||||
patterns: [
|
||||
/https?:\/\/[a-z0-9]+\.ngrok\b/i,
|
||||
/https?:\/\/[a-z0-9]+\.serveo\.net/i,
|
||||
/https?:\/\/[a-z0-9]+\.loca\.lt/i,
|
||||
/https?:\/\/[a-z0-9]+\.burpcollaborator\.net/i,
|
||||
],
|
||||
description: 'Tunneling service URL: potential data exfiltration via tunnel',
|
||||
remediation: 'Remove tunneling service URLs. Use official API endpoints.',
|
||||
},
|
||||
{
|
||||
id: 'DE007',
|
||||
category: ThreatCategory.DATA_EXFILTRATION,
|
||||
severity: Severity.MEDIUM,
|
||||
patterns: [
|
||||
/dns\.resolve/i,
|
||||
/\bdnslookup\b/i,
|
||||
/\bnslookup\s+/i,
|
||||
/\bdig\s+/i,
|
||||
],
|
||||
description: 'DNS-based data exfiltration: DNS queries can encode stolen data',
|
||||
remediation: 'Skills should not perform DNS queries unless explicitly required.',
|
||||
},
|
||||
{
|
||||
id: 'DE008',
|
||||
category: ThreatCategory.DATA_EXFILTRATION,
|
||||
severity: Severity.MEDIUM,
|
||||
patterns: [
|
||||
/(?:fetch|axios|request|got)\s*\(\s*['"`]https?:\/\/(?!localhost|127\.0\.0\.1)/,
|
||||
],
|
||||
excludePatterns: [/(?:npmjs\.org|github\.com|githubusercontent\.com|registry\.npmmirror)/],
|
||||
fileTypes: ['typescript', 'javascript'],
|
||||
description: 'External HTTP request: skill makes outbound network call',
|
||||
remediation: 'Declare all external URLs in skill manifest. Minimize network access.',
|
||||
},
|
||||
];
|
||||
@@ -0,0 +1,24 @@
|
||||
import type { SecurityRule } from '../types.js';
|
||||
import { promptInjectionRules } from './prompt-injection.js';
|
||||
import { commandInjectionRules } from './command-injection.js';
|
||||
import { dataExfiltrationRules } from './data-exfiltration.js';
|
||||
import { toolAbuseRules } from './tool-abuse.js';
|
||||
import { unicodeRules } from './unicode.js';
|
||||
|
||||
export function getAllRules(): SecurityRule[] {
|
||||
return [
|
||||
...promptInjectionRules,
|
||||
...commandInjectionRules,
|
||||
...dataExfiltrationRules,
|
||||
...toolAbuseRules,
|
||||
...unicodeRules,
|
||||
];
|
||||
}
|
||||
|
||||
export {
|
||||
promptInjectionRules,
|
||||
commandInjectionRules,
|
||||
dataExfiltrationRules,
|
||||
toolAbuseRules,
|
||||
unicodeRules,
|
||||
};
|
||||
@@ -0,0 +1,145 @@
|
||||
import { type SecurityRule, Severity, ThreatCategory } from '../types.js';
|
||||
|
||||
export const promptInjectionRules: SecurityRule[] = [
|
||||
{
|
||||
id: 'PI001',
|
||||
category: ThreatCategory.PROMPT_INJECTION,
|
||||
severity: Severity.CRITICAL,
|
||||
patterns: [/ignore\s+(all\s+)?(previous|above|prior)\s+(instructions?|rules?|guidelines?)/i],
|
||||
description: 'Instruction override: attempts to discard system instructions',
|
||||
remediation: 'Remove instruction override language. Skills should not attempt to modify agent behavior.',
|
||||
},
|
||||
{
|
||||
id: 'PI002',
|
||||
category: ThreatCategory.PROMPT_INJECTION,
|
||||
severity: Severity.CRITICAL,
|
||||
patterns: [/forget\s+(everything|all|what)\s+(you|i)\s+(told|said|learned)/i],
|
||||
description: 'Context clearing: attempts to wipe agent memory',
|
||||
remediation: 'Remove context-clearing instructions.',
|
||||
},
|
||||
{
|
||||
id: 'PI003',
|
||||
category: ThreatCategory.PROMPT_INJECTION,
|
||||
severity: Severity.CRITICAL,
|
||||
patterns: [/disregard\s+(your|all|the)\s+(training|programming|instructions?)/i],
|
||||
description: 'Training bypass: attempts to override agent training',
|
||||
remediation: 'Remove training bypass instructions.',
|
||||
},
|
||||
{
|
||||
id: 'PI004',
|
||||
category: ThreatCategory.PROMPT_INJECTION,
|
||||
severity: Severity.CRITICAL,
|
||||
patterns: [/new\s+instructions?:\s*$/im, /system\s+prompt:\s*$/im],
|
||||
description: 'System prompt injection: attempts to inject new system-level instructions',
|
||||
remediation: 'Do not include system prompt markers in skill content.',
|
||||
},
|
||||
{
|
||||
id: 'PI005',
|
||||
category: ThreatCategory.PROMPT_INJECTION,
|
||||
severity: Severity.HIGH,
|
||||
patterns: [/you\s+are\s+(now|actually|really)\s+(a|an|the)/i],
|
||||
description: 'Role manipulation: attempts to reassign agent identity',
|
||||
remediation: 'Skills should not attempt to change the agent\'s role or identity.',
|
||||
},
|
||||
{
|
||||
id: 'PI006',
|
||||
category: ThreatCategory.PROMPT_INJECTION,
|
||||
severity: Severity.HIGH,
|
||||
patterns: [/pretend\s+(to\s+be|you\s+are)/i, /act\s+as\s+(if|though)\s+you/i],
|
||||
description: 'Roleplay manipulation: attempts to alter agent behavior via pretense',
|
||||
remediation: 'Remove roleplay instructions that change agent behavior.',
|
||||
},
|
||||
{
|
||||
id: 'PI007',
|
||||
category: ThreatCategory.PROMPT_INJECTION,
|
||||
severity: Severity.HIGH,
|
||||
patterns: [/from\s+now\s+on,?\s+(you|always|never)/i],
|
||||
description: 'Persistent behavior change: attempts to permanently alter agent behavior',
|
||||
remediation: 'Skills should provide task-specific instructions, not permanent behavior changes.',
|
||||
},
|
||||
{
|
||||
id: 'PI008',
|
||||
category: ThreatCategory.PROMPT_INJECTION,
|
||||
severity: Severity.HIGH,
|
||||
patterns: [
|
||||
/show\s+me\s+your\s+(system\s+)?(prompt|instructions)/i,
|
||||
/reveal\s+your\s+(system\s+)?(prompt|instructions)/i,
|
||||
/what\s+are\s+your\s+(system\s+)?(instructions|rules)/i,
|
||||
],
|
||||
description: 'System prompt extraction: attempts to reveal agent configuration',
|
||||
remediation: 'Remove attempts to extract system prompts.',
|
||||
},
|
||||
{
|
||||
id: 'PI009',
|
||||
category: ThreatCategory.PROMPT_INJECTION,
|
||||
severity: Severity.CRITICAL,
|
||||
patterns: [
|
||||
/unrestricted\s+mode/i,
|
||||
/(?<!detect(?:ing)?[\s.]+)(?<!prevent(?:ing)?[\s.]+)jailbreak/i,
|
||||
/DAN\s+(mode|prompt)/i,
|
||||
/bypass\s+(safety|content)\s+(filter|restriction)/i,
|
||||
],
|
||||
description: 'Policy bypass: attempts to disable safety restrictions',
|
||||
remediation: 'Remove jailbreak or policy bypass instructions.',
|
||||
},
|
||||
{
|
||||
id: 'PI010',
|
||||
category: ThreatCategory.PROMPT_INJECTION,
|
||||
severity: Severity.HIGH,
|
||||
patterns: [
|
||||
/don'?t\s+tell\s+the\s+user/i,
|
||||
/hide\s+this\s+from\s+the\s+user/i,
|
||||
/keep\s+this\s+(a\s+)?secret/i,
|
||||
/do\s+not\s+mention\s+this/i,
|
||||
],
|
||||
description: 'Concealment: instructs agent to hide information from user',
|
||||
remediation: 'Skills should be transparent. Remove concealment instructions.',
|
||||
},
|
||||
{
|
||||
id: 'PI011',
|
||||
category: ThreatCategory.PROMPT_INJECTION,
|
||||
severity: Severity.HIGH,
|
||||
patterns: [
|
||||
/```\s*(system|assistant|user)\s*$/im,
|
||||
/<\/?(?:system|user|assistant|human|ai|claude)>/i,
|
||||
],
|
||||
description: 'Delimiter injection: attempts to inject conversation role markers',
|
||||
remediation: 'Remove conversation role delimiters from skill content.',
|
||||
},
|
||||
{
|
||||
id: 'PI012',
|
||||
category: ThreatCategory.PROMPT_INJECTION,
|
||||
severity: Severity.HIGH,
|
||||
patterns: [/\[INST\]/i, /\[\/INST\]/i, /<<SYS>>/i, /<<\/SYS>>/i],
|
||||
description: 'Model-specific delimiter injection: Llama-style instruction delimiters',
|
||||
remediation: 'Remove model-specific instruction delimiters.',
|
||||
},
|
||||
{
|
||||
id: 'PI013',
|
||||
category: ThreatCategory.PROMPT_INJECTION,
|
||||
severity: Severity.MEDIUM,
|
||||
patterns: [/---\s*$/im],
|
||||
excludePatterns: [/^---\s*$/],
|
||||
multiline: true,
|
||||
description: 'YAML front-matter injection: attempts to inject via YAML metadata',
|
||||
remediation: 'Use standard SKILL.md frontmatter format only.',
|
||||
},
|
||||
{
|
||||
id: 'PI014',
|
||||
category: ThreatCategory.PROMPT_INJECTION,
|
||||
severity: Severity.MEDIUM,
|
||||
patterns: [
|
||||
/<!--[^>]{0,500}?(?:ignore|system|instruction|secret|override)[^>]{0,500}?-->/i,
|
||||
],
|
||||
description: 'Hidden HTML comments with suspicious instruction content',
|
||||
remediation: 'Do not hide instructions in HTML comments.',
|
||||
},
|
||||
{
|
||||
id: 'PI015',
|
||||
category: ThreatCategory.PROMPT_INJECTION,
|
||||
severity: Severity.MEDIUM,
|
||||
patterns: [/\[comment\]:\s*#\s*\([^)]*(?:ignore|system|override)[^)]*\)/i],
|
||||
description: 'Hidden Markdown comments with suspicious content',
|
||||
remediation: 'Do not hide instructions in Markdown comments.',
|
||||
},
|
||||
];
|
||||
@@ -0,0 +1,77 @@
|
||||
import { type SecurityRule, Severity, ThreatCategory } from '../types.js';
|
||||
|
||||
export const toolAbuseRules: SecurityRule[] = [
|
||||
{
|
||||
id: 'TA001',
|
||||
category: ThreatCategory.TOOL_ABUSE,
|
||||
severity: Severity.HIGH,
|
||||
patterns: [
|
||||
/(?:override|replace|redefine|shadow)\s+(?:the\s+)?(?:built-?in|default|original)\s+(?:tool|function|command)/i,
|
||||
],
|
||||
fileTypes: ['markdown'],
|
||||
description: 'Tool shadowing: instructs agent to override built-in tools',
|
||||
remediation: 'Skills should extend functionality, not replace built-in tools.',
|
||||
},
|
||||
{
|
||||
id: 'TA002',
|
||||
category: ThreatCategory.AUTONOMY_ABUSE,
|
||||
severity: Severity.HIGH,
|
||||
patterns: [
|
||||
/(?:keep|continue)\s+(?:retrying|trying|running)\s+(?:until|without)/i,
|
||||
/(?:run|execute|proceed)\s+without\s+(?:confirmation|approval|asking)/i,
|
||||
/(?:auto-?approve|skip\s+confirmation|bypass\s+approval)/i,
|
||||
/(?:don'?t|do\s+not|never)\s+(?:ask|prompt|wait)\s+(?:for|the)\s+(?:permission|confirmation|approval)/i,
|
||||
],
|
||||
fileTypes: ['markdown'],
|
||||
description: 'Autonomy abuse: instructs agent to bypass user confirmation',
|
||||
remediation: 'Skills must respect user confirmation flows. Remove autonomy escalation.',
|
||||
},
|
||||
{
|
||||
id: 'TA003',
|
||||
category: ThreatCategory.TOOL_ABUSE,
|
||||
severity: Severity.MEDIUM,
|
||||
patterns: [
|
||||
/(?:discover|find|list|enumerate)\s+(?:all\s+)?(?:available\s+)?(?:tools|capabilities|functions)/i,
|
||||
/(?:enable|activate|unlock)\s+(?:all\s+)?(?:hidden|disabled|extra)\s+(?:tools|capabilities)/i,
|
||||
],
|
||||
fileTypes: ['markdown'],
|
||||
description: 'Capability inflation: attempts to discover or enable additional tools',
|
||||
remediation: 'Skills should use only declared tools. Do not probe for hidden capabilities.',
|
||||
},
|
||||
{
|
||||
id: 'TA004',
|
||||
category: ThreatCategory.TOOL_ABUSE,
|
||||
severity: Severity.HIGH,
|
||||
patterns: [
|
||||
/read\s+(?:the\s+)?(?:file|contents?).*(?:then|and)\s+(?:send|post|upload|transmit)/i,
|
||||
/(?:access|read|get)\s+.*(?:credential|secret|key|token).*(?:then|and)\s+(?:send|share|post)/i,
|
||||
],
|
||||
fileTypes: ['markdown'],
|
||||
description: 'Tool chaining: read sensitive data then send externally',
|
||||
remediation: 'Skills should not combine file reading with external transmission.',
|
||||
},
|
||||
{
|
||||
id: 'TA005',
|
||||
category: ThreatCategory.SOCIAL_ENGINEERING,
|
||||
severity: Severity.MEDIUM,
|
||||
patterns: [
|
||||
/(?:urgent|immediately|critical|emergency)[!:]\s+(?:you\s+must|run|execute|do\s+this)/i,
|
||||
/(?:as\s+(?:an?\s+)?(?:admin|root|superuser|administrator)),?\s+(?:I|we)\s+(?:require|need|demand)/i,
|
||||
],
|
||||
fileTypes: ['markdown'],
|
||||
description: 'Social engineering: uses urgency or authority to manipulate agent',
|
||||
remediation: 'Remove manipulative language. Provide clear, neutral instructions.',
|
||||
},
|
||||
{
|
||||
id: 'TA006',
|
||||
category: ThreatCategory.TOOL_ABUSE,
|
||||
severity: Severity.MEDIUM,
|
||||
patterns: [
|
||||
/(?:when|if)\s+(?:the\s+)?(?:user|human)\s+(?:isn'?t|is\s+not)\s+(?:looking|watching|present)/i,
|
||||
/(?:only|secretly)\s+(?:when|while)\s+(?:idle|unattended|background)/i,
|
||||
],
|
||||
fileTypes: ['markdown'],
|
||||
description: 'Stealth execution: instructs agent to act when user is not present',
|
||||
remediation: 'All skill actions must be transparent and auditable.',
|
||||
},
|
||||
];
|
||||
@@ -0,0 +1,68 @@
|
||||
import { type SecurityRule, Severity, ThreatCategory } from '../types.js';
|
||||
|
||||
export const unicodeRules: SecurityRule[] = [
|
||||
{
|
||||
id: 'UC001',
|
||||
category: ThreatCategory.UNICODE_STEGANOGRAPHY,
|
||||
severity: Severity.MEDIUM,
|
||||
patterns: [/\u200B|\u200C|\u200D|\uFEFF/],
|
||||
description: 'Zero-width characters detected: may hide invisible instructions',
|
||||
remediation: 'Remove zero-width characters (U+200B, U+200C, U+200D, U+FEFF).',
|
||||
},
|
||||
{
|
||||
id: 'UC002',
|
||||
category: ThreatCategory.UNICODE_STEGANOGRAPHY,
|
||||
severity: Severity.HIGH,
|
||||
patterns: [/[\u202A-\u202E]/],
|
||||
description: 'Bidirectional text override: can reverse displayed text direction to hide content',
|
||||
remediation: 'Remove bidirectional override characters (U+202A-U+202E).',
|
||||
},
|
||||
{
|
||||
id: 'UC003',
|
||||
category: ThreatCategory.UNICODE_STEGANOGRAPHY,
|
||||
severity: Severity.HIGH,
|
||||
patterns: [/[\u2066-\u2069]/],
|
||||
description: 'Bidirectional isolate characters: can create hidden text regions',
|
||||
remediation: 'Remove bidirectional isolate characters (U+2066-U+2069).',
|
||||
},
|
||||
{
|
||||
id: 'UC004',
|
||||
category: ThreatCategory.UNICODE_STEGANOGRAPHY,
|
||||
severity: Severity.HIGH,
|
||||
patterns: [/[\u{E0001}-\u{E007F}]/u],
|
||||
description: 'Tag characters detected: Unicode tag block can encode hidden payloads',
|
||||
remediation: 'Remove Unicode tag characters (U+E0001-U+E007F).',
|
||||
},
|
||||
{
|
||||
id: 'UC005',
|
||||
category: ThreatCategory.UNICODE_STEGANOGRAPHY,
|
||||
severity: Severity.MEDIUM,
|
||||
// biome-ignore lint/suspicious/noControlCharactersInRegex: intentional detection of control characters
|
||||
patterns: [/[\u0000-\u0008\u000B\u000C\u000E-\u001F\u007F-\u009F]/],
|
||||
description: 'Control characters detected: non-printable characters in content',
|
||||
remediation: 'Remove control characters. Use only printable Unicode content.',
|
||||
},
|
||||
{
|
||||
id: 'UC006',
|
||||
category: ThreatCategory.OBFUSCATION,
|
||||
severity: Severity.MEDIUM,
|
||||
patterns: [
|
||||
/atob\s*\(\s*['"`][A-Za-z0-9+/=]{40,}['"`]\s*\)/,
|
||||
/Buffer\.from\s*\(\s*['"`][A-Za-z0-9+/=]{40,}['"`]\s*,\s*['"`]base64['"`]\s*\)/,
|
||||
/base64\.b64decode\s*\(\s*['"`][A-Za-z0-9+/=]{40,}['"`]\s*\)/,
|
||||
],
|
||||
description: 'Base64-encoded payload: long encoded string being decoded at runtime',
|
||||
remediation: 'Avoid embedding base64-encoded payloads. Use plain text or documented data formats.',
|
||||
},
|
||||
{
|
||||
id: 'UC007',
|
||||
category: ThreatCategory.OBFUSCATION,
|
||||
severity: Severity.MEDIUM,
|
||||
patterns: [
|
||||
/\\x[0-9a-fA-F]{2}(?:\\x[0-9a-fA-F]{2}){9,}/,
|
||||
/\\u[0-9a-fA-F]{4}(?:\\u[0-9a-fA-F]{4}){9,}/,
|
||||
],
|
||||
description: 'Hex/Unicode escape sequences: potential obfuscated content',
|
||||
remediation: 'Use readable strings instead of hex or unicode escape sequences.',
|
||||
},
|
||||
];
|
||||
@@ -0,0 +1,131 @@
|
||||
import { readdir } from 'node:fs/promises';
|
||||
import { join, basename } from 'node:path';
|
||||
import type { Analyzer } from './analyzers/base.js';
|
||||
import { StaticAnalyzer } from './analyzers/static.js';
|
||||
import { ManifestAnalyzer } from './analyzers/manifest.js';
|
||||
import { SecretsAnalyzer } from './analyzers/secrets.js';
|
||||
import type { Finding, ScanResult, ScanOptions } from './types.js';
|
||||
import { Severity } from './types.js';
|
||||
|
||||
const SEVERITY_ORDER: Record<string, number> = {
|
||||
[Severity.CRITICAL]: 5,
|
||||
[Severity.HIGH]: 4,
|
||||
[Severity.MEDIUM]: 3,
|
||||
[Severity.LOW]: 2,
|
||||
[Severity.INFO]: 1,
|
||||
[Severity.SAFE]: 0,
|
||||
};
|
||||
|
||||
async function discoverFiles(dirPath: string): Promise<string[]> {
|
||||
const files: string[] = [];
|
||||
|
||||
async function walk(dir: string): Promise<void> {
|
||||
let entries;
|
||||
try {
|
||||
entries = await readdir(dir, { withFileTypes: true });
|
||||
} catch {
|
||||
return;
|
||||
}
|
||||
|
||||
for (const entry of entries) {
|
||||
const fullPath = join(dir, entry.name);
|
||||
if (entry.name.startsWith('.') && entry.name !== '.env' && !entry.name.startsWith('.env.')) continue;
|
||||
if (entry.name === 'node_modules') continue;
|
||||
|
||||
if (entry.isDirectory()) {
|
||||
await walk(fullPath);
|
||||
} else if (entry.isFile()) {
|
||||
files.push(fullPath);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
await walk(dirPath);
|
||||
return files;
|
||||
}
|
||||
|
||||
function deduplicateFindings(findings: Finding[]): Finding[] {
|
||||
const seen = new Set<string>();
|
||||
return findings.filter((f) => {
|
||||
const key = `${f.ruleId}:${f.filePath ?? ''}:${f.lineNumber ?? ''}`;
|
||||
if (seen.has(key)) return false;
|
||||
seen.add(key);
|
||||
return true;
|
||||
});
|
||||
}
|
||||
|
||||
function calculateVerdict(
|
||||
findings: Finding[],
|
||||
failOnSeverity: Severity = Severity.HIGH
|
||||
): 'pass' | 'warn' | 'fail' {
|
||||
const threshold = SEVERITY_ORDER[failOnSeverity] ?? SEVERITY_ORDER[Severity.HIGH];
|
||||
|
||||
for (const f of findings) {
|
||||
if ((SEVERITY_ORDER[f.severity] ?? 0) >= threshold) {
|
||||
return 'fail';
|
||||
}
|
||||
}
|
||||
|
||||
if (findings.some((f) => (SEVERITY_ORDER[f.severity] ?? 0) >= SEVERITY_ORDER[Severity.MEDIUM])) {
|
||||
return 'warn';
|
||||
}
|
||||
|
||||
return 'pass';
|
||||
}
|
||||
|
||||
function countStats(findings: Finding[]): ScanResult['stats'] {
|
||||
const stats = { critical: 0, high: 0, medium: 0, low: 0, info: 0 };
|
||||
for (const f of findings) {
|
||||
switch (f.severity) {
|
||||
case Severity.CRITICAL: stats.critical++; break;
|
||||
case Severity.HIGH: stats.high++; break;
|
||||
case Severity.MEDIUM: stats.medium++; break;
|
||||
case Severity.LOW: stats.low++; break;
|
||||
case Severity.INFO: stats.info++; break;
|
||||
}
|
||||
}
|
||||
return stats;
|
||||
}
|
||||
|
||||
export class SkillScanner {
|
||||
private analyzers: Analyzer[];
|
||||
private options: ScanOptions;
|
||||
|
||||
constructor(options?: ScanOptions) {
|
||||
this.options = options ?? {};
|
||||
this.analyzers = [
|
||||
new StaticAnalyzer(this.options.skipRules),
|
||||
new ManifestAnalyzer(this.options.skipRules),
|
||||
new SecretsAnalyzer(this.options.skipRules),
|
||||
];
|
||||
}
|
||||
|
||||
async scan(skillPath: string): Promise<ScanResult> {
|
||||
const start = performance.now();
|
||||
|
||||
const files = await discoverFiles(skillPath);
|
||||
const skillName = basename(skillPath.replace(/\/+$/, '')) || 'unknown';
|
||||
|
||||
const resultSets = await Promise.all(
|
||||
this.analyzers.map((a) => a.analyze(skillPath, files))
|
||||
);
|
||||
|
||||
const allFindings = deduplicateFindings(resultSets.flat());
|
||||
|
||||
allFindings.sort(
|
||||
(a, b) => (SEVERITY_ORDER[b.severity] ?? 0) - (SEVERITY_ORDER[a.severity] ?? 0)
|
||||
);
|
||||
|
||||
const duration = Math.round(performance.now() - start);
|
||||
|
||||
return {
|
||||
skillPath,
|
||||
skillName,
|
||||
verdict: calculateVerdict(allFindings, this.options.failOnSeverity),
|
||||
findings: allFindings,
|
||||
stats: countStats(allFindings),
|
||||
duration,
|
||||
analyzersUsed: this.analyzers.map((a) => a.name),
|
||||
};
|
||||
}
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user