Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
fcff9c5e7d | ||
|
|
b28a2801b2 | ||
|
|
2c05d08027 | ||
|
|
51b62d1cce | ||
|
|
a8df5a25d1 | ||
|
|
616b268ad4 | ||
|
|
f7803183bf | ||
|
|
2441f0d275 | ||
|
|
a546b04953 | ||
|
|
6d290171b7 | ||
|
|
a994726952 | ||
|
|
1ee5258447 | ||
|
|
db38c9059d | ||
|
|
988a49f38f | ||
|
|
19694dcaa1 | ||
|
|
b432400b5a | ||
|
|
e5f0d6d450 | ||
|
|
e569046776 | ||
|
|
5bd7ebf607 | ||
|
|
549a21ad84 | ||
|
|
109f00cd95 | ||
|
|
e3d7e0e28f | ||
|
|
6cbbdabf59 | ||
|
|
c1c179217d | ||
|
|
de4425f440 | ||
|
|
8121c2bbac | ||
|
|
3565daa7f1 | ||
|
|
8496e3c63c | ||
|
|
847af0f7ab | ||
|
|
34e8cd0b61 | ||
|
|
cbd9fcd679 | ||
|
|
f9e31fedc8 | ||
|
|
12ed10d170 | ||
|
|
eebaa710f7 | ||
|
|
eae5accf36 | ||
|
|
e41b0cd8a3 | ||
|
|
21df323134 | ||
|
|
363d28e266 | ||
|
|
a229c384b0 | ||
|
|
3e9a3cd84c | ||
|
|
d0b5151683 | ||
|
|
e22193f823 | ||
|
|
fdae2aee86 | ||
|
|
3067cbdb5b | ||
|
|
ae78e2e373 | ||
|
|
4257e8555b | ||
|
|
54cef27bfe | ||
|
|
1220880462 | ||
|
|
1c946dde06 | ||
|
|
3dfd317867 | ||
|
|
c5aa303043 | ||
|
|
01d816c72a | ||
|
|
f357c73e97 | ||
|
|
40e685fabe | ||
|
|
6099c0ad6c | ||
|
|
6445d72c80 | ||
|
|
6d704a47b9 | ||
|
|
dd1c675e15 | ||
|
|
def3b01524 | ||
|
|
b1d1ea3d24 | ||
|
|
7644de462a | ||
|
|
a0b34e076e | ||
|
|
0a16de05c9 | ||
|
|
750a6f206a | ||
|
|
f73e043e87 | ||
|
|
5dac9f0543 | ||
|
|
e38d132506 | ||
|
|
ff52654549 | ||
|
|
dced3cecf3 | ||
|
|
7cedc53d68 | ||
|
|
d4ad9096b7 | ||
|
|
da434ccec1 | ||
|
|
14c319e90e | ||
|
|
2d2e8aaace | ||
|
|
d1fcf0355f | ||
|
|
b3f561dbc9 | ||
|
|
0a59bcf314 | ||
|
|
b9a724012a | ||
|
|
02989b4021 | ||
|
|
b559a2acbf | ||
|
|
5cf9178a9f | ||
|
|
279bc1cd06 | ||
|
|
7092e9a0b8 | ||
|
|
8a0e1f586e | ||
|
|
235130c6ae | ||
|
|
da5a17960d | ||
|
|
fceb23843d | ||
|
|
91ef4b63f4 | ||
|
|
7aa566d9b5 | ||
|
|
803ff5692a | ||
|
|
f036104c6d | ||
|
|
257fe9fbb6 | ||
|
|
a5efe29a6c | ||
|
|
6916c09962 | ||
|
|
41da423306 | ||
|
|
c5e78b7f83 | ||
|
|
438bc2720a | ||
|
|
85d9eee7e9 | ||
|
|
d14b57c651 | ||
|
|
4a6003ec46 | ||
|
|
6d36a4a3f7 | ||
|
|
0c5eb93891 | ||
|
|
2432410f79 | ||
|
|
4e3e2b3145 | ||
|
|
82e4a2ae62 | ||
|
|
ff5b3f7b4b | ||
|
|
15134cebbb | ||
|
|
6d01413a68 | ||
|
|
a9d6727ca5 | ||
|
|
2078be9eb4 | ||
|
|
44da0f8592 | ||
|
|
4089e5a0be | ||
|
|
c564d32ea9 | ||
|
|
4f65aecbc9 | ||
|
|
c1ba42d616 | ||
|
|
c8172097be | ||
|
|
80e41e517c | ||
|
|
26ea7e9002 | ||
|
|
1b5722a8c0 | ||
|
|
0210556634 | ||
|
|
570ae26cd5 | ||
|
|
413519d486 | ||
|
|
eadbaff07e | ||
|
|
10e8c389e3 | ||
|
|
94c77707c4 | ||
|
|
821fd1b495 | ||
|
|
288427d9b3 | ||
|
|
131bc122be | ||
|
|
e35cd0d0df | ||
|
|
287dfeac58 | ||
|
|
32914cb8dc | ||
|
|
04c4faff6a | ||
|
|
d8a6b4a700 | ||
|
|
0518ed40a3 | ||
|
|
91e7ab3450 | ||
|
|
d62fe0b761 | ||
|
|
1344d65b3d | ||
|
|
9688959361 | ||
|
|
7805a5fd4b | ||
|
|
b34177ca85 | ||
|
|
2fa62e6863 | ||
|
|
64b802a1e6 | ||
|
|
d3ffb79512 | ||
|
|
b008a46b8d | ||
|
|
ed90080786 | ||
|
|
b701bb5f47 | ||
|
|
1c4c9a794f | ||
|
|
cb37ebeca7 | ||
|
|
7053d1a2b2 | ||
|
|
1ea5ddd4c7 | ||
|
|
720532c020 | ||
|
|
bc12775e0e | ||
|
|
cd64f7f7d0 | ||
|
|
ca9af70f10 | ||
|
|
160d2b1534 | ||
|
|
4a632e9262 |
@@ -0,0 +1,42 @@
|
||||
---
|
||||
name: Add Skill Source
|
||||
about: Submit your skill repository to be included in SkillKit
|
||||
title: "[Source] Add <repository-name>"
|
||||
labels: skill-source, enhancement
|
||||
assignees: rohitg00
|
||||
---
|
||||
|
||||
## Repository Information
|
||||
|
||||
**Repository URL:** `https://github.com/<owner>/<repo>`
|
||||
|
||||
**Repository Name:**
|
||||
<!-- Short name for display (e.g., "Anthropic Official", "React Patterns") -->
|
||||
|
||||
**Description:**
|
||||
<!-- Brief description of the skills in your repository -->
|
||||
|
||||
**License:**
|
||||
<!-- MIT, Apache 2.0, etc. -->
|
||||
|
||||
## Skill Details
|
||||
|
||||
**Approximate skill count:**
|
||||
<!-- How many skills does your repository contain? -->
|
||||
|
||||
**Categories/Tags:**
|
||||
<!-- What categories do your skills cover? e.g., react, typescript, security, testing -->
|
||||
|
||||
**Target AI Agents:**
|
||||
<!-- Which agents are your skills designed for? e.g., Claude Code, Cursor, all -->
|
||||
|
||||
## Checklist
|
||||
|
||||
- [ ] Repository is public
|
||||
- [ ] Repository contains valid SKILL.md files
|
||||
- [ ] Repository has a clear license
|
||||
- [ ] Skills follow the [Agent Skills specification](https://agenstskills.com)
|
||||
|
||||
## Additional Context
|
||||
|
||||
<!-- Any other information about your repository -->
|
||||
@@ -0,0 +1,89 @@
|
||||
name: Skill Submission
|
||||
description: Submit a new skill to the SkillKit marketplace
|
||||
title: "[Skill Submission] "
|
||||
labels: ["skill-submission"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
## Submit Your Skill to SkillKit Marketplace
|
||||
|
||||
Thanks for contributing! Please fill out the details below.
|
||||
|
||||
**Tip:** You can also use our [web form](https://rohitg00.github.io/skillkit/) to submit skills.
|
||||
|
||||
- type: input
|
||||
id: skill-name
|
||||
attributes:
|
||||
label: Skill Name
|
||||
description: A descriptive name for your skill
|
||||
placeholder: e.g., React Best Practices
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Description
|
||||
description: What does this skill teach AI agents?
|
||||
placeholder: A brief description of your skill...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: repo-owner
|
||||
attributes:
|
||||
label: GitHub Owner
|
||||
description: The owner of the repository (username or organization)
|
||||
placeholder: e.g., your-username
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: repo-name
|
||||
attributes:
|
||||
label: Repository Name
|
||||
description: The name of the repository containing the skill
|
||||
placeholder: e.g., my-agent-skills
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: skill-path
|
||||
attributes:
|
||||
label: Skill Path
|
||||
description: Path to SKILL.md in the repository
|
||||
placeholder: skills/my-skill/SKILL.md
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: tags
|
||||
attributes:
|
||||
label: Tags
|
||||
description: Comma-separated tags for categorization
|
||||
placeholder: react, typescript, frontend
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: author-github
|
||||
attributes:
|
||||
label: Author GitHub Username
|
||||
description: Your GitHub username
|
||||
placeholder: your-username
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: checkboxes
|
||||
id: checklist
|
||||
attributes:
|
||||
label: Checklist
|
||||
description: Please confirm the following
|
||||
options:
|
||||
- label: Repository is public
|
||||
required: true
|
||||
- label: SKILL.md follows the agenstskills.com standard format
|
||||
required: true
|
||||
- label: Skill has been tested with at least one AI agent
|
||||
required: false
|
||||
@@ -7,6 +7,61 @@ on:
|
||||
branches: [main]
|
||||
|
||||
jobs:
|
||||
# Verify all packages have consistent versions
|
||||
version-check:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Check version consistency
|
||||
run: |
|
||||
echo "Checking version consistency across all packages..."
|
||||
|
||||
# Get the main version from apps/skillkit
|
||||
MAIN_VERSION=$(node -p "require('./apps/skillkit/package.json').version")
|
||||
echo "Main version: $MAIN_VERSION"
|
||||
|
||||
# List of all packages to check
|
||||
PACKAGES=(
|
||||
"package.json"
|
||||
"apps/skillkit/package.json"
|
||||
"packages/cli/package.json"
|
||||
"packages/core/package.json"
|
||||
"packages/tui/package.json"
|
||||
"packages/agents/package.json"
|
||||
"packages/memory/package.json"
|
||||
"packages/mesh/package.json"
|
||||
"packages/messaging/package.json"
|
||||
"packages/mcp-memory/package.json"
|
||||
"packages/resources/package.json"
|
||||
"docs/skillkit/package.json"
|
||||
"docs/fumadocs/package.json"
|
||||
)
|
||||
|
||||
FAILED=0
|
||||
for pkg in "${PACKAGES[@]}"; do
|
||||
if [ -f "$pkg" ]; then
|
||||
PKG_VERSION=$(node -p "require('./$pkg').version")
|
||||
if [ "$PKG_VERSION" != "$MAIN_VERSION" ]; then
|
||||
echo "❌ Version mismatch: $pkg has $PKG_VERSION (expected $MAIN_VERSION)"
|
||||
FAILED=1
|
||||
else
|
||||
echo "✓ $pkg: $PKG_VERSION"
|
||||
fi
|
||||
fi
|
||||
done
|
||||
|
||||
if [ $FAILED -eq 1 ]; then
|
||||
echo ""
|
||||
echo "Version mismatch detected!"
|
||||
echo "Run: ./scripts/bump-version.sh $MAIN_VERSION"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo ""
|
||||
echo "All packages have consistent version: $MAIN_VERSION"
|
||||
|
||||
# Unit tests run on all Node versions
|
||||
test:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
@@ -17,20 +72,75 @@ jobs:
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Install pnpm
|
||||
uses: pnpm/action-setup@v4
|
||||
|
||||
- name: Use Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: ${{ matrix.node-version }}
|
||||
cache: 'npm'
|
||||
cache: 'pnpm'
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
run: pnpm install --frozen-lockfile
|
||||
|
||||
- name: Type check
|
||||
run: npm run typecheck
|
||||
run: pnpm typecheck
|
||||
|
||||
- name: Build
|
||||
run: npm run build
|
||||
run: pnpm build
|
||||
|
||||
- name: Test
|
||||
run: npm test
|
||||
- name: Unit Tests
|
||||
run: pnpm test
|
||||
|
||||
# E2E tests run on latest Node only (to save CI time)
|
||||
e2e:
|
||||
runs-on: ubuntu-latest
|
||||
needs: test # Run after unit tests pass
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Install pnpm
|
||||
uses: pnpm/action-setup@v4
|
||||
|
||||
- name: Use Node.js 22
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 22
|
||||
cache: 'pnpm'
|
||||
|
||||
- name: Install dependencies
|
||||
run: pnpm install --frozen-lockfile
|
||||
|
||||
- name: Build
|
||||
run: pnpm build
|
||||
|
||||
- name: E2E Tests
|
||||
run: pnpm test:e2e
|
||||
|
||||
- name: Upload E2E Test Results
|
||||
if: failure()
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: e2e-test-results
|
||||
path: |
|
||||
e2e/**/*.log
|
||||
/tmp/skillkit-e2e-*
|
||||
retention-days: 7
|
||||
|
||||
# Final status check for branch protection
|
||||
ci-success:
|
||||
runs-on: ubuntu-latest
|
||||
needs: [version-check, test, e2e]
|
||||
if: always()
|
||||
steps:
|
||||
- name: Check all jobs passed
|
||||
run: |
|
||||
if [[ "${{ needs.version-check.result }}" != "success" ]] || \
|
||||
[[ "${{ needs.test.result }}" != "success" ]] || \
|
||||
[[ "${{ needs.e2e.result }}" != "success" ]]; then
|
||||
echo "One or more jobs failed"
|
||||
exit 1
|
||||
fi
|
||||
echo "All CI checks passed!"
|
||||
|
||||
@@ -0,0 +1,180 @@
|
||||
name: Process Skill Submission
|
||||
|
||||
on:
|
||||
issues:
|
||||
types: [labeled]
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
issues: write
|
||||
|
||||
concurrency:
|
||||
group: process-submission-${{ github.event.issue.number }}
|
||||
cancel-in-progress: false
|
||||
|
||||
jobs:
|
||||
process-submission:
|
||||
if: github.event.label.name == 'approved'
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: '20'
|
||||
|
||||
- name: Parse Issue and Update skills.json
|
||||
uses: actions/github-script@v7
|
||||
with:
|
||||
script: |
|
||||
const fs = require('fs');
|
||||
|
||||
const issue = context.payload.issue;
|
||||
const body = issue.body;
|
||||
|
||||
// Parse issue body for skill details
|
||||
const parseField = (label) => {
|
||||
const regex = new RegExp(`\\*\\*${label}:\\*\\*\\s*(.+?)(?:\\n|$)`, 'i');
|
||||
const match = body.match(regex);
|
||||
return match ? match[1].trim() : '';
|
||||
};
|
||||
|
||||
const parseCheckbox = (text) => {
|
||||
const regex = new RegExp(`- \\[(x|X)\\]\\s*${text}`, 'i');
|
||||
return regex.test(body);
|
||||
};
|
||||
|
||||
// Extract fields from form-based issue
|
||||
let skillName, description, repoOwner, repoName, skillPath, tags, authorGithub;
|
||||
|
||||
if (body.includes('### Skill Name')) {
|
||||
// YAML form format
|
||||
const sections = body.split('###').filter(s => s.trim());
|
||||
for (const section of sections) {
|
||||
const lines = section.trim().split('\n');
|
||||
const header = lines[0].trim().toLowerCase();
|
||||
const value = lines.slice(1).join('\n').trim();
|
||||
|
||||
if (header.includes('skill name')) skillName = value;
|
||||
if (header.includes('description')) description = value;
|
||||
if (header.includes('github owner')) repoOwner = value;
|
||||
if (header.includes('repository name')) repoName = value;
|
||||
if (header.includes('skill path')) skillPath = value;
|
||||
if (header.includes('tags')) tags = value;
|
||||
if (header.includes('author github')) authorGithub = value;
|
||||
}
|
||||
} else {
|
||||
// Markdown format from web form
|
||||
skillName = parseField('Name');
|
||||
description = parseField('Description');
|
||||
repoOwner = parseField('Owner');
|
||||
repoName = parseField('Repo');
|
||||
skillPath = parseField('Skill Path');
|
||||
tags = parseField('Tags');
|
||||
const authorField = parseField('Author') || '';
|
||||
authorGithub = authorField.replace(/^@/, '').trim();
|
||||
}
|
||||
|
||||
if (!skillName || !repoOwner || !repoName) {
|
||||
console.log('Missing required fields');
|
||||
await github.rest.issues.createComment({
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
issue_number: issue.number,
|
||||
body: '❌ Could not parse skill details. Missing required fields (name, owner, or repo).'
|
||||
});
|
||||
return;
|
||||
}
|
||||
|
||||
// Generate skill ID
|
||||
const skillSlug = skillName.toLowerCase().replace(/\s+/g, '-').replace(/[^a-z0-9-]/g, '');
|
||||
const skillId = `${repoOwner}/${repoName}/${skillSlug}`;
|
||||
|
||||
// Read current skills.json
|
||||
const skillsPath = 'marketplace/skills.json';
|
||||
const skillsData = JSON.parse(fs.readFileSync(skillsPath, 'utf-8'));
|
||||
|
||||
// Check for duplicates
|
||||
if (skillsData.skills.some(s => s.id === skillId)) {
|
||||
await github.rest.issues.createComment({
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
issue_number: issue.number,
|
||||
body: `⚠️ Skill with ID \`${skillId}\` already exists in the marketplace.`
|
||||
});
|
||||
return;
|
||||
}
|
||||
|
||||
// Parse and validate tags
|
||||
const filteredTags = tags
|
||||
? tags.split(',').map(t => t.trim().toLowerCase()).filter(t => t.length > 0)
|
||||
: [];
|
||||
|
||||
if (filteredTags.length === 0) {
|
||||
await github.rest.issues.createComment({
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
issue_number: issue.number,
|
||||
body: '❌ At least one tag is required. Please add tags to your submission.'
|
||||
});
|
||||
return;
|
||||
}
|
||||
|
||||
// Add new skill
|
||||
const newSkill = {
|
||||
id: skillId,
|
||||
name: skillName,
|
||||
description: description || '',
|
||||
source: `${repoOwner}/${repoName}`,
|
||||
tags: filteredTags,
|
||||
author: authorGithub
|
||||
};
|
||||
|
||||
skillsData.skills.push(newSkill);
|
||||
skillsData.updatedAt = new Date().toISOString().split('T')[0];
|
||||
|
||||
// Write updated skills.json
|
||||
fs.writeFileSync(skillsPath, JSON.stringify(skillsData, null, 2) + '\n');
|
||||
|
||||
// Also update docs copy
|
||||
const docsCopyPath = 'docs/skillkit/data/skills.json';
|
||||
fs.writeFileSync(docsCopyPath, JSON.stringify(skillsData, null, 2) + '\n');
|
||||
|
||||
// Also update core copy
|
||||
const coreCopyPath = 'packages/core/src/marketplace/data/skills.json';
|
||||
fs.writeFileSync(coreCopyPath, JSON.stringify(skillsData, null, 2) + '\n');
|
||||
|
||||
console.log(`Added skill: ${skillId}`);
|
||||
|
||||
// Set output for commit
|
||||
core.setOutput('skill_name', skillName);
|
||||
core.setOutput('skill_id', skillId);
|
||||
|
||||
- name: Commit Changes
|
||||
run: |
|
||||
git config --local user.email "github-actions[bot]@users.noreply.github.com"
|
||||
git config --local user.name "github-actions[bot]"
|
||||
git add marketplace/skills.json docs/skillkit/data/skills.json packages/core/src/marketplace/data/skills.json
|
||||
git commit -m "feat(marketplace): add skill from #${{ github.event.issue.number }}"
|
||||
git push
|
||||
|
||||
- name: Close Issue with Comment
|
||||
uses: actions/github-script@v7
|
||||
with:
|
||||
script: |
|
||||
await github.rest.issues.createComment({
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
issue_number: context.payload.issue.number,
|
||||
body: `✅ **Skill added to marketplace!**\n\nYour skill has been added and will be available in the next release.\n\nThank you for contributing to SkillKit! 🎉`
|
||||
});
|
||||
|
||||
await github.rest.issues.update({
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
issue_number: context.payload.issue.number,
|
||||
state: 'closed'
|
||||
});
|
||||
@@ -1,4 +1,4 @@
|
||||
name: Publish to npm
|
||||
name: Publish to npm and GitHub Packages
|
||||
|
||||
on:
|
||||
push:
|
||||
@@ -6,7 +6,7 @@ on:
|
||||
- 'v*'
|
||||
|
||||
jobs:
|
||||
publish:
|
||||
publish-npm:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
permissions:
|
||||
@@ -16,24 +16,40 @@ jobs:
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Verify tag matches package version
|
||||
run: |
|
||||
TAG_VERSION="${GITHUB_REF#refs/tags/v}"
|
||||
PKG_VERSION=$(node -p "require('./apps/skillkit/package.json').version")
|
||||
echo "Tag version: $TAG_VERSION"
|
||||
echo "Package version: $PKG_VERSION"
|
||||
if [ "$TAG_VERSION" != "$PKG_VERSION" ]; then
|
||||
echo "❌ Tag version ($TAG_VERSION) doesn't match package version ($PKG_VERSION)"
|
||||
echo "Please update package versions before creating the release tag."
|
||||
exit 1
|
||||
fi
|
||||
echo "✓ Version check passed"
|
||||
|
||||
- name: Install pnpm
|
||||
uses: pnpm/action-setup@v4
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: '20'
|
||||
cache: 'npm'
|
||||
cache: 'pnpm'
|
||||
registry-url: 'https://registry.npmjs.org'
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
run: pnpm install --frozen-lockfile
|
||||
|
||||
- name: Build
|
||||
run: npm run build
|
||||
run: pnpm build
|
||||
|
||||
- name: Test
|
||||
run: npm test
|
||||
run: pnpm test
|
||||
|
||||
- name: Publish to npm
|
||||
run: npm publish --provenance --access public
|
||||
- name: Publish packages to npm
|
||||
run: pnpm -r publish --access public --no-git-checks
|
||||
env:
|
||||
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
||||
|
||||
@@ -41,3 +57,64 @@ jobs:
|
||||
uses: softprops/action-gh-release@v1
|
||||
with:
|
||||
generate_release_notes: true
|
||||
|
||||
publish-github-packages:
|
||||
runs-on: ubuntu-latest
|
||||
needs: publish-npm
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
packages: write
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Install pnpm
|
||||
uses: pnpm/action-setup@v4
|
||||
|
||||
- name: Setup Node.js for GitHub Packages
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: '20'
|
||||
cache: 'pnpm'
|
||||
registry-url: 'https://npm.pkg.github.com'
|
||||
scope: '@rohitg00'
|
||||
|
||||
- name: Install dependencies
|
||||
run: pnpm install --frozen-lockfile
|
||||
|
||||
- name: Build
|
||||
run: pnpm build
|
||||
|
||||
- name: Configure npm for GitHub Packages
|
||||
run: |
|
||||
echo "@rohitg00:registry=https://npm.pkg.github.com" >> .npmrc
|
||||
echo "//npm.pkg.github.com/:_authToken=${{ secrets.GITHUB_TOKEN }}" >> .npmrc
|
||||
|
||||
- name: Publish main skillkit package to GitHub Packages
|
||||
working-directory: apps/skillkit
|
||||
run: |
|
||||
# Create a temporary package.json with GitHub Packages scope and resolved dependencies
|
||||
node -e "
|
||||
const fs = require('fs');
|
||||
const path = require('path');
|
||||
const pkg = require('./package.json');
|
||||
|
||||
pkg.name = '@rohitg00/skillkit';
|
||||
pkg.publishConfig = { registry: 'https://npm.pkg.github.com' };
|
||||
|
||||
// Resolve workspace:* dependencies to actual versions
|
||||
for (const [dep, version] of Object.entries(pkg.dependencies || {})) {
|
||||
if (version.startsWith('workspace:')) {
|
||||
const depName = dep.replace('@skillkit/', '');
|
||||
const depPkgPath = path.join('..', '..', 'packages', depName, 'package.json');
|
||||
const depPkg = JSON.parse(fs.readFileSync(depPkgPath, 'utf8'));
|
||||
pkg.dependencies[dep] = depPkg.version;
|
||||
}
|
||||
}
|
||||
|
||||
fs.writeFileSync('package.json', JSON.stringify(pkg, null, 2));
|
||||
"
|
||||
npm publish
|
||||
env:
|
||||
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
@@ -29,7 +29,6 @@ npm-debug.log*
|
||||
|
||||
# Package manager
|
||||
yarn.lock
|
||||
pnpm-lock.yaml
|
||||
|
||||
# Temporary files
|
||||
tmp/
|
||||
@@ -56,4 +55,13 @@ temp/
|
||||
.agent/
|
||||
|
||||
# SkillKit config
|
||||
skillkit.yaml
|
||||
skillkit.yaml
|
||||
.skillkit/
|
||||
|
||||
# Turbo cache
|
||||
.turbo/
|
||||
|
||||
# Project documentation (not for version control)
|
||||
CLAUDE.md
|
||||
prd.md
|
||||
.vercel
|
||||
|
||||
@@ -0,0 +1,305 @@
|
||||
# Contributing to SkillKit
|
||||
|
||||
Thank you for your interest in contributing to SkillKit! This document provides guidelines and instructions for contributing.
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
By participating in this project, you agree to maintain a respectful and inclusive environment for everyone.
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Node.js 18+
|
||||
- pnpm 8+ (recommended) or npm/yarn
|
||||
- Git
|
||||
|
||||
### Setting Up the Development Environment
|
||||
|
||||
1. **Fork the repository**
|
||||
|
||||
Click the "Fork" button on GitHub to create your own copy.
|
||||
|
||||
2. **Clone your fork**
|
||||
|
||||
```bash
|
||||
git clone https://github.com/YOUR_USERNAME/skillkit.git
|
||||
cd skillkit
|
||||
```
|
||||
|
||||
3. **Install dependencies**
|
||||
|
||||
```bash
|
||||
pnpm install
|
||||
```
|
||||
|
||||
4. **Build the project**
|
||||
|
||||
```bash
|
||||
pnpm build
|
||||
```
|
||||
|
||||
5. **Run tests**
|
||||
|
||||
```bash
|
||||
pnpm test
|
||||
```
|
||||
|
||||
6. **Link for local development**
|
||||
|
||||
```bash
|
||||
cd apps/skillkit
|
||||
pnpm link --global
|
||||
```
|
||||
|
||||
Now you can use `skillkit` command globally to test your changes.
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
skillkit/
|
||||
├── apps/
|
||||
│ └── skillkit/ # Main CLI entry point
|
||||
├── packages/
|
||||
│ ├── core/ # @skillkit/core - Shared logic
|
||||
│ │ ├── discovery/ # Skill discovery
|
||||
│ │ ├── parser/ # SKILL.md parsing
|
||||
│ │ ├── translator/ # Cross-agent translation
|
||||
│ │ ├── context/ # Project context sync
|
||||
│ │ └── recommend/ # Recommendation engine
|
||||
│ ├── cli/ # @skillkit/cli - Commands
|
||||
│ ├── tui/ # @skillkit/tui - Terminal UI
|
||||
│ └── agents/ # @skillkit/agents - Agent adapters
|
||||
├── docs/ # Documentation
|
||||
└── README.md
|
||||
```
|
||||
|
||||
## Development Workflow
|
||||
|
||||
### Branch Naming
|
||||
|
||||
Use descriptive branch names:
|
||||
|
||||
- `feature/skill-translation` - New features
|
||||
- `fix/cursor-adapter-path` - Bug fixes
|
||||
- `docs/api-reference` - Documentation
|
||||
- `refactor/core-types` - Code refactoring
|
||||
|
||||
### Making Changes
|
||||
|
||||
1. **Create a new branch**
|
||||
|
||||
```bash
|
||||
git checkout -b feature/your-feature-name
|
||||
```
|
||||
|
||||
2. **Make your changes**
|
||||
|
||||
- Follow the existing code style
|
||||
- Add tests for new functionality
|
||||
- Update documentation as needed
|
||||
|
||||
3. **Run checks locally**
|
||||
|
||||
```bash
|
||||
# Build all packages
|
||||
pnpm build
|
||||
|
||||
# Run tests
|
||||
pnpm test
|
||||
|
||||
# Type check
|
||||
pnpm typecheck
|
||||
|
||||
# Lint (if configured)
|
||||
pnpm lint
|
||||
```
|
||||
|
||||
4. **Commit your changes**
|
||||
|
||||
Write clear, descriptive commit messages:
|
||||
|
||||
```bash
|
||||
git commit -m "feat: add skill translation for Windsurf agent"
|
||||
git commit -m "fix: resolve path resolution in Windows"
|
||||
git commit -m "docs: add API reference for RecommendationEngine"
|
||||
```
|
||||
|
||||
We follow [Conventional Commits](https://www.conventionalcommits.org/):
|
||||
- `feat:` - New features
|
||||
- `fix:` - Bug fixes
|
||||
- `docs:` - Documentation changes
|
||||
- `refactor:` - Code refactoring
|
||||
- `test:` - Adding or updating tests
|
||||
- `chore:` - Maintenance tasks
|
||||
|
||||
5. **Push your branch**
|
||||
|
||||
```bash
|
||||
git push origin feature/your-feature-name
|
||||
```
|
||||
|
||||
6. **Open a Pull Request**
|
||||
|
||||
- Provide a clear description of the changes
|
||||
- Reference any related issues
|
||||
- Ensure CI checks pass
|
||||
|
||||
## Types of Contributions
|
||||
|
||||
### Bug Reports
|
||||
|
||||
When reporting bugs, please include:
|
||||
|
||||
- SkillKit version (`skillkit --version`)
|
||||
- Node.js version (`node --version`)
|
||||
- Operating system
|
||||
- Steps to reproduce
|
||||
- Expected vs actual behavior
|
||||
- Relevant error messages or logs
|
||||
|
||||
### Feature Requests
|
||||
|
||||
For feature requests, please describe:
|
||||
|
||||
- The problem you're trying to solve
|
||||
- Your proposed solution
|
||||
- Alternative approaches you've considered
|
||||
- Any relevant examples or mockups
|
||||
|
||||
### Adding New Agent Support
|
||||
|
||||
To add support for a new AI coding agent:
|
||||
|
||||
1. **Create an adapter** in `packages/agents/src/adapters/`
|
||||
|
||||
```typescript
|
||||
// packages/agents/src/adapters/new-agent.ts
|
||||
import type { AgentAdapter, Skill } from '../types.js';
|
||||
|
||||
export const newAgentAdapter: AgentAdapter = {
|
||||
type: 'new-agent',
|
||||
name: 'New Agent',
|
||||
configFile: 'AGENTS.md',
|
||||
skillsDir: '.new-agent/skills/',
|
||||
globalSkillsDir: '~/.new-agent/skills/',
|
||||
|
||||
generateConfig(skills: Skill[]): string {
|
||||
// Generate config content
|
||||
},
|
||||
|
||||
detectPresence(): boolean {
|
||||
// Check if agent is present
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
2. **Register the adapter** in `packages/agents/src/adapters/index.ts`
|
||||
|
||||
3. **Add translator support** in `packages/core/src/translator/` if the agent uses a unique format
|
||||
|
||||
4. **Add tests** for the new adapter
|
||||
|
||||
5. **Update documentation**
|
||||
|
||||
### Adding New Skills
|
||||
|
||||
If you want to contribute skills to the ecosystem:
|
||||
|
||||
1. Follow the [Agent Skills specification](https://agenstskills.com)
|
||||
2. Include a `SKILL.md` with proper frontmatter
|
||||
3. Test with multiple agents using `skillkit translate`
|
||||
4. Submit to the appropriate skill repository
|
||||
|
||||
## Code Style
|
||||
|
||||
### TypeScript
|
||||
|
||||
- Use TypeScript for all new code
|
||||
- Define explicit types for function parameters and return values
|
||||
- Use interfaces for object shapes
|
||||
- Prefer `const` over `let`
|
||||
|
||||
### File Organization
|
||||
|
||||
- One export per file when possible
|
||||
- Group related functionality in directories
|
||||
- Use `index.ts` files for clean exports
|
||||
|
||||
### Testing
|
||||
|
||||
- Write unit tests for new functionality
|
||||
- Use descriptive test names
|
||||
- Test edge cases and error conditions
|
||||
|
||||
```typescript
|
||||
describe('RecommendationEngine', () => {
|
||||
it('should score skills based on framework match', () => {
|
||||
// Test implementation
|
||||
});
|
||||
|
||||
it('should return empty array when no skills match', () => {
|
||||
// Test implementation
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
## Pull Request Guidelines
|
||||
|
||||
### Before Submitting
|
||||
|
||||
- [ ] Code builds without errors (`pnpm build`)
|
||||
- [ ] All tests pass (`pnpm test`)
|
||||
- [ ] New code has appropriate test coverage
|
||||
- [ ] Documentation is updated if needed
|
||||
- [ ] Commit messages follow conventions
|
||||
|
||||
### PR Description Template
|
||||
|
||||
```markdown
|
||||
## Summary
|
||||
|
||||
Brief description of the changes.
|
||||
|
||||
## Changes
|
||||
|
||||
- Change 1
|
||||
- Change 2
|
||||
|
||||
## Testing
|
||||
|
||||
How were these changes tested?
|
||||
|
||||
## Related Issues
|
||||
|
||||
Fixes #123
|
||||
```
|
||||
|
||||
### Review Process
|
||||
|
||||
1. A maintainer will review your PR
|
||||
2. Address any requested changes
|
||||
3. Once approved, the PR will be merged
|
||||
|
||||
## Release Process
|
||||
|
||||
Releases are managed by maintainers. The process includes:
|
||||
|
||||
1. Version bump in package.json files
|
||||
2. Changelog update
|
||||
3. Git tag creation
|
||||
4. npm publish
|
||||
|
||||
## Getting Help
|
||||
|
||||
- **GitHub Issues**: For bugs and feature requests
|
||||
- **Discussions**: For questions and ideas
|
||||
- **Documentation**: Check the README and docs/
|
||||
|
||||
## License
|
||||
|
||||
By contributing to SkillKit, you agree that your contributions will be licensed under the Apache License 2.0.
|
||||
|
||||
---
|
||||
|
||||
Thank you for contributing to SkillKit!
|
||||
@@ -1,21 +1,190 @@
|
||||
MIT License
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
Copyright (c) 2026 Rohit Ghumare
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
1. Definitions.
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to the Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
Copyright 2025 Rohit Ghumare
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
||||
@@ -1,407 +1,338 @@
|
||||
# SkillKit
|
||||
<div align="center">
|
||||
|
||||
[](https://www.npmjs.com/package/skillkit)
|
||||
[](https://www.npmjs.com/package/skillkit)
|
||||
<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%">
|
||||
</picture>
|
||||
|
||||
<br/>
|
||||
|
||||
[](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/MIT)
|
||||
[](https://opensource.org/licenses/Apache-2.0)
|
||||
[](https://agenstskills.com)
|
||||
[](https://agenstskills.com/docs)
|
||||
[](https://agenstskills.com/api)
|
||||
|
||||
Universal skills loader for AI coding agents. Install, manage, and sync skills across your favorite AI tools.
|
||||
**Write a skill once, deploy it to all 32 agents. No rewrites.**
|
||||
|
||||
Skills follow the [Agent Skills](https://agentskills.io) open format—a simple, portable standard for giving agents new capabilities and expertise.
|
||||
[Website](https://agenstskills.com) · [Docs](https://agenstskills.com/docs) · [API](https://agenstskills.com/api) · [npm](https://www.npmjs.com/package/skillkit)
|
||||
|
||||

|
||||
</div>
|
||||
|
||||
## Interactive TUI
|
||||
---
|
||||
|
||||
Manage all your skills with a beautiful terminal interface:
|
||||
Skills make AI coding agents smarter. But every agent uses a different format:
|
||||
|
||||
| Agent | Format | Directory |
|
||||
|-------|--------|-----------|
|
||||
| Claude Code | `SKILL.md` | `.claude/skills/` |
|
||||
| Cursor | `.mdc` | `.cursor/skills/` |
|
||||
| Copilot | Markdown | `.github/skills/` |
|
||||
| Windsurf | Markdown | `.windsurf/skills/` |
|
||||
|
||||
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.
|
||||
|
||||
```bash
|
||||
skillkit ui
|
||||
# or simply
|
||||
skillkit
|
||||
npx skillkit@latest
|
||||
```
|
||||
|
||||

|
||||
## See It In Action
|
||||
|
||||
**Features:**
|
||||
- Browse 33+ skill repositories
|
||||
- Install skills with one keystroke
|
||||
- Multi-agent installation support
|
||||
- View installed skills
|
||||
- Sync across agents
|
||||
- Responsive design for all terminal sizes
|
||||
<div align="center">
|
||||
|
||||
**Navigation:**
|
||||
- `h` Home | `b` Browse | `l` List | `s` Sync | `,` Config
|
||||
- `↑↓` Navigate | `Enter` Select | `Esc` Back | `q` Quit
|
||||
- `m` Multi-agent selection | `r` Refresh/Back
|
||||
[](https://raw.githubusercontent.com/rohitg00/skillkit/main/docs/video/skillkit.mp4)
|
||||
|
||||
### Compatible With
|
||||
*Click the image above to watch the full demo*
|
||||
|
||||
| Agent | Status |
|
||||
|-------|--------|
|
||||
| Claude Code | ✅ Native |
|
||||
| OpenAI Codex | ✅ Native |
|
||||
| Cursor | ✅ Native |
|
||||
| Gemini CLI | ✅ Native |
|
||||
| OpenCode | ✅ Native |
|
||||
| Antigravity | ✅ Native |
|
||||
| Amp | ✅ Native |
|
||||
| Clawdbot | ✅ Native |
|
||||
| Droid (Factory) | ✅ Native |
|
||||
| GitHub Copilot | ✅ Native |
|
||||
| Goose | ✅ Native |
|
||||
| Kilo Code | ✅ Native |
|
||||
| Kiro CLI | ✅ Native |
|
||||
| Roo Code | ✅ Native |
|
||||
| Trae | ✅ Native |
|
||||
| Windsurf | ✅ Native |
|
||||
| *Any markdown-config agent* | ✅ Universal |
|
||||
|
||||
## Features
|
||||
|
||||
- **Interactive TUI**: Beautiful terminal interface for managing skills
|
||||
- **Multi-Agent Support**: Works with 17+ AI coding agents out of the box
|
||||
- **Multi-Platform Git**: GitHub, GitLab, Bitbucket, and local paths
|
||||
- **CI/CD Friendly**: Non-interactive flags for automation (`--skills`, `--all`, `--yes`)
|
||||
- **Skill Toggle**: Enable/disable skills without removing them
|
||||
- **Type-Safe**: Built with TypeScript and Zod validation
|
||||
- **Zero Config**: Auto-detects your agent and configures appropriately
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npm install -g skillkit
|
||||
# or
|
||||
npx skillkit <command>
|
||||
```
|
||||
</div>
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Launch interactive TUI
|
||||
skillkit ui
|
||||
|
||||
# Initialize in your project (auto-detects agent)
|
||||
skillkit init
|
||||
|
||||
# Install skills from GitHub
|
||||
skillkit install owner/repo
|
||||
|
||||
# Install from GitLab
|
||||
skillkit install gitlab:owner/repo
|
||||
|
||||
# Install specific skills (CI/CD friendly)
|
||||
skillkit install owner/repo --skills=pdf,xlsx,docx
|
||||
|
||||
# Create a new skill
|
||||
skillkit create my-skill
|
||||
|
||||
# Sync skills to your agent config
|
||||
skillkit sync
|
||||
|
||||
# Read a skill (for AI consumption)
|
||||
skillkit read pdf
|
||||
npx skillkit@latest init # Detect agents, create dirs
|
||||
skillkit recommend # Get smart suggestions
|
||||
skillkit install anthropics/skills # Install from marketplace
|
||||
skillkit sync # Deploy to your agents
|
||||
```
|
||||
|
||||
## Popular Skill Repositories
|
||||
Four commands. Your agents now have skills for PDF processing, code review, and more.
|
||||
|
||||
Install skills from these community repositories:
|
||||
## What Can You Do?
|
||||
|
||||
### Install skills from anywhere
|
||||
|
||||
```bash
|
||||
# Anthropic's official skill marketplace
|
||||
skillkit install anthropics/skills
|
||||
|
||||
# Vercel's React & Next.js best practices
|
||||
skillkit install vercel-labs/agent-skills/skills
|
||||
skillkit install anthropics/skills # GitHub
|
||||
skillkit install gitlab:team/skills # GitLab
|
||||
skillkit install ./my-local-skills # Local path
|
||||
```
|
||||
|
||||
| Repository | Skills | Description |
|
||||
|------------|--------|-------------|
|
||||
| [anthropics/skills](https://github.com/anthropics/skills) | `pdf`, `xlsx`, `docx`, etc. | Official Claude Code skill marketplace |
|
||||
| [vercel-labs/agent-skills](https://github.com/vercel-labs/agent-skills) | `vercel-react-best-practices`, `web-design-guidelines` | React/Next.js optimization & UI review |
|
||||
### Translate between agents
|
||||
|
||||
Write for Claude, deploy to Cursor:
|
||||
|
||||
```bash
|
||||
skillkit translate my-skill --to cursor
|
||||
skillkit translate --all --to windsurf
|
||||
```
|
||||
|
||||
### Get smart recommendations
|
||||
|
||||
SkillKit reads your project, detects your stack, and suggests relevant skills:
|
||||
|
||||
```bash
|
||||
skillkit recommend
|
||||
# 92% vercel-react-best-practices
|
||||
# 87% tailwind-v4-patterns
|
||||
# 85% nextjs-app-router
|
||||
```
|
||||
|
||||
### Discover skills at runtime
|
||||
|
||||
Start an API server and let agents find skills on demand:
|
||||
|
||||
```bash
|
||||
skillkit serve
|
||||
# Server running at http://localhost:3737
|
||||
|
||||
curl "http://localhost:3737/search?q=react+performance"
|
||||
```
|
||||
|
||||
Or use MCP for native agent integration:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"skillkit": { "command": "npx", "args": ["@skillkit/mcp"] }
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Or use Python:
|
||||
|
||||
```bash
|
||||
pip install skillkit-client
|
||||
```
|
||||
|
||||
```python
|
||||
from skillkit import SkillKitClient
|
||||
|
||||
async with SkillKitClient() as client:
|
||||
results = await client.search("react performance", limit=5)
|
||||
```
|
||||
|
||||
[REST API docs](https://agenstskills.com/docs/rest-api) · [MCP Server docs](https://agenstskills.com/docs/mcp-server) · [Python Client docs](https://agenstskills.com/docs/python-client) · [Interactive API explorer](https://agenstskills.com/api)
|
||||
|
||||
### Auto-generate agent instructions
|
||||
|
||||
Let SkillKit analyze your codebase and create CLAUDE.md, .cursorrules, etc.:
|
||||
|
||||
```bash
|
||||
skillkit primer --all-agents
|
||||
```
|
||||
|
||||
### Session memory
|
||||
|
||||
Your AI agents learn patterns during sessions, then forget everything. SkillKit captures those learnings:
|
||||
|
||||
```bash
|
||||
skillkit memory compress
|
||||
skillkit memory search "auth patterns"
|
||||
skillkit memory export auth-patterns
|
||||
```
|
||||
|
||||
### AI skill generation
|
||||
|
||||
Generate skills from natural language with multi-source context:
|
||||
|
||||
```bash
|
||||
skillkit generate
|
||||
# Interactive wizard with 4 context sources:
|
||||
# - Documentation (via Context7)
|
||||
# - Your codebase patterns
|
||||
# - 15,000+ marketplace skills
|
||||
# - Memory (your corrections)
|
||||
```
|
||||
|
||||
Works with any LLM: Claude, GPT-4, Gemini, Ollama (local), or OpenRouter (100+ models). Generates agent-optimized variants with trust scores.
|
||||
|
||||
### Mesh network
|
||||
|
||||
Distribute agents across machines with encrypted P2P:
|
||||
|
||||
```bash
|
||||
skillkit mesh init
|
||||
skillkit mesh discover
|
||||
```
|
||||
|
||||
### Team collaboration
|
||||
|
||||
Share skills via a Git-committable `.skills` manifest:
|
||||
|
||||
```bash
|
||||
skillkit manifest init
|
||||
skillkit manifest add anthropics/skills
|
||||
git commit -m "add team skills"
|
||||
```
|
||||
|
||||
Team members run `skillkit manifest install` and they're in sync.
|
||||
|
||||
### Interactive TUI
|
||||
|
||||
```bash
|
||||
skillkit ui
|
||||
```
|
||||
|
||||
`h` Home · `m` Marketplace · `r` Recommend · `t` Translate · `i` Installed · `s` Sync · `q` Quit
|
||||
|
||||

|
||||
|
||||
## Supported Agents (32)
|
||||
|
||||
| Agent | Format | Directory |
|
||||
|-------|--------|-----------|
|
||||
| **Claude Code** | SKILL.md | `.claude/skills/` |
|
||||
| **Cursor** | .mdc | `.cursor/skills/` |
|
||||
| **Codex** | SKILL.md | `.codex/skills/` |
|
||||
| **Gemini CLI** | SKILL.md | `.gemini/skills/` |
|
||||
| **OpenCode** | SKILL.md | `.opencode/skills/` |
|
||||
| **GitHub Copilot** | Markdown | `.github/skills/` |
|
||||
| **Windsurf** | Markdown | `.windsurf/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
|
||||
|
||||
[Full agent details](https://agenstskills.com/docs/agents)
|
||||
|
||||
## Commands
|
||||
|
||||
### `skillkit ui` / `skillkit`
|
||||
|
||||
Launch the interactive Terminal User Interface (TUI) for managing skills.
|
||||
### Core
|
||||
|
||||
```bash
|
||||
skillkit ui # Explicit TUI launch
|
||||
skillkit # Launch TUI if no arguments provided
|
||||
skillkit install <source> # Install skills
|
||||
skillkit remove <skills> # Remove skills
|
||||
skillkit translate <skill> --to # Translate between agents
|
||||
skillkit sync # Deploy to agent config
|
||||
skillkit recommend # Smart recommendations
|
||||
skillkit generate # AI skill generation wizard
|
||||
skillkit serve # Start REST API server
|
||||
```
|
||||
|
||||
**TUI Features:**
|
||||
- **Browse**: Discover skills from 33+ repositories
|
||||
- **List**: View all installed skills
|
||||
- **Sync**: Sync skills across multiple agents
|
||||
- **Settings**: Configure SkillKit preferences
|
||||
|
||||
**Keyboard Shortcuts:**
|
||||
- `h` - Home screen
|
||||
- `b` - Browse skills marketplace
|
||||
- `l` - List installed skills
|
||||
- `s` - Sync skills across agents
|
||||
- `,` - Settings
|
||||
- `↑↓` - Navigate lists
|
||||
- `Enter` - Select / Install
|
||||
- `m` - Multi-agent selection (when viewing skills)
|
||||
- `r` - Refresh / Go back
|
||||
- `Esc` - Return to home
|
||||
- `q` - Quit
|
||||
|
||||
### `skillkit install <source>`
|
||||
|
||||
Install skills from various sources.
|
||||
### Discovery & Security
|
||||
|
||||
```bash
|
||||
# GitHub (default)
|
||||
skillkit install owner/repo
|
||||
skillkit install https://github.com/owner/repo
|
||||
|
||||
# Install from a subdirectory
|
||||
skillkit install owner/repo/skills
|
||||
|
||||
# GitLab
|
||||
skillkit install gitlab:owner/repo
|
||||
skillkit install https://gitlab.com/owner/repo
|
||||
|
||||
# Bitbucket
|
||||
skillkit install bitbucket:owner/repo
|
||||
|
||||
# Local path
|
||||
skillkit install ./my-skills
|
||||
skillkit install ~/dev/skills
|
||||
|
||||
# Options
|
||||
--list # List available skills without installing
|
||||
--skills=pdf,xlsx # Install specific skills only (CI/CD)
|
||||
--all # Install all discovered skills
|
||||
--yes # Skip confirmation prompts
|
||||
--global # Install to global directory
|
||||
--force # Overwrite existing skills
|
||||
--provider=gitlab # Force specific provider
|
||||
--agent=cursor # Install to specific agent (can specify multiple)
|
||||
skillkit marketplace # Browse skills
|
||||
skillkit tree # Hierarchical taxonomy
|
||||
skillkit find <query> # Quick search
|
||||
skillkit scan <path> # Security scan for skills
|
||||
```
|
||||
|
||||
### `skillkit sync`
|
||||
|
||||
Sync installed skills to your agent's config file.
|
||||
### Advanced
|
||||
|
||||
```bash
|
||||
skillkit sync
|
||||
skillkit sync --agent cursor
|
||||
skillkit sync --output AGENTS.md
|
||||
skillkit sync --enabled-only
|
||||
skillkit primer --all-agents # Generate agent instructions
|
||||
skillkit memory compress # Capture session learnings
|
||||
skillkit mesh init # Multi-machine distribution
|
||||
skillkit message send # Inter-agent messaging
|
||||
skillkit workflow run <name> # Run workflows
|
||||
skillkit test # Test skills
|
||||
skillkit cicd init # CI/CD templates
|
||||
```
|
||||
|
||||
### `skillkit read <skills>`
|
||||
|
||||
Read skill content for AI agent consumption.
|
||||
|
||||
```bash
|
||||
skillkit read pdf
|
||||
skillkit read pdf,xlsx,docx # Multiple skills
|
||||
```
|
||||
|
||||
### `skillkit list`
|
||||
|
||||
List all installed skills.
|
||||
|
||||
```bash
|
||||
skillkit list
|
||||
skillkit list --enabled
|
||||
skillkit list --json
|
||||
```
|
||||
|
||||
### `skillkit enable/disable <skills>`
|
||||
|
||||
Toggle skills on/off without removing them.
|
||||
|
||||
```bash
|
||||
skillkit enable pdf xlsx
|
||||
skillkit disable docx
|
||||
```
|
||||
|
||||
### `skillkit update [skills]`
|
||||
|
||||
Update skills from their original sources.
|
||||
|
||||
```bash
|
||||
skillkit update # Update all
|
||||
skillkit update pdf xlsx # Update specific
|
||||
```
|
||||
|
||||
### `skillkit remove <skills>`
|
||||
|
||||
Remove installed skills.
|
||||
|
||||
```bash
|
||||
skillkit remove pdf xlsx
|
||||
```
|
||||
|
||||
### `skillkit init`
|
||||
|
||||
Initialize skillkit in a project.
|
||||
|
||||
```bash
|
||||
skillkit init
|
||||
skillkit init --agent cursor
|
||||
skillkit init --list # List supported agents
|
||||
```
|
||||
|
||||
### `skillkit validate <path>`
|
||||
|
||||
Validate skills against the [Agent Skills specification](https://agentskills.io/specification).
|
||||
|
||||
```bash
|
||||
skillkit validate ./my-skill # Validate single skill
|
||||
skillkit validate ./skills --all # Validate all skills in directory
|
||||
```
|
||||
|
||||
### `skillkit create <skill-name>`
|
||||
|
||||
Create a new skill with proper structure and template.
|
||||
|
||||
```bash
|
||||
skillkit create my-skill # Basic skill
|
||||
skillkit create my-skill --full # Include all directories (references, scripts, assets)
|
||||
skillkit create my-skill --scripts # Include scripts directory
|
||||
skillkit create my-skill --references # Include references directory
|
||||
skillkit create my-skill --assets # Include assets directory
|
||||
skillkit create my-skill --dir ./skills # Create in specific directory
|
||||
```
|
||||
|
||||
## Supported Agents
|
||||
|
||||
| Agent | Config File | Project Path | Global Path |
|
||||
|-------|-------------|--------------|-------------|
|
||||
| Claude Code | `AGENTS.md` | `.claude/skills/` | `~/.claude/skills/` |
|
||||
| Cursor | `.cursorrules` | `.cursor/skills/` | `~/.cursor/skills/` |
|
||||
| Codex | `AGENTS.md` | `.codex/skills/` | `~/.codex/skills/` |
|
||||
| Gemini CLI | `GEMINI.md` | `.gemini/skills/` | `~/.gemini/skills/` |
|
||||
| OpenCode | `AGENTS.md` | `.opencode/skills/` | `~/.config/opencode/skills/` |
|
||||
| Antigravity | `AGENTS.md` | `.antigravity/skills/` | `~/.gemini/antigravity/skills/` |
|
||||
| Amp | `AGENTS.md` | `.agents/skills/` | `~/.config/agents/skills/` |
|
||||
| Clawdbot | `AGENTS.md` | `skills/` | `~/.clawdbot/skills/` |
|
||||
| Droid (Factory) | `AGENTS.md` | `.factory/skills/` | `~/.factory/skills/` |
|
||||
| GitHub Copilot | `AGENTS.md` | `.github/skills/` | `~/.copilot/skills/` |
|
||||
| Goose | `AGENTS.md` | `.goose/skills/` | `~/.config/goose/skills/` |
|
||||
| Kilo Code | `AGENTS.md` | `.kilocode/skills/` | `~/.kilocode/skills/` |
|
||||
| Kiro CLI | `AGENTS.md` | `.kiro/skills/` | `~/.kiro/skills/` |
|
||||
| Roo Code | `AGENTS.md` | `.roo/skills/` | `~/.roo/skills/` |
|
||||
| Trae | `AGENTS.md` | `.trae/skills/` | `~/.trae/skills/` |
|
||||
| Windsurf | `AGENTS.md` | `.windsurf/skills/` | `~/.codeium/windsurf/skills/` |
|
||||
| Universal | `AGENTS.md` | `.agent/skills/` | `~/.agent/skills/` |
|
||||
[Full command reference](https://agenstskills.com/docs/commands)
|
||||
|
||||
## Creating Skills
|
||||
|
||||
Use `skillkit create <name>` to scaffold a new skill, or create manually:
|
||||
|
||||
A skill is a directory with a `SKILL.md` file:
|
||||
|
||||
```
|
||||
my-skill/
|
||||
├── SKILL.md # Required: Instructions for the AI
|
||||
├── references/ # Optional: Documentation
|
||||
├── scripts/ # Optional: Helper scripts
|
||||
└── assets/ # Optional: Templates, configs
|
||||
```bash
|
||||
skillkit create my-skill
|
||||
```
|
||||
|
||||
### SKILL.md Format
|
||||
|
||||
Follows the [Agent Skills specification](https://agentskills.io/specification):
|
||||
Or manually create a `SKILL.md`:
|
||||
|
||||
```markdown
|
||||
---
|
||||
name: my-skill
|
||||
description: What this skill does and when to use it. Include trigger keywords.
|
||||
description: What this skill does
|
||||
license: MIT
|
||||
compatibility: Requires Node.js 18+
|
||||
metadata:
|
||||
author: your-org
|
||||
version: "1.0"
|
||||
---
|
||||
|
||||
# My Skill
|
||||
|
||||
Instructions for the AI agent on how to use this skill.
|
||||
Instructions for the AI agent.
|
||||
|
||||
## When to Use
|
||||
|
||||
- Scenario 1
|
||||
- Scenario 2
|
||||
|
||||
## Steps
|
||||
|
||||
1. First step
|
||||
2. Second step
|
||||
```
|
||||
|
||||
| Field | Required | Description |
|
||||
|-------|----------|-------------|
|
||||
| `name` | Yes | Lowercase alphanumeric with hyphens (max 64 chars) |
|
||||
| `description` | Yes | What it does and when to use it (max 1024 chars) |
|
||||
| `license` | No | License name or reference |
|
||||
| `compatibility` | No | Environment requirements |
|
||||
| `metadata` | No | Arbitrary key-value pairs |
|
||||
|
||||
## CI/CD Usage
|
||||
|
||||
```yaml
|
||||
# GitHub Actions example
|
||||
- name: Setup skills
|
||||
run: |
|
||||
npx skillkit install owner/skills --skills=lint,test,deploy --yes
|
||||
npx skillkit sync --yes
|
||||
```
|
||||
|
||||
## Programmatic API
|
||||
|
||||
```typescript
|
||||
import {
|
||||
findAllSkills,
|
||||
discoverSkills,
|
||||
detectAgent,
|
||||
getAdapter,
|
||||
} from 'skillkit';
|
||||
import { translateSkill, analyzeProject, RecommendationEngine } from 'skillkit';
|
||||
|
||||
// Find all installed skills
|
||||
const skills = findAllSkills(searchDirs);
|
||||
const skill = await translateSkill(content, 'cursor');
|
||||
|
||||
// Detect current agent
|
||||
const agent = await detectAgent();
|
||||
|
||||
// Generate config
|
||||
const adapter = getAdapter(agent);
|
||||
const config = adapter.generateConfig(skills);
|
||||
const profile = await analyzeProject('./my-project');
|
||||
const engine = new RecommendationEngine();
|
||||
const recs = await engine.recommend(profile);
|
||||
```
|
||||
|
||||
## Configuration
|
||||
```typescript
|
||||
import { startServer } from '@skillkit/api';
|
||||
await startServer({ port: 3737, skills: [...] });
|
||||
```
|
||||
|
||||
Create `skillkit.yaml` in your project:
|
||||
```typescript
|
||||
import { MemoryCache, RelevanceRanker } from '@skillkit/core';
|
||||
const cache = new MemoryCache({ maxSize: 500, ttlMs: 86_400_000 });
|
||||
const ranker = new RelevanceRanker();
|
||||
const results = ranker.rank(skills, 'react performance');
|
||||
```
|
||||
|
||||
```yaml
|
||||
version: 1
|
||||
agent: cursor # Override auto-detection
|
||||
autoSync: true # Auto-sync on changes
|
||||
enabledSkills:
|
||||
- pdf
|
||||
- xlsx
|
||||
disabledSkills:
|
||||
- deprecated-skill
|
||||
## Skill Sources
|
||||
|
||||
SkillKit aggregates skills from trusted sources. All original creators are credited with their licenses preserved.
|
||||
|
||||
### Official Partners
|
||||
|
||||
| Repository | Description |
|
||||
|------------|-------------|
|
||||
| [anthropics/skills](https://github.com/anthropics/skills) | Official Claude Code skills |
|
||||
| [vercel-labs/agent-skills](https://github.com/vercel-labs/agent-skills) | Next.js and React skills |
|
||||
| [expo/skills](https://github.com/expo/skills) | Mobile development with Expo |
|
||||
| [remotion-dev/skills](https://github.com/remotion-dev/skills) | Programmatic video creation |
|
||||
| [supabase/agent-skills](https://github.com/supabase/agent-skills) | Database and auth skills |
|
||||
| [stripe/ai](https://github.com/stripe/ai) | Payment integration patterns |
|
||||
|
||||
### Community
|
||||
|
||||
[trailofbits/skills](https://github.com/trailofbits/skills) · [obra/superpowers](https://github.com/obra/superpowers) · [wshobson/agents](https://github.com/wshobson/agents) · [ComposioHQ/awesome-claude-skills](https://github.com/ComposioHQ/awesome-claude-skills) · [travisvn/awesome-claude-skills](https://github.com/travisvn/awesome-claude-skills) · [langgenius/dify](https://github.com/langgenius/dify) · [better-auth/skills](https://github.com/better-auth/skills) · [onmax/nuxt-skills](https://github.com/onmax/nuxt-skills) · [elysiajs/skills](https://github.com/elysiajs/skills) · [kadajett/agent-nestjs-skills](https://github.com/kadajett/agent-nestjs-skills) · [cloudai-x/threejs-skills](https://github.com/cloudai-x/threejs-skills) · [dimillian/skills](https://github.com/dimillian/skills) · [waynesutton/convexskills](https://github.com/waynesutton/convexskills) · [kepano/obsidian-skills](https://github.com/kepano/obsidian-skills) · [giuseppe-trisciuoglio/developer-kit](https://github.com/giuseppe-trisciuoglio/developer-kit) · [openrouterteam/agent-skills](https://github.com/openrouterteam/agent-skills)
|
||||
|
||||
**Want to add your skills?** [Submit your repository](https://github.com/rohitg00/skillkit/issues/new?template=add-source.md)
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
npm install -g skillkit # npm
|
||||
pnpm add -g skillkit # pnpm
|
||||
yarn global add skillkit # yarn
|
||||
bun add -g skillkit # bun
|
||||
npx skillkit <command> # no install
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
MIT License - see [LICENSE](LICENSE) for details.
|
||||
Apache License 2.0 — see [LICENSE](LICENSE).
|
||||
|
||||
## Contributing
|
||||
## Links
|
||||
|
||||
Contributions welcome! Please read our contributing guidelines.
|
||||
|
||||
## Acknowledgments
|
||||
|
||||
Implements the [Agent Skills](https://agentskills.io) open format, originally developed by Anthropic and adopted by leading AI development tools.
|
||||
[Documentation](https://agenstskills.com/docs) · [Website](https://agenstskills.com) · [API Explorer](https://agenstskills.com/api) · [npm](https://www.npmjs.com/package/skillkit) · [GitHub](https://github.com/rohitg00/skillkit)
|
||||
|
||||
@@ -0,0 +1,93 @@
|
||||
# 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
|
||||
```
|
||||
@@ -0,0 +1,43 @@
|
||||
version: 1
|
||||
project:
|
||||
name: skillkit
|
||||
description: Universal skills loader for AI coding agents - supports Claude Code, Codex, Cursor, Antigravity, OpenCode, Gemini CLI and more
|
||||
type: cli
|
||||
path: /Users/rohitghumare/skillkit/apps/skillkit
|
||||
stack:
|
||||
languages:
|
||||
- name: typescript
|
||||
version: 5.7.2
|
||||
confidence: 100
|
||||
source: tsconfig.json
|
||||
frameworks: []
|
||||
libraries: []
|
||||
styling: []
|
||||
testing:
|
||||
- name: vitest
|
||||
version: 2.1.8
|
||||
confidence: 100
|
||||
source: package.json
|
||||
databases: []
|
||||
tools: []
|
||||
runtime:
|
||||
- name: nodejs
|
||||
version: 18.0.0
|
||||
confidence: 100
|
||||
source: package.json
|
||||
patterns:
|
||||
apiStyle: rest
|
||||
testing: vitest
|
||||
skills:
|
||||
installed: []
|
||||
recommended: []
|
||||
excluded: []
|
||||
autoSync: true
|
||||
securityLevel: medium
|
||||
testingRequired: false
|
||||
agents:
|
||||
detected: []
|
||||
synced: []
|
||||
disabled: []
|
||||
createdAt: 2026-01-23T00:02:29.727Z
|
||||
updatedAt: 2026-01-23T00:02:29.728Z
|
||||
@@ -0,0 +1,203 @@
|
||||
# SkillKit
|
||||
|
||||
Universal skills manager for AI coding agents. Install, manage, and sync skills across 32 AI agents including Claude Code, Cursor, Codex, Gemini CLI, and more.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npm install -g skillkit
|
||||
```
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Initialize skillkit in your project
|
||||
skillkit init
|
||||
|
||||
# Install skills from GitHub
|
||||
skillkit install anthropics/skills
|
||||
|
||||
# Get recommendations for your stack
|
||||
skillkit recommend
|
||||
|
||||
# Launch interactive TUI
|
||||
skillkit ui
|
||||
```
|
||||
|
||||
## Core Features
|
||||
|
||||
### Cross-Agent Translation
|
||||
|
||||
```bash
|
||||
# Translate a Claude skill to Cursor format
|
||||
skillkit translate react-patterns --to cursor
|
||||
|
||||
# Translate all skills to multiple agents
|
||||
skillkit translate --all --to windsurf,codex
|
||||
|
||||
# Preview translation
|
||||
skillkit translate my-skill --to copilot --dry-run
|
||||
```
|
||||
|
||||
### Smart Recommendations
|
||||
|
||||
```bash
|
||||
# Get project-aware suggestions
|
||||
skillkit recommend
|
||||
|
||||
# Filter by task
|
||||
skillkit recommend --search "authentication"
|
||||
|
||||
# Quality threshold
|
||||
skillkit recommend --min-score 85
|
||||
```
|
||||
|
||||
### Team Collaboration
|
||||
|
||||
```bash
|
||||
# Initialize team
|
||||
skillkit team init --name "Engineering Team"
|
||||
|
||||
# Create skill bundle
|
||||
skillkit team bundle-create
|
||||
|
||||
# Share with team
|
||||
skillkit team share onboarding-bundle
|
||||
|
||||
# Sync with remote registry
|
||||
skillkit team sync
|
||||
```
|
||||
|
||||
### Plugin System
|
||||
|
||||
```bash
|
||||
# List installed plugins
|
||||
skillkit plugin list
|
||||
|
||||
# Install custom plugin
|
||||
skillkit plugin install @company/custom-translator
|
||||
|
||||
# View plugin info
|
||||
skillkit plugin info my-plugin
|
||||
```
|
||||
|
||||
### Development Methodologies
|
||||
|
||||
```bash
|
||||
# List available methodologies
|
||||
skillkit methodology list
|
||||
|
||||
# Load TDD methodology
|
||||
skillkit methodology load tdd
|
||||
|
||||
# Apply to project
|
||||
skillkit methodology apply agile
|
||||
```
|
||||
|
||||
### Plan System
|
||||
|
||||
```bash
|
||||
# Parse and validate plan
|
||||
skillkit plan parse ./implementation-plan.md
|
||||
skillkit plan validate ./plan.md
|
||||
|
||||
# Execute plan
|
||||
skillkit plan execute ./feature-plan.md
|
||||
|
||||
# Check status
|
||||
skillkit plan status
|
||||
```
|
||||
|
||||
### Hooks & Automation
|
||||
|
||||
```bash
|
||||
# List hooks
|
||||
skillkit hook list
|
||||
|
||||
# Register pre-commit hook
|
||||
skillkit hook register pre-commit
|
||||
|
||||
# Trigger manually
|
||||
skillkit hook trigger pre-commit
|
||||
```
|
||||
|
||||
### Workflow Orchestration
|
||||
|
||||
```bash
|
||||
# List workflows
|
||||
skillkit workflow list
|
||||
|
||||
# Run workflow
|
||||
skillkit workflow run feature-development
|
||||
|
||||
# Create new workflow
|
||||
skillkit workflow create deployment-flow
|
||||
```
|
||||
|
||||
### Session Memory
|
||||
|
||||
```bash
|
||||
# View learnings
|
||||
skillkit memory list
|
||||
|
||||
# Search past sessions
|
||||
skillkit memory search "error handling"
|
||||
|
||||
# Compress observations
|
||||
skillkit memory compress
|
||||
|
||||
# Export learning as skill
|
||||
skillkit memory export auth-insight --output auth-skill.md
|
||||
```
|
||||
|
||||
## Supported Agents (32)
|
||||
|
||||
**Primary (17):** Claude Code, Cursor, Codex, Gemini CLI, Windsurf, GitHub Copilot, OpenCode, Antigravity, Amp, Clawdbot, Droid, Goose, Kilo, Kiro, Roo, Trae, Universal
|
||||
|
||||
**Extended (15):** Cline, CodeBuddy, CommandCode, Continue, Crush, Factory, MCPJam, Mux, Neovate, OpenHands, Pi, Qoder, Qwen, Vercel, Zencoder
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### Install and Sync
|
||||
|
||||
```bash
|
||||
# Install to multiple agents
|
||||
skillkit install anthropics/skills --agent claude-code,cursor
|
||||
|
||||
# Sync all skills to detected agents
|
||||
skillkit sync --all
|
||||
```
|
||||
|
||||
### Context Management
|
||||
|
||||
```bash
|
||||
# Initialize project context
|
||||
skillkit context init
|
||||
|
||||
# View detected stack
|
||||
skillkit context show
|
||||
|
||||
# Sync to all agents
|
||||
skillkit context sync --all
|
||||
```
|
||||
|
||||
### Testing
|
||||
|
||||
```bash
|
||||
# Run all skill tests
|
||||
skillkit test
|
||||
|
||||
# Test specific skills
|
||||
skillkit test ./my-skill --tags unit
|
||||
|
||||
# CI/CD integration
|
||||
skillkit cicd init
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
Full documentation: https://github.com/rohitg00/skillkit
|
||||
|
||||
## License
|
||||
|
||||
Apache-2.0
|
||||
@@ -0,0 +1,72 @@
|
||||
{
|
||||
"name": "skillkit",
|
||||
"version": "1.14.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": {
|
||||
"skillkit": "./dist/cli.js",
|
||||
"sk": "./dist/cli.js"
|
||||
},
|
||||
"main": "./dist/index.js",
|
||||
"types": "./dist/index.d.ts",
|
||||
"exports": {
|
||||
".": {
|
||||
"import": "./dist/index.js",
|
||||
"types": "./dist/index.d.ts"
|
||||
}
|
||||
},
|
||||
"files": [
|
||||
"dist",
|
||||
"schemas"
|
||||
],
|
||||
"scripts": {
|
||||
"build": "tsup",
|
||||
"dev": "tsup --watch",
|
||||
"typecheck": "tsc --noEmit",
|
||||
"test": "vitest run"
|
||||
},
|
||||
"keywords": [
|
||||
"ai",
|
||||
"skills",
|
||||
"claude",
|
||||
"codex",
|
||||
"cursor",
|
||||
"gemini",
|
||||
"opencode",
|
||||
"antigravity",
|
||||
"agent",
|
||||
"coding-assistant",
|
||||
"skill-loader",
|
||||
"cli"
|
||||
],
|
||||
"author": "Rohit Ghumare",
|
||||
"license": "Apache-2.0",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/rohitg00/skillkit.git"
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://github.com/rohitg00/skillkit/issues"
|
||||
},
|
||||
"homepage": "https://github.com/rohitg00/skillkit#readme",
|
||||
"engines": {
|
||||
"node": ">=18.0.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"@skillkit/api": "workspace:*",
|
||||
"@skillkit/core": "workspace:*",
|
||||
"@skillkit/agents": "workspace:*",
|
||||
"@skillkit/cli": "workspace:*",
|
||||
"@skillkit/tui": "workspace:*",
|
||||
"@skillkit/memory": "workspace:*",
|
||||
"@skillkit/mesh": "workspace:*",
|
||||
"@skillkit/messaging": "workspace:*",
|
||||
"clipanion": "^4.0.0-rc.4"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/node": "^22.10.5",
|
||||
"tsup": "^8.3.5",
|
||||
"typescript": "^5.7.2",
|
||||
"vitest": "^2.1.8"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,28 @@
|
||||
import { describe, it, expect } from 'vitest';
|
||||
import { existsSync } from 'node:fs';
|
||||
import { join, dirname } from 'node:path';
|
||||
import { fileURLToPath } from 'node:url';
|
||||
|
||||
const __filename = fileURLToPath(import.meta.url);
|
||||
const __dirname = dirname(__filename);
|
||||
|
||||
describe('SkillKit CLI', () => {
|
||||
describe('build artifacts', () => {
|
||||
it('should have cli entry point', () => {
|
||||
const distPath = join(__dirname, '../../dist/cli.js');
|
||||
expect(existsSync(distPath)).toBe(true);
|
||||
});
|
||||
|
||||
it('should have index entry point', () => {
|
||||
const distPath = join(__dirname, '../../dist/index.js');
|
||||
expect(existsSync(distPath)).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe('package.json', () => {
|
||||
it('should have correct bin configuration', async () => {
|
||||
const packageJsonPath = join(__dirname, '../../package.json');
|
||||
expect(existsSync(packageJsonPath)).toBe(true);
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,237 @@
|
||||
#!/usr/bin/env node
|
||||
import { readFileSync } from 'node:fs';
|
||||
import { fileURLToPath } from 'node:url';
|
||||
import { dirname, join } from 'node:path';
|
||||
import { Cli, Builtins } from 'clipanion';
|
||||
import {
|
||||
InstallCommand,
|
||||
SyncCommand,
|
||||
ReadCommand,
|
||||
ListCommand,
|
||||
EnableCommand,
|
||||
DisableCommand,
|
||||
UpdateCommand,
|
||||
RemoveCommand,
|
||||
InitCommand,
|
||||
ValidateCommand,
|
||||
FixCommand,
|
||||
CreateCommand,
|
||||
UICommand,
|
||||
TranslateCommand,
|
||||
ContextCommand,
|
||||
RecommendCommand,
|
||||
StatusCommand,
|
||||
PauseCommand,
|
||||
ResumeCommand,
|
||||
WorkflowRunCommand,
|
||||
WorkflowListCommand,
|
||||
WorkflowCreateCommand,
|
||||
WorkflowPipelineCommand,
|
||||
WorkflowPipelineListCommand,
|
||||
RunCommand,
|
||||
TestCommand,
|
||||
MarketplaceCommand,
|
||||
MemoryCommand,
|
||||
SettingsCommand,
|
||||
CICDCommand,
|
||||
TeamCommand,
|
||||
PluginCommand,
|
||||
MethodologyCommand,
|
||||
HookCommand,
|
||||
HookTemplateListCommand,
|
||||
HookTemplateApplyCommand,
|
||||
HookTemplateShowCommand,
|
||||
PlanCommand,
|
||||
CommandCmd,
|
||||
CommandAvailableCommand,
|
||||
CommandInstallCommand,
|
||||
AICommand,
|
||||
AuditCommand,
|
||||
PublishCommand,
|
||||
PublishSubmitCommand,
|
||||
AgentCommand,
|
||||
AgentListCommand,
|
||||
AgentShowCommand,
|
||||
AgentCreateCommand,
|
||||
AgentFromSkillCommand,
|
||||
AgentTranslateCommand,
|
||||
AgentSyncCommand,
|
||||
AgentValidateCommand,
|
||||
AgentInstallCommand,
|
||||
AgentAvailableCommand,
|
||||
CheckCommand,
|
||||
FindCommand,
|
||||
ManifestCommand,
|
||||
ManifestInitCommand,
|
||||
ManifestAddCommand,
|
||||
ManifestRemoveCommand,
|
||||
ManifestInstallCommand,
|
||||
ManifestGenerateCommand,
|
||||
PrimerCommand,
|
||||
MeshCommand,
|
||||
MessageCommand,
|
||||
LearnCommand,
|
||||
PatternStatusCommand,
|
||||
PatternFeedbackCommand,
|
||||
PatternApproveCommand,
|
||||
PatternRejectCommand,
|
||||
PatternExportCommand,
|
||||
PatternImportCommand,
|
||||
PatternClusterCommand,
|
||||
SessionCommand,
|
||||
SessionStatusCommand,
|
||||
SessionStartCommand,
|
||||
SessionLoadCommand,
|
||||
SessionListCommand,
|
||||
SessionNoteCommand,
|
||||
SessionCompleteCommand,
|
||||
SessionInProgressCommand,
|
||||
ProfileCommand,
|
||||
ProfileListCommand,
|
||||
ProfileCreateCommand,
|
||||
ProfileRemoveCommand,
|
||||
GuidelineCommand,
|
||||
GuidelineListCommand,
|
||||
GuidelineShowCommand,
|
||||
GuidelineEnableCommand,
|
||||
GuidelineDisableCommand,
|
||||
GuidelineCreateCommand,
|
||||
GuidelineRemoveCommand,
|
||||
TreeCommand,
|
||||
QuickCommand,
|
||||
SkillMdValidateCommand,
|
||||
SkillMdInitCommand,
|
||||
SkillMdCheckCommand,
|
||||
ServeCommand,
|
||||
ScanCommand,
|
||||
} from '@skillkit/cli';
|
||||
|
||||
const __filename = fileURLToPath(import.meta.url);
|
||||
const __dirname = dirname(__filename);
|
||||
const packageJsonPath = join(__dirname, '../package.json');
|
||||
const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf-8'));
|
||||
const version = packageJson.version || '1.2.0';
|
||||
|
||||
const cli = new Cli({
|
||||
binaryLabel: 'skillkit',
|
||||
binaryName: 'skillkit',
|
||||
binaryVersion: version,
|
||||
});
|
||||
|
||||
cli.register(Builtins.HelpCommand);
|
||||
cli.register(Builtins.VersionCommand);
|
||||
|
||||
cli.register(InstallCommand);
|
||||
cli.register(SyncCommand);
|
||||
cli.register(ReadCommand);
|
||||
cli.register(ListCommand);
|
||||
cli.register(EnableCommand);
|
||||
cli.register(DisableCommand);
|
||||
cli.register(UpdateCommand);
|
||||
cli.register(RemoveCommand);
|
||||
cli.register(InitCommand);
|
||||
cli.register(ValidateCommand);
|
||||
cli.register(FixCommand);
|
||||
cli.register(CreateCommand);
|
||||
cli.register(UICommand);
|
||||
cli.register(TranslateCommand);
|
||||
cli.register(ContextCommand);
|
||||
cli.register(RecommendCommand);
|
||||
cli.register(StatusCommand);
|
||||
cli.register(PauseCommand);
|
||||
cli.register(ResumeCommand);
|
||||
cli.register(WorkflowRunCommand);
|
||||
cli.register(WorkflowListCommand);
|
||||
cli.register(WorkflowCreateCommand);
|
||||
cli.register(RunCommand);
|
||||
cli.register(TestCommand);
|
||||
cli.register(MarketplaceCommand);
|
||||
cli.register(MemoryCommand);
|
||||
cli.register(SettingsCommand);
|
||||
cli.register(CICDCommand);
|
||||
cli.register(TeamCommand);
|
||||
cli.register(PluginCommand);
|
||||
cli.register(MethodologyCommand);
|
||||
cli.register(HookCommand);
|
||||
cli.register(PlanCommand);
|
||||
cli.register(CommandCmd);
|
||||
cli.register(AICommand);
|
||||
cli.register(AuditCommand);
|
||||
cli.register(PublishCommand);
|
||||
cli.register(PublishSubmitCommand);
|
||||
cli.register(AgentCommand);
|
||||
cli.register(AgentListCommand);
|
||||
cli.register(AgentShowCommand);
|
||||
cli.register(AgentCreateCommand);
|
||||
cli.register(AgentFromSkillCommand);
|
||||
cli.register(AgentTranslateCommand);
|
||||
cli.register(AgentSyncCommand);
|
||||
cli.register(AgentValidateCommand);
|
||||
|
||||
cli.register(CheckCommand);
|
||||
cli.register(FindCommand);
|
||||
cli.register(ManifestCommand);
|
||||
cli.register(ManifestInitCommand);
|
||||
cli.register(ManifestAddCommand);
|
||||
cli.register(ManifestRemoveCommand);
|
||||
cli.register(ManifestInstallCommand);
|
||||
cli.register(ManifestGenerateCommand);
|
||||
cli.register(PrimerCommand);
|
||||
cli.register(MeshCommand);
|
||||
cli.register(MessageCommand);
|
||||
|
||||
cli.register(WorkflowPipelineCommand);
|
||||
cli.register(WorkflowPipelineListCommand);
|
||||
|
||||
cli.register(HookTemplateListCommand);
|
||||
cli.register(HookTemplateApplyCommand);
|
||||
cli.register(HookTemplateShowCommand);
|
||||
|
||||
cli.register(CommandAvailableCommand);
|
||||
cli.register(CommandInstallCommand);
|
||||
|
||||
cli.register(AgentInstallCommand);
|
||||
cli.register(AgentAvailableCommand);
|
||||
|
||||
cli.register(LearnCommand);
|
||||
cli.register(PatternStatusCommand);
|
||||
cli.register(PatternFeedbackCommand);
|
||||
cli.register(PatternApproveCommand);
|
||||
cli.register(PatternRejectCommand);
|
||||
cli.register(PatternExportCommand);
|
||||
cli.register(PatternImportCommand);
|
||||
cli.register(PatternClusterCommand);
|
||||
|
||||
cli.register(SessionCommand);
|
||||
cli.register(SessionStatusCommand);
|
||||
cli.register(SessionStartCommand);
|
||||
cli.register(SessionLoadCommand);
|
||||
cli.register(SessionListCommand);
|
||||
cli.register(SessionNoteCommand);
|
||||
cli.register(SessionCompleteCommand);
|
||||
cli.register(SessionInProgressCommand);
|
||||
|
||||
cli.register(ProfileCommand);
|
||||
cli.register(ProfileListCommand);
|
||||
cli.register(ProfileCreateCommand);
|
||||
cli.register(ProfileRemoveCommand);
|
||||
|
||||
cli.register(GuidelineCommand);
|
||||
cli.register(GuidelineListCommand);
|
||||
cli.register(GuidelineShowCommand);
|
||||
cli.register(GuidelineEnableCommand);
|
||||
cli.register(GuidelineDisableCommand);
|
||||
cli.register(GuidelineCreateCommand);
|
||||
cli.register(GuidelineRemoveCommand);
|
||||
|
||||
cli.register(TreeCommand);
|
||||
|
||||
cli.register(QuickCommand);
|
||||
cli.register(SkillMdValidateCommand);
|
||||
cli.register(SkillMdInitCommand);
|
||||
cli.register(SkillMdCheckCommand);
|
||||
|
||||
cli.register(ServeCommand);
|
||||
cli.register(ScanCommand);
|
||||
|
||||
cli.runExit(process.argv.slice(2));
|
||||
@@ -0,0 +1,6 @@
|
||||
// Re-export all public APIs from packages
|
||||
export * from '@skillkit/core';
|
||||
export * from '@skillkit/agents';
|
||||
|
||||
// Re-export TUI entry point
|
||||
export { startTUI } from '@skillkit/tui';
|
||||
@@ -0,0 +1,10 @@
|
||||
{
|
||||
"extends": "../../tsconfig.base.json",
|
||||
"compilerOptions": {
|
||||
"outDir": "./dist",
|
||||
"rootDir": "./src",
|
||||
"composite": false
|
||||
},
|
||||
"include": ["src/**/*"],
|
||||
"exclude": ["node_modules", "dist"]
|
||||
}
|
||||
@@ -0,0 +1,10 @@
|
||||
import { defineConfig } from 'tsup';
|
||||
|
||||
export default defineConfig({
|
||||
entry: ['src/cli.ts', 'src/index.ts'],
|
||||
format: ['esm'],
|
||||
dts: true,
|
||||
splitting: false,
|
||||
sourcemap: true,
|
||||
clean: true,
|
||||
});
|
||||
@@ -0,0 +1,42 @@
|
||||
[build-system]
|
||||
requires = ["hatchling"]
|
||||
build-backend = "hatchling.build"
|
||||
|
||||
[project]
|
||||
name = "skillkit-client"
|
||||
version = "0.1.0"
|
||||
description = "Python client for the SkillKit REST API"
|
||||
readme = "README.md"
|
||||
license = "Apache-2.0"
|
||||
requires-python = ">=3.9"
|
||||
authors = [
|
||||
{ name = "Rohit Ghumare", email = "ghumare64@gmail.com" },
|
||||
]
|
||||
keywords = ["skillkit", "ai", "agents", "skills", "discovery"]
|
||||
classifiers = [
|
||||
"Development Status :: 3 - Alpha",
|
||||
"Intended Audience :: Developers",
|
||||
"License :: OSI Approved :: Apache Software License",
|
||||
"Programming Language :: Python :: 3",
|
||||
"Programming Language :: Python :: 3.9",
|
||||
"Programming Language :: Python :: 3.10",
|
||||
"Programming Language :: Python :: 3.11",
|
||||
"Programming Language :: Python :: 3.12",
|
||||
"Topic :: Software Development :: Libraries",
|
||||
]
|
||||
dependencies = [
|
||||
"httpx>=0.27",
|
||||
"pydantic>=2.0",
|
||||
]
|
||||
|
||||
[project.optional-dependencies]
|
||||
dev = [
|
||||
"pytest>=7.0",
|
||||
"pytest-asyncio>=0.23",
|
||||
"respx>=0.21",
|
||||
]
|
||||
|
||||
[project.urls]
|
||||
Homepage = "https://github.com/rohitg00/skillkit"
|
||||
Documentation = "https://agenstskills.com"
|
||||
Repository = "https://github.com/rohitg00/skillkit"
|
||||
@@ -0,0 +1,12 @@
|
||||
from skillkit.client import SkillKitClient
|
||||
from skillkit.models import Skill, SearchResponse, HealthResponse, CacheStats, Category
|
||||
|
||||
__all__ = [
|
||||
"SkillKitClient",
|
||||
"Skill",
|
||||
"SearchResponse",
|
||||
"HealthResponse",
|
||||
"CacheStats",
|
||||
"Category",
|
||||
]
|
||||
__version__ = "0.1.0"
|
||||
@@ -0,0 +1,140 @@
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import Optional
|
||||
from urllib.parse import quote
|
||||
|
||||
import httpx
|
||||
|
||||
from skillkit.models import (
|
||||
CacheStats,
|
||||
CategoriesResponse,
|
||||
Category,
|
||||
HealthResponse,
|
||||
SearchResponse,
|
||||
Skill,
|
||||
TrendingResponse,
|
||||
)
|
||||
|
||||
|
||||
class SkillKitClient:
|
||||
def __init__(self, base_url: str = "http://localhost:3737", timeout: float = 30.0):
|
||||
self.base_url = base_url.rstrip("/")
|
||||
self.timeout = timeout
|
||||
self._client: Optional[httpx.AsyncClient] = None
|
||||
|
||||
async def __aenter__(self) -> "SkillKitClient":
|
||||
self._client = httpx.AsyncClient(base_url=self.base_url, timeout=self.timeout)
|
||||
return self
|
||||
|
||||
async def __aexit__(self, *args: object) -> None:
|
||||
if self._client:
|
||||
await self._client.aclose()
|
||||
self._client = None
|
||||
|
||||
def _get_client(self) -> httpx.AsyncClient:
|
||||
if self._client is None:
|
||||
self._client = httpx.AsyncClient(base_url=self.base_url, timeout=self.timeout)
|
||||
return self._client
|
||||
|
||||
async def health(self) -> HealthResponse:
|
||||
client = self._get_client()
|
||||
response = await client.get("/health")
|
||||
response.raise_for_status()
|
||||
data = response.json()
|
||||
return HealthResponse(
|
||||
status=data["status"],
|
||||
version=data["version"],
|
||||
skill_count=data.get("skillCount", 0),
|
||||
uptime=data.get("uptime", 0),
|
||||
)
|
||||
|
||||
async def search(
|
||||
self,
|
||||
query: str,
|
||||
limit: int = 20,
|
||||
include_content: bool = False,
|
||||
) -> SearchResponse:
|
||||
client = self._get_client()
|
||||
params = {"q": query, "limit": str(limit)}
|
||||
if include_content:
|
||||
params["include_content"] = "true"
|
||||
response = await client.get("/search", params=params)
|
||||
response.raise_for_status()
|
||||
data = response.json()
|
||||
return SearchResponse(
|
||||
skills=[Skill(**s) for s in data["skills"]],
|
||||
total=data["total"],
|
||||
query=data["query"],
|
||||
limit=data["limit"],
|
||||
)
|
||||
|
||||
async def search_with_filters(
|
||||
self,
|
||||
query: str,
|
||||
limit: int = 20,
|
||||
include_content: bool = False,
|
||||
tags: Optional[list[str]] = None,
|
||||
category: Optional[str] = None,
|
||||
source: Optional[str] = None,
|
||||
) -> SearchResponse:
|
||||
client = self._get_client()
|
||||
body: dict = {"query": query, "limit": limit, "include_content": include_content}
|
||||
filters: dict = {}
|
||||
if tags:
|
||||
filters["tags"] = tags
|
||||
if category:
|
||||
filters["category"] = category
|
||||
if source:
|
||||
filters["source"] = source
|
||||
if filters:
|
||||
body["filters"] = filters
|
||||
response = await client.post("/search", json=body)
|
||||
response.raise_for_status()
|
||||
data = response.json()
|
||||
return SearchResponse(
|
||||
skills=[Skill(**s) for s in data["skills"]],
|
||||
total=data["total"],
|
||||
query=data["query"],
|
||||
limit=data["limit"],
|
||||
)
|
||||
|
||||
async def get_skill(self, source: str, skill_id: str) -> Skill:
|
||||
client = self._get_client()
|
||||
parts = source.split("/", 1)
|
||||
owner = quote(parts[0], safe="")
|
||||
repo = quote(parts[1], safe="") if len(parts) > 1 else owner
|
||||
response = await client.get(f"/skills/{owner}/{repo}/{quote(skill_id, safe='')}")
|
||||
response.raise_for_status()
|
||||
return Skill(**response.json())
|
||||
|
||||
async def trending(self, limit: int = 20) -> list[Skill]:
|
||||
client = self._get_client()
|
||||
response = await client.get("/trending", params={"limit": str(limit)})
|
||||
response.raise_for_status()
|
||||
data = response.json()
|
||||
return [Skill(**s) for s in data["skills"]]
|
||||
|
||||
async def categories(self) -> list[Category]:
|
||||
client = self._get_client()
|
||||
response = await client.get("/categories")
|
||||
response.raise_for_status()
|
||||
data = response.json()
|
||||
return [Category(**c) for c in data["categories"]]
|
||||
|
||||
async def cache_stats(self) -> CacheStats:
|
||||
client = self._get_client()
|
||||
response = await client.get("/cache/stats")
|
||||
response.raise_for_status()
|
||||
data = response.json()
|
||||
return CacheStats(
|
||||
hits=data["hits"],
|
||||
misses=data["misses"],
|
||||
size=data["size"],
|
||||
max_size=data.get("maxSize", 0),
|
||||
hit_rate=data.get("hitRate", 0.0),
|
||||
)
|
||||
|
||||
async def close(self) -> None:
|
||||
if self._client:
|
||||
await self._client.aclose()
|
||||
self._client = None
|
||||
@@ -0,0 +1,51 @@
|
||||
from typing import Optional
|
||||
from pydantic import BaseModel
|
||||
|
||||
|
||||
class Skill(BaseModel):
|
||||
name: str
|
||||
description: Optional[str] = None
|
||||
source: str
|
||||
repo: Optional[str] = None
|
||||
tags: Optional[list[str]] = None
|
||||
category: Optional[str] = None
|
||||
content: Optional[str] = None
|
||||
stars: Optional[int] = None
|
||||
installs: Optional[int] = None
|
||||
|
||||
|
||||
class SearchResponse(BaseModel):
|
||||
skills: list[Skill]
|
||||
total: int
|
||||
query: str
|
||||
limit: int
|
||||
|
||||
|
||||
class HealthResponse(BaseModel):
|
||||
status: str
|
||||
version: str
|
||||
skill_count: int = 0
|
||||
uptime: int = 0
|
||||
|
||||
|
||||
class CacheStats(BaseModel):
|
||||
hits: int
|
||||
misses: int
|
||||
size: int
|
||||
max_size: int = 0
|
||||
hit_rate: float = 0.0
|
||||
|
||||
|
||||
class Category(BaseModel):
|
||||
name: str
|
||||
count: int
|
||||
|
||||
|
||||
class CategoriesResponse(BaseModel):
|
||||
categories: list[Category]
|
||||
total: int
|
||||
|
||||
|
||||
class TrendingResponse(BaseModel):
|
||||
skills: list[Skill]
|
||||
limit: int
|
||||
@@ -0,0 +1,99 @@
|
||||
import pytest
|
||||
import httpx
|
||||
import respx
|
||||
|
||||
from skillkit import SkillKitClient
|
||||
|
||||
|
||||
BASE_URL = "http://localhost:3737"
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def mock_api():
|
||||
with respx.mock(base_url=BASE_URL) as respx_mock:
|
||||
yield respx_mock
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_health(mock_api):
|
||||
mock_api.get("/health").respond(
|
||||
json={"status": "ok", "version": "1.11.0", "skillCount": 100, "uptime": 60}
|
||||
)
|
||||
async with SkillKitClient(BASE_URL) as client:
|
||||
health = await client.health()
|
||||
assert health.status == "ok"
|
||||
assert health.version == "1.11.0"
|
||||
assert health.skill_count == 100
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_search(mock_api):
|
||||
mock_api.get("/search").respond(
|
||||
json={
|
||||
"skills": [{"name": "react-perf", "source": "owner/repo"}],
|
||||
"total": 1,
|
||||
"query": "react",
|
||||
"limit": 20,
|
||||
}
|
||||
)
|
||||
async with SkillKitClient(BASE_URL) as client:
|
||||
result = await client.search("react")
|
||||
assert result.total == 1
|
||||
assert result.skills[0].name == "react-perf"
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_search_with_filters(mock_api):
|
||||
mock_api.post("/search").respond(
|
||||
json={
|
||||
"skills": [{"name": "nextjs-auth", "source": "other/repo"}],
|
||||
"total": 1,
|
||||
"query": "auth",
|
||||
"limit": 20,
|
||||
}
|
||||
)
|
||||
async with SkillKitClient(BASE_URL) as client:
|
||||
result = await client.search_with_filters("auth", tags=["nextjs"])
|
||||
assert result.total == 1
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_get_skill(mock_api):
|
||||
mock_api.get("/skills/owner/repo/react-perf").respond(
|
||||
json={"name": "react-perf", "description": "React performance", "source": "owner/repo"}
|
||||
)
|
||||
async with SkillKitClient(BASE_URL) as client:
|
||||
skill = await client.get_skill("owner/repo", "react-perf")
|
||||
assert skill.name == "react-perf"
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_trending(mock_api):
|
||||
mock_api.get("/trending").respond(
|
||||
json={"skills": [{"name": "a", "source": "x/y"}], "limit": 20}
|
||||
)
|
||||
async with SkillKitClient(BASE_URL) as client:
|
||||
trending = await client.trending()
|
||||
assert len(trending) == 1
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_categories(mock_api):
|
||||
mock_api.get("/categories").respond(
|
||||
json={"categories": [{"name": "react", "count": 5}], "total": 1}
|
||||
)
|
||||
async with SkillKitClient(BASE_URL) as client:
|
||||
cats = await client.categories()
|
||||
assert len(cats) == 1
|
||||
assert cats[0].name == "react"
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_cache_stats(mock_api):
|
||||
mock_api.get("/cache/stats").respond(
|
||||
json={"hits": 10, "misses": 5, "size": 8, "maxSize": 500, "hitRate": 0.667}
|
||||
)
|
||||
async with SkillKitClient(BASE_URL) as client:
|
||||
stats = await client.cache_stats()
|
||||
assert stats.hits == 10
|
||||
assert stats.size == 8
|
||||
@@ -0,0 +1,7 @@
|
||||
node_modules/
|
||||
.next/
|
||||
.source/
|
||||
out/
|
||||
.turbo/
|
||||
*.tsbuildinfo
|
||||
.vercel
|
||||
@@ -0,0 +1,2 @@
|
||||
../../turbo.json
|
||||
../../pnpm-workspace.yaml
|
||||
@@ -0,0 +1,43 @@
|
||||
# SkillKit Documentation
|
||||
|
||||
Fumadocs-based documentation for SkillKit.
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
cd docs/fumadocs
|
||||
pnpm install
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
Open [http://localhost:3000](http://localhost:3000).
|
||||
|
||||
## Build
|
||||
|
||||
```bash
|
||||
pnpm build
|
||||
```
|
||||
|
||||
## Structure
|
||||
|
||||
```text
|
||||
docs/fumadocs/
|
||||
├── content/docs/ # MDX documentation files
|
||||
├── src/
|
||||
│ ├── app/ # Next.js app router
|
||||
│ ├── lib/ # Components and utilities
|
||||
│ └── mdx-components.tsx
|
||||
├── package.json
|
||||
└── source.config.ts
|
||||
```
|
||||
|
||||
## Adding Pages
|
||||
|
||||
1. Create `.mdx` file in `content/docs/`
|
||||
2. Add frontmatter with `title` and `description`
|
||||
3. Add page to `content/docs/meta.json`
|
||||
|
||||
## Custom Components
|
||||
|
||||
- `<Card>` - Link cards with icons
|
||||
- `<Columns>` - Grid layout (2-4 columns)
|
||||
@@ -0,0 +1,71 @@
|
||||
---
|
||||
title: Supported Agents
|
||||
description: 32 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.
|
||||
|
||||
## Agent Directory Mapping
|
||||
|
||||
| Agent | Directory | Format |
|
||||
|-------|-----------|--------|
|
||||
| Claude Code | `.claude/skills/` | SKILL.md |
|
||||
| Cursor | `.cursor/skills/` | .mdc |
|
||||
| Codex | `.codex/skills/` | SKILL.md |
|
||||
| Gemini CLI | `.gemini/skills/` | SKILL.md |
|
||||
| OpenCode | `.opencode/skills/` | SKILL.md |
|
||||
| GitHub Copilot | `.github/skills/` | Markdown |
|
||||
| Windsurf | `.windsurf/skills/` | Markdown |
|
||||
| Antigravity | `.antigravity/skills/` | SKILL.md |
|
||||
| Amp | `.amp/skills/` | SKILL.md |
|
||||
| Clawdbot | `.clawdbot/skills/` (alt: `skills/`) | SKILL.md |
|
||||
| Droid (Factory) | `.factory/skills/` | SKILL.md |
|
||||
| Goose | `.goose/skills/` | SKILL.md |
|
||||
| Kilo Code | `.kilocode/skills/` | SKILL.md |
|
||||
| Kiro CLI | `.kiro/skills/` | SKILL.md |
|
||||
| Roo Code | `.roo/skills/` | SKILL.md |
|
||||
| Trae | `.trae/skills/` | SKILL.md |
|
||||
| Cline | `.cline/skills/` | SKILL.md |
|
||||
| CodeBuddy | `.codebuddy/skills/` | SKILL.md |
|
||||
| CommandCode | `.commandcode/skills/` | SKILL.md |
|
||||
| Continue | `.continue/skills/` | SKILL.md |
|
||||
| Crush | `.crush/skills/` | SKILL.md |
|
||||
| Factory | `.factory/skills/` | SKILL.md |
|
||||
| MCPJam | `.mcpjam/skills/` | SKILL.md |
|
||||
| Mux | `.mux/skills/` | SKILL.md |
|
||||
| Neovate | `.neovate/skills/` | SKILL.md |
|
||||
| OpenHands | `.openhands/skills/` | SKILL.md |
|
||||
| Pi | `.pi/skills/` | SKILL.md |
|
||||
| Qoder | `.qoder/skills/` | SKILL.md |
|
||||
| Qwen | `.qwen/skills/` | SKILL.md |
|
||||
| Vercel | `.vercel/skills/` | SKILL.md |
|
||||
| Zencoder | `.zencoder/skills/` | SKILL.md |
|
||||
| Universal | `skills/` | SKILL.md |
|
||||
|
||||
## Translation System
|
||||
|
||||
```
|
||||
Universal Format (SKILL.md)
|
||||
↓
|
||||
Adapter Interface
|
||||
↓
|
||||
Agent-Specific Formats (.mdc, JSON, Markdown)
|
||||
```
|
||||
|
||||
## Agent Commands
|
||||
|
||||
```bash
|
||||
skillkit agent list # List installed agents
|
||||
skillkit agent show <name> # Show agent details
|
||||
skillkit agent translate --to cursor # Translate to format
|
||||
skillkit agent sync # Sync to target agent
|
||||
```
|
||||
|
||||
## Multi-Agent Installation
|
||||
|
||||
```bash
|
||||
# Install for multiple agents
|
||||
skillkit install anthropics/skills --agent claude-code,cursor,windsurf
|
||||
```
|
||||
@@ -0,0 +1,422 @@
|
||||
---
|
||||
title: API Reference
|
||||
description: Core package API for programmatic skill management
|
||||
---
|
||||
|
||||
# API Reference
|
||||
|
||||
The `@skillkit/core` package provides the foundational business logic with zero internal dependencies.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npm install @skillkit/core
|
||||
```
|
||||
|
||||
## Module Exports
|
||||
|
||||
| Entry Point | Purpose |
|
||||
|-------------|---------|
|
||||
| `@skillkit/core` | Main exports |
|
||||
| `@skillkit/core/types` | Type definitions |
|
||||
| `@skillkit/core/discovery` | Skill discovery |
|
||||
| `@skillkit/core/parser` | SKILL.md parsing |
|
||||
| `@skillkit/core/translator` | Format translation |
|
||||
| `@skillkit/core/context` | Project context |
|
||||
| `@skillkit/core/recommend` | Recommendation engine |
|
||||
|
||||
## Skill Discovery
|
||||
|
||||
```typescript
|
||||
import { findAllSkills, findSkill } from '@skillkit/core/discovery'
|
||||
|
||||
// Find all skills in directory
|
||||
const skills = await findAllSkills('./my-project')
|
||||
|
||||
// Find specific skill
|
||||
const skill = await findSkill('react-patterns')
|
||||
```
|
||||
|
||||
## Quality Evaluation
|
||||
|
||||
```typescript
|
||||
import { evaluateSkillContent, getQualityGrade } from '@skillkit/core'
|
||||
|
||||
const score = evaluateSkillContent(skillContent)
|
||||
// { total: 85, structure: 22, clarity: 25, specificity: 28, advanced: 10 }
|
||||
|
||||
const grade = getQualityGrade(score.total)
|
||||
// 'B'
|
||||
```
|
||||
|
||||
**Dimensions (weights out of 100):**
|
||||
- Structure (25): Frontmatter, sections
|
||||
- Clarity (30): Descriptions, examples
|
||||
- Specificity (30): Actionable steps
|
||||
- Advanced (15): Tests, versioning
|
||||
|
||||
## Translation
|
||||
|
||||
```typescript
|
||||
import { translateSkill } from '@skillkit/core/translator'
|
||||
|
||||
const result = await translateSkill(skillContent, 'cursor')
|
||||
// { content: '...', filename: 'skill.mdc' }
|
||||
```
|
||||
|
||||
## Memory System
|
||||
|
||||
```typescript
|
||||
import { MemoryCompressor, LearningStore } from '@skillkit/core'
|
||||
|
||||
// Compress observations
|
||||
const compressor = new MemoryCompressor()
|
||||
const learning = await compressor.compress(observations)
|
||||
|
||||
// Store and search
|
||||
const store = new LearningStore()
|
||||
await store.add(learning)
|
||||
const results = await store.search('authentication')
|
||||
```
|
||||
|
||||
## Recommendation Engine
|
||||
|
||||
```typescript
|
||||
import { RecommendationEngine, analyzeProject } from '@skillkit/core/recommend'
|
||||
|
||||
const engine = new RecommendationEngine()
|
||||
const profile = await analyzeProject('./my-project')
|
||||
const recommendations = engine.recommend(profile)
|
||||
|
||||
// Recommendations with scores and reasons
|
||||
recommendations.forEach(rec => {
|
||||
console.log(`${rec.score}% - ${rec.skill.name}`)
|
||||
console.log(`Reasons: ${rec.reasons.join(', ')}`)
|
||||
})
|
||||
```
|
||||
|
||||
## Primer (Auto-Generate Instructions)
|
||||
|
||||
```typescript
|
||||
import { promises as fs } from 'node:fs'
|
||||
import { analyzeProject, generateInstructions } from '@skillkit/core'
|
||||
|
||||
// Analyze project
|
||||
const analysis = await analyzeProject('./my-project')
|
||||
console.log(analysis.techStack)
|
||||
// { framework: 'Next.js', language: 'TypeScript', styling: 'Tailwind' }
|
||||
|
||||
// Generate instructions for specific agents
|
||||
const instructions = await generateInstructions(analysis, {
|
||||
agents: ['claude', 'cursor', 'windsurf'],
|
||||
includeExamples: true,
|
||||
tone: 'detailed',
|
||||
})
|
||||
|
||||
// Write to files
|
||||
for (const [agent, content] of Object.entries(instructions)) {
|
||||
await fs.writeFile(`.${agent}/instructions.md`, content)
|
||||
}
|
||||
```
|
||||
|
||||
## Mesh Network
|
||||
|
||||
```typescript
|
||||
import { MeshHost, PeerIdentity } from '@skillkit/mesh'
|
||||
|
||||
// Generate identity
|
||||
const identity = await PeerIdentity.generate()
|
||||
|
||||
// Create mesh host
|
||||
const host = new MeshHost({
|
||||
hostId: 'my-workstation',
|
||||
identity,
|
||||
security: { mode: 'secure' },
|
||||
})
|
||||
|
||||
await host.start()
|
||||
|
||||
// Send message to peer
|
||||
await host.send('peer-fingerprint', {
|
||||
type: 'skill-sync',
|
||||
payload: { skills: ['react-patterns'] },
|
||||
})
|
||||
|
||||
// Listen for messages
|
||||
host.on('message', (msg) => {
|
||||
console.log('Received:', msg.type, 'from', msg.from)
|
||||
})
|
||||
```
|
||||
|
||||
## Inter-Agent Messaging
|
||||
|
||||
```typescript
|
||||
import { MessagingClient } from '@skillkit/messaging'
|
||||
|
||||
// Create messaging client (host is a MeshHost instance from the example above)
|
||||
const messaging = new MessagingClient({
|
||||
meshHost: host, // See MeshHost setup in "Mesh Network" section above
|
||||
storagePath: '~/.skillkit/messages',
|
||||
})
|
||||
|
||||
await messaging.init()
|
||||
|
||||
// Send a message
|
||||
await messaging.send({
|
||||
to: 'claude@laptop',
|
||||
subject: 'Code review completed',
|
||||
body: 'I reviewed the auth module...',
|
||||
priority: 'normal',
|
||||
})
|
||||
|
||||
// Listen for new messages
|
||||
messaging.on('message', (msg) => {
|
||||
console.log('New message from:', msg.from)
|
||||
console.log('Subject:', msg.subject)
|
||||
})
|
||||
|
||||
// Get inbox
|
||||
const inbox = await messaging.getInbox({ unread: true })
|
||||
```
|
||||
|
||||
## Workflow Orchestration
|
||||
|
||||
```typescript
|
||||
import { WorkflowEngine, WorkflowStep } from '@skillkit/core'
|
||||
|
||||
// Define workflow
|
||||
const workflow = {
|
||||
name: 'feature-development',
|
||||
steps: [
|
||||
{ skill: 'tdd-workflow', action: 'write-tests' },
|
||||
{ skill: 'code-implementation', action: 'implement' },
|
||||
{ skill: 'code-review', action: 'review' },
|
||||
{ skill: 'documentation', action: 'update-docs' },
|
||||
],
|
||||
}
|
||||
|
||||
// Execute workflow
|
||||
const engine = new WorkflowEngine()
|
||||
const result = await engine.run(workflow)
|
||||
|
||||
console.log('Workflow completed:', result.status)
|
||||
console.log('Steps executed:', result.steps.length)
|
||||
```
|
||||
|
||||
## Skill Testing
|
||||
|
||||
```typescript
|
||||
import { SkillTestRunner, SkillTest } from '@skillkit/core'
|
||||
|
||||
// Define test
|
||||
const test: SkillTest = {
|
||||
name: 'pdf-processing',
|
||||
setup: async () => {
|
||||
// Setup test environment
|
||||
},
|
||||
assertions: [
|
||||
{
|
||||
type: 'file_exists',
|
||||
path: './output.pdf',
|
||||
},
|
||||
{
|
||||
type: 'content_includes',
|
||||
text: 'Expected content',
|
||||
},
|
||||
],
|
||||
}
|
||||
|
||||
// Run test
|
||||
const runner = new SkillTestRunner()
|
||||
const result = await runner.run(test)
|
||||
|
||||
console.log('Test passed:', result.passed)
|
||||
console.log('Assertions:', result.assertions)
|
||||
```
|
||||
|
||||
## Types
|
||||
|
||||
```typescript
|
||||
interface Skill {
|
||||
name: string
|
||||
description: string
|
||||
path: string
|
||||
content: string
|
||||
metadata: SkillMetadata
|
||||
enabled: boolean
|
||||
agent: string
|
||||
}
|
||||
|
||||
interface SkillMetadata {
|
||||
version?: string
|
||||
author?: string
|
||||
tags?: string[]
|
||||
dependencies?: string[]
|
||||
quality?: QualityScore
|
||||
}
|
||||
|
||||
interface QualityScore {
|
||||
total: number // 0-100
|
||||
structure: number // 0-25
|
||||
clarity: number // 0-30
|
||||
specificity: number // 0-30
|
||||
advanced: number // 0-15
|
||||
}
|
||||
|
||||
interface Recommendation {
|
||||
skill: Skill
|
||||
score: number
|
||||
reasons: string[]
|
||||
}
|
||||
|
||||
interface ProjectAnalysis {
|
||||
techStack: {
|
||||
framework?: string
|
||||
language: string
|
||||
styling?: string
|
||||
testing?: string
|
||||
packageManager: string
|
||||
}
|
||||
patterns: {
|
||||
architecture: string
|
||||
codeStyle: Record<string, any>
|
||||
directory: string
|
||||
}
|
||||
dependencies: Record<string, string>
|
||||
}
|
||||
|
||||
interface MeshMessage {
|
||||
from: string
|
||||
to: string
|
||||
type: string
|
||||
payload: any
|
||||
timestamp: number
|
||||
signature?: string
|
||||
}
|
||||
|
||||
interface WorkflowResult {
|
||||
status: 'success' | 'failure'
|
||||
steps: WorkflowStepResult[]
|
||||
duration: number
|
||||
}
|
||||
```
|
||||
|
||||
## Package Exports
|
||||
|
||||
### @skillkit/core
|
||||
|
||||
```typescript
|
||||
export {
|
||||
// Discovery
|
||||
findAllSkills,
|
||||
findSkill,
|
||||
|
||||
// Quality
|
||||
evaluateSkillContent,
|
||||
getQualityGrade,
|
||||
|
||||
// Translation
|
||||
translateSkill,
|
||||
|
||||
// Memory
|
||||
MemoryCompressor,
|
||||
LearningStore,
|
||||
|
||||
// Recommendations
|
||||
RecommendationEngine,
|
||||
analyzeProject,
|
||||
|
||||
// Primer
|
||||
generateInstructions,
|
||||
|
||||
// Workflows
|
||||
WorkflowEngine,
|
||||
|
||||
// Testing
|
||||
SkillTestRunner,
|
||||
}
|
||||
```
|
||||
|
||||
### @skillkit/mesh
|
||||
|
||||
```typescript
|
||||
export {
|
||||
MeshHost,
|
||||
PeerIdentity,
|
||||
PeerRegistry,
|
||||
SecureTransport,
|
||||
}
|
||||
```
|
||||
|
||||
### @skillkit/messaging
|
||||
|
||||
```typescript
|
||||
export {
|
||||
MessagingClient,
|
||||
MessageBuilder,
|
||||
MessageRouter,
|
||||
}
|
||||
```
|
||||
|
||||
### @skillkit/memory
|
||||
|
||||
```typescript
|
||||
export {
|
||||
MemoryStore,
|
||||
TierManager,
|
||||
EmbeddingEncoder,
|
||||
}
|
||||
```
|
||||
|
||||
## Full Example: Custom Build Pipeline
|
||||
|
||||
```typescript
|
||||
import { promises as fs } from 'node:fs'
|
||||
import {
|
||||
analyzeProject,
|
||||
generateInstructions,
|
||||
RecommendationEngine,
|
||||
translateSkill,
|
||||
} from '@skillkit/core'
|
||||
|
||||
async function setupProject() {
|
||||
// 1. Analyze project
|
||||
const analysis = await analyzeProject('./my-project')
|
||||
|
||||
// 2. Generate base instructions
|
||||
const instructions = await generateInstructions(analysis, {
|
||||
agents: ['claude', 'cursor', 'windsurf'],
|
||||
})
|
||||
|
||||
// 3. Get recommendations
|
||||
const engine = new RecommendationEngine()
|
||||
const recommendations = engine.recommend(analysis)
|
||||
|
||||
// 4. Install top recommendations
|
||||
const topSkills = recommendations.slice(0, 5)
|
||||
for (const rec of topSkills) {
|
||||
console.log(`Installing ${rec.skill.name} (${rec.score}% match)`)
|
||||
}
|
||||
|
||||
// 5. Translate skills to all agents
|
||||
for (const agent of ['claude', 'cursor', 'windsurf']) {
|
||||
const translated = await translateSkill(
|
||||
topSkills[0].skill.content,
|
||||
agent
|
||||
)
|
||||
await fs.writeFile(`.${agent}/skills/${translated.filename}`, translated.content)
|
||||
}
|
||||
|
||||
console.log('✅ Project setup complete!')
|
||||
}
|
||||
|
||||
setupProject()
|
||||
```
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [Commands Reference](/docs/commands) - CLI commands
|
||||
- [Memory System](/docs/memory) - Persistent learning
|
||||
- [Mesh Network](/docs/mesh) - Multi-machine setup
|
||||
- [Workflows](/docs/workflows) - Automation
|
||||
- [Testing](/docs/testing) - Skill validation
|
||||
@@ -0,0 +1,65 @@
|
||||
---
|
||||
title: CI/CD
|
||||
description: Integrate SkillKit into CI/CD pipelines
|
||||
---
|
||||
|
||||
# CI/CD Integration
|
||||
|
||||
Generate templates for automated skill management.
|
||||
|
||||
## Generate Templates
|
||||
|
||||
```bash
|
||||
skillkit cicd init --provider github
|
||||
skillkit cicd init --provider gitlab
|
||||
skillkit cicd init --provider circleci
|
||||
```
|
||||
|
||||
## GitHub Actions
|
||||
|
||||
```yaml
|
||||
name: SkillKit
|
||||
on: [push, pull_request]
|
||||
|
||||
jobs:
|
||||
validate:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: '20'
|
||||
- run: npm install -g skillkit
|
||||
- run: skillkit validate
|
||||
- run: skillkit test --json > results.json
|
||||
```
|
||||
|
||||
## GitLab CI
|
||||
|
||||
```yaml
|
||||
validate-skills:
|
||||
image: node:20
|
||||
script:
|
||||
- npm install -g skillkit
|
||||
- skillkit validate
|
||||
- skillkit test
|
||||
```
|
||||
|
||||
## Pre-commit
|
||||
|
||||
```yaml
|
||||
repos:
|
||||
- repo: local
|
||||
hooks:
|
||||
- id: skillkit-validate
|
||||
name: Validate Skills
|
||||
entry: skillkit validate
|
||||
language: system
|
||||
```
|
||||
|
||||
## Best Practices
|
||||
|
||||
- Validate on PR
|
||||
- Test in CI with `--json`
|
||||
- Sync only on main branch
|
||||
- Cache npm packages
|
||||
@@ -0,0 +1,444 @@
|
||||
---
|
||||
title: CLI Commands
|
||||
description: Complete reference for all SkillKit CLI commands
|
||||
---
|
||||
|
||||
# CLI Commands
|
||||
|
||||
SkillKit provides 50+ commands organized into functional categories. Built on Clipanion v4 with interactive prompts via @clack/prompts.
|
||||
|
||||
## Global Options
|
||||
|
||||
| Option | Short | Purpose |
|
||||
|--------|-------|---------|
|
||||
| `--help` | `-h` | Display command help |
|
||||
| `--version` | `-v` | Show version info |
|
||||
| `--quiet` | `-q` | Minimal output, no logo |
|
||||
|
||||
## Install Command
|
||||
|
||||
Install skills from GitHub, GitLab, Bitbucket, or local paths.
|
||||
|
||||
```bash
|
||||
skillkit install <source> [options]
|
||||
```
|
||||
|
||||
### Source Formats
|
||||
|
||||
| Format | Example |
|
||||
|--------|---------|
|
||||
| GitHub | `owner/repo` or full URL |
|
||||
| GitLab | `gitlab:owner/repo` |
|
||||
| Bitbucket | `bitbucket:owner/repo` |
|
||||
| Local Path | `./path` or `~/path` |
|
||||
|
||||
### Install Options
|
||||
|
||||
| Option | Short | Type | Purpose |
|
||||
|--------|-------|------|---------|
|
||||
| `--skills` | `-s` | string | Comma-separated skill names |
|
||||
| `--all` | `-a` | boolean | Install all discovered skills |
|
||||
| `--yes` | `-y` | boolean | Skip confirmation prompts |
|
||||
| `--global` | `-g` | boolean | Install to global directory |
|
||||
| `--force` | `-f` | boolean | Overwrite existing skills |
|
||||
| `--provider` | `-p` | string | Force provider: GitHub, GitLab, Bitbucket |
|
||||
| `--list` | `-l` | boolean | List available skills without installing |
|
||||
| `--agent` | — | array | Target specific agents (repeatable) |
|
||||
|
||||
### Examples
|
||||
|
||||
```bash
|
||||
# Interactive installation
|
||||
skillkit install anthropics/skills
|
||||
|
||||
# CI/CD installation (no prompts)
|
||||
skillkit install anthropics/skills --skills=pdf,xlsx --agent claude --yes
|
||||
|
||||
# List available skills
|
||||
skillkit install anthropics/skills --list
|
||||
|
||||
# Force overwrite
|
||||
skillkit install anthropics/skills --skills=pdf --force
|
||||
|
||||
# Install for multiple agents
|
||||
skillkit install anthropics/skills --agent claude --agent cursor
|
||||
```
|
||||
|
||||
## Remove Command
|
||||
|
||||
```bash
|
||||
skillkit remove <skill-names> [options]
|
||||
```
|
||||
|
||||
| Option | Purpose |
|
||||
|--------|---------|
|
||||
| `--agent` | Target specific agents (default: all) |
|
||||
| `--yes` | Skip confirmation |
|
||||
| `--keep-metadata` | Remove skill but preserve metadata |
|
||||
|
||||
## Update Command
|
||||
|
||||
```bash
|
||||
skillkit update [skill-names] [options]
|
||||
```
|
||||
|
||||
| Option | Purpose |
|
||||
|--------|---------|
|
||||
| `--dry-run` | Check for updates without installing |
|
||||
| `--yes` | Skip confirmation prompts |
|
||||
| `--agent` | Update in specific agents only |
|
||||
|
||||
## Enable/Disable Commands
|
||||
|
||||
```bash
|
||||
skillkit enable <skill-names> [options]
|
||||
skillkit disable <skill-names> [options]
|
||||
```
|
||||
|
||||
Disabled skills are ignored by the `sync` command. No file changes occur.
|
||||
|
||||
## List Command
|
||||
|
||||
```bash
|
||||
skillkit list [options]
|
||||
```
|
||||
|
||||
Lists installed skills with quality grades.
|
||||
|
||||
## Sync Command
|
||||
|
||||
```bash
|
||||
skillkit sync [options]
|
||||
```
|
||||
|
||||
Synchronizes enabled skills to agent configuration files.
|
||||
|
||||
## Recommend Command
|
||||
|
||||
```bash
|
||||
skillkit recommend [options]
|
||||
```
|
||||
|
||||
AI-powered recommendations based on project analysis.
|
||||
|
||||
| Option | Purpose |
|
||||
|--------|---------|
|
||||
| `--search` | Task-based search |
|
||||
| `--category` | Filter by category |
|
||||
| `--min-score` | Quality threshold |
|
||||
|
||||
## Generate Command
|
||||
|
||||
AI-powered skill generation with multi-source context and agent optimization.
|
||||
|
||||
```bash
|
||||
skillkit generate [options]
|
||||
```
|
||||
|
||||
### Generate Options
|
||||
|
||||
| Option | Type | Purpose |
|
||||
|--------|------|---------|
|
||||
| `--provider` | string | LLM provider: anthropic, openai, google, ollama, openrouter |
|
||||
| `--model` | string | Specific model (e.g., gpt-4o, gemini-2.0-flash) |
|
||||
| `--compose` | string | Natural language search to find skills to compose |
|
||||
| `--agents` | array | Target agents for optimization |
|
||||
| `--no-memory` | boolean | Skip memory context |
|
||||
| `--context-sources` | string | Comma-separated: docs,codebase,skills,memory |
|
||||
|
||||
### Context Sources
|
||||
|
||||
The wizard gathers context from 4 sources:
|
||||
|
||||
| Source | Description |
|
||||
|--------|-------------|
|
||||
| **Documentation** | Library docs via Context7 MCP |
|
||||
| **Codebase** | Local project patterns and conventions |
|
||||
| **Skills** | 15,000+ marketplace skills for composition |
|
||||
| **Memory** | Your corrections and learned patterns |
|
||||
|
||||
### Examples
|
||||
|
||||
```bash
|
||||
# Interactive wizard (recommended)
|
||||
skillkit generate
|
||||
|
||||
# Use specific provider
|
||||
skillkit generate --provider openai --model gpt-4o
|
||||
|
||||
# Compose from existing skills
|
||||
skillkit generate --compose "testing patterns for react"
|
||||
|
||||
# Generate for specific agents
|
||||
skillkit generate --agents claude-code,cursor
|
||||
|
||||
# Skip memory personalization
|
||||
skillkit generate --no-memory
|
||||
```
|
||||
|
||||
### Trust Score
|
||||
|
||||
Generated skills receive a trust score (0-10):
|
||||
|
||||
| Grade | Score | Meaning |
|
||||
|-------|-------|---------|
|
||||
| Trusted | 8-10 | High clarity, well-bounded |
|
||||
| Review | 5-7 | May need refinement |
|
||||
| Caution | 0-4 | Requires careful review |
|
||||
|
||||
### Agent Compatibility
|
||||
|
||||
The wizard shows compatibility scores for each target agent based on:
|
||||
- Context length limits
|
||||
- MCP/tool support
|
||||
- Format requirements
|
||||
|
||||
## Marketplace Command
|
||||
|
||||
```bash
|
||||
skillkit marketplace [options]
|
||||
skillkit marketplace search <query>
|
||||
```
|
||||
|
||||
Browse 15,000+ indexed skills from the aggregated catalog.
|
||||
|
||||
| Option | Purpose |
|
||||
|--------|---------|
|
||||
| `--tags` | Filter by tags |
|
||||
| `--refresh` | Force refresh index |
|
||||
|
||||
## Manifest Commands
|
||||
|
||||
Team collaboration via Git-committable `.skills` file.
|
||||
|
||||
```bash
|
||||
skillkit manifest init # Create .skills file
|
||||
skillkit manifest add <source> # Add skill source
|
||||
skillkit manifest install # Install from manifest
|
||||
```
|
||||
|
||||
### Manifest File Format
|
||||
|
||||
```text
|
||||
# GitHub skills
|
||||
anthropics/skills
|
||||
vercel-labs/agent-skills
|
||||
|
||||
# Local skills
|
||||
./local-skills
|
||||
|
||||
# Specific versions
|
||||
owner/repo@v1.2.3
|
||||
```
|
||||
|
||||
## Memory Commands
|
||||
|
||||
```bash
|
||||
skillkit memory status # View memory status
|
||||
skillkit memory search <query> # Search learnings
|
||||
skillkit memory compress # Compress observations to learnings
|
||||
skillkit memory export <name> # Export learnings as skill
|
||||
skillkit memory sync-claude # Update CLAUDE.md with learnings
|
||||
skillkit memory index # View memory index (Layer 1)
|
||||
skillkit memory --global # Use global memory
|
||||
```
|
||||
|
||||
| Option | Purpose |
|
||||
|--------|---------|
|
||||
| `--global` | Use global memory instead of project |
|
||||
| `--limit` | Limit number of results |
|
||||
| `--tags` | Filter by tags |
|
||||
|
||||
## Translation Commands
|
||||
|
||||
```bash
|
||||
skillkit translate <skill> --to <agent>
|
||||
skillkit translate --all --to <agent>
|
||||
skillkit translate <skill> --to <agent> --dry-run
|
||||
```
|
||||
|
||||
## Agent Commands
|
||||
|
||||
```bash
|
||||
skillkit agent list # List agents
|
||||
skillkit agent show <name> # Show details
|
||||
skillkit agent create <name> # Create agent
|
||||
skillkit agent translate --source ./path --to cursor
|
||||
skillkit agent translate --source ./path --to cursor --recursive
|
||||
skillkit agent sync # Sync to target
|
||||
skillkit agent validate # Validate definitions
|
||||
```
|
||||
|
||||
## Context Commands
|
||||
|
||||
```bash
|
||||
skillkit context init # Initialize project context
|
||||
skillkit context sync # Sync context to agents
|
||||
```
|
||||
|
||||
## Test Command
|
||||
|
||||
```bash
|
||||
skillkit test [path] # Run skill tests
|
||||
skillkit test --tags unit # Filter by tags
|
||||
skillkit test --json # JSON output for CI
|
||||
```
|
||||
|
||||
## Workflow Commands
|
||||
|
||||
```bash
|
||||
skillkit workflow list # List workflows
|
||||
skillkit workflow run <name> # Execute workflow
|
||||
skillkit workflow create <name> # Create workflow
|
||||
```
|
||||
|
||||
## CI/CD Commands
|
||||
|
||||
```bash
|
||||
skillkit cicd github-action # Generate GitHub Actions
|
||||
skillkit cicd gitlab-ci # Generate GitLab CI
|
||||
skillkit cicd pre-commit # Generate pre-commit hooks
|
||||
```
|
||||
|
||||
## Serve Command
|
||||
|
||||
Start the SkillKit REST API server for runtime skill discovery.
|
||||
|
||||
```bash
|
||||
skillkit serve [options]
|
||||
```
|
||||
|
||||
| Option | Short | Default | Description |
|
||||
|--------|-------|---------|-------------|
|
||||
| `--port` | `-p` | `3737` | Port to listen on |
|
||||
| `--host` | `-H` | `0.0.0.0` | Host to bind to |
|
||||
| `--cors` | — | `*` | CORS allowed origin |
|
||||
| `--cache-ttl` | — | `86400000` | Cache TTL in milliseconds |
|
||||
|
||||
### Examples
|
||||
|
||||
```bash
|
||||
# Start with defaults
|
||||
skillkit serve
|
||||
|
||||
# Custom port and host
|
||||
skillkit serve --port 8080 --host localhost
|
||||
|
||||
# Restricted CORS
|
||||
skillkit serve --cors "http://localhost:3000"
|
||||
|
||||
# Short cache TTL (1 hour)
|
||||
skillkit serve --cache-ttl 3600000
|
||||
```
|
||||
|
||||
### Endpoints
|
||||
|
||||
| Method | Path | Description |
|
||||
|--------|------|-------------|
|
||||
| GET | `/search?q=...` | Search skills |
|
||||
| POST | `/search` | Search with filters |
|
||||
| GET | `/skills/:owner/:repo/:id` | Get specific skill |
|
||||
| GET | `/trending?limit=20` | Trending skills |
|
||||
| GET | `/categories` | Skill categories |
|
||||
| GET | `/health` | Server health |
|
||||
| GET | `/cache/stats` | Cache statistics |
|
||||
|
||||
## Utility Commands
|
||||
|
||||
```bash
|
||||
skillkit init # Initialize project
|
||||
skillkit create <name> # Create new skill
|
||||
skillkit validate [path] # Validate skill format
|
||||
skillkit read <skills> # Read skill content
|
||||
skillkit settings --set key=value # Configure settings
|
||||
```
|
||||
|
||||
## Publishing Commands
|
||||
|
||||
```bash
|
||||
skillkit publish [path] # Generate well-known hosting structure
|
||||
skillkit publish --output dir # Output to specific directory
|
||||
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
|
||||
skillkit scan <path> --quiet # Suppress non-essential output
|
||||
```
|
||||
|
||||
**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
|
||||
skillkit ui # Launch terminal UI
|
||||
skillkit # Same as above
|
||||
```
|
||||
|
||||
**Navigation Keys:**
|
||||
|
||||
| Key | Action |
|
||||
|-----|--------|
|
||||
| `h` | Home |
|
||||
| `b` | Browse |
|
||||
| `m` | Marketplace |
|
||||
| `r` | Recommend |
|
||||
| `t` | Translate |
|
||||
| `c` | Context |
|
||||
| `i` | Installed |
|
||||
| `s` | Sync |
|
||||
| `/` | Help |
|
||||
| `q` | Quit |
|
||||
|
||||
## Exit Codes
|
||||
|
||||
| Code | Meaning |
|
||||
|------|---------|
|
||||
| 0 | Success |
|
||||
| 1 | General error |
|
||||
| 2 | Invalid arguments |
|
||||
| 3 | Configuration issue |
|
||||
| 4 | Network problem |
|
||||
| 5 | Filesystem error |
|
||||
|
||||
## Quality Grades
|
||||
|
||||
Skills receive automatic quality scores mapped to grades:
|
||||
|
||||
| Grade | Score Range |
|
||||
|-------|-------------|
|
||||
| A | 90-100 |
|
||||
| B | 80-89 |
|
||||
| C | 70-79 |
|
||||
| D | 60-69 |
|
||||
| F | Below 60 |
|
||||
|
||||
Skills with score below 60 trigger warning displays before installation.
|
||||
@@ -0,0 +1,217 @@
|
||||
---
|
||||
title: Configuration
|
||||
description: Configure SkillKit at project and user levels
|
||||
---
|
||||
|
||||
# Configuration
|
||||
|
||||
SkillKit uses a layered configuration system with five priority levels (lowest to highest):
|
||||
|
||||
1. Default values in code
|
||||
2. Global user preferences (`~/.skillkit/preferences.json`)
|
||||
3. Project settings (`skillkit.yaml`)
|
||||
4. Environment variables
|
||||
5. CLI flags
|
||||
|
||||
## Project Configuration
|
||||
|
||||
Create `skillkit.yaml` in your project root:
|
||||
|
||||
```yaml
|
||||
version: 1
|
||||
agent: cursor # Override auto-detection
|
||||
autoSync: true # Sync on changes
|
||||
|
||||
enabledSkills:
|
||||
- pdf
|
||||
- xlsx
|
||||
- react-patterns
|
||||
|
||||
disabledSkills:
|
||||
- deprecated-skill
|
||||
|
||||
skillsDir: ./custom-skills # Custom directory
|
||||
|
||||
sources: # Default sources
|
||||
- anthropics/skills
|
||||
- vercel-labs/agent-skills
|
||||
```
|
||||
|
||||
## Manifest File
|
||||
|
||||
The `.skills` file enables Git-based team sharing:
|
||||
|
||||
```yaml
|
||||
version: 1
|
||||
skills:
|
||||
- source: anthropics/skills
|
||||
skills: [pdf, xlsx]
|
||||
- source: vercel-labs/agent-skills
|
||||
skills: [react-patterns]
|
||||
```
|
||||
|
||||
Commands:
|
||||
|
||||
```bash
|
||||
skillkit manifest init # Create .skills
|
||||
skillkit manifest add <skill> # Add skill
|
||||
skillkit manifest install # Install all
|
||||
```
|
||||
|
||||
## User Preferences
|
||||
|
||||
Global preferences in `~/.skillkit/preferences.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"lastAgents": ["claude-code", "cursor"],
|
||||
"defaultAgent": "claude-code",
|
||||
"theme": "dark"
|
||||
}
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
| Variable | Purpose |
|
||||
|----------|---------|
|
||||
| `SKILLKIT_AGENT` | Override default agent |
|
||||
| `SKILLKIT_DIR` | Custom SkillKit directory |
|
||||
| `SKILLKIT_DEBUG` | Enable debug logging |
|
||||
|
||||
## CLI Settings
|
||||
|
||||
```bash
|
||||
skillkit settings --set agent=cursor
|
||||
skillkit settings --set autoSync=true
|
||||
skillkit settings --get agent
|
||||
```
|
||||
|
||||
## Advanced Configuration
|
||||
|
||||
### Memory System
|
||||
|
||||
```yaml
|
||||
# skillkit.yaml
|
||||
memory:
|
||||
enabled: true
|
||||
tier: personal # personal, project, global
|
||||
compression:
|
||||
minObservations: 10 # Compress after N observations
|
||||
autoExport: true # Auto-export as skills
|
||||
storage:
|
||||
backend: cozodb # cozodb, sqlite, memory
|
||||
path: ~/.skillkit/memory
|
||||
```
|
||||
|
||||
### Mesh Network
|
||||
|
||||
```yaml
|
||||
# skillkit.yaml
|
||||
mesh:
|
||||
enabled: true
|
||||
hostId: my-workstation
|
||||
discovery:
|
||||
method: local # local, tailscale, manual
|
||||
port: 9876
|
||||
security:
|
||||
mode: secure # development, signed, secure, strict
|
||||
keyPath: ~/.skillkit/mesh/keys
|
||||
peers:
|
||||
- id: laptop-dev
|
||||
address: 192.168.1.100
|
||||
trusted: true
|
||||
```
|
||||
|
||||
### Messaging
|
||||
|
||||
```yaml
|
||||
# skillkit.yaml
|
||||
messaging:
|
||||
enabled: true
|
||||
storagePath: ~/.skillkit/messages
|
||||
notifications: true
|
||||
autoArchive:
|
||||
enabled: true
|
||||
afterDays: 30
|
||||
```
|
||||
|
||||
### Primer
|
||||
|
||||
```yaml
|
||||
# skillkit.yaml
|
||||
primer:
|
||||
autoGenerate: true # Generate on changes
|
||||
agents:
|
||||
priority: [claude, cursor, windsurf]
|
||||
customize:
|
||||
tone: detailed # concise, detailed, technical
|
||||
includeExamples: true
|
||||
exclude:
|
||||
- node_modules
|
||||
- dist
|
||||
- .next
|
||||
```
|
||||
|
||||
## Directory Structure
|
||||
|
||||
```
|
||||
~/.skillkit/
|
||||
├── preferences.json # User preferences
|
||||
├── cache/ # Marketplace cache
|
||||
├── memory/ # Learning storage
|
||||
│ ├── observations/
|
||||
│ ├── learnings/
|
||||
│ └── index.json
|
||||
├── mesh/ # Mesh network
|
||||
│ ├── keys/ # Encryption keys
|
||||
│ ├── peers.json # Known peers
|
||||
│ └── config.json
|
||||
└── messages/ # Inter-agent messages
|
||||
├── inbox/
|
||||
├── sent/
|
||||
└── archived/
|
||||
|
||||
./project/
|
||||
├── skillkit.yaml # Project config
|
||||
├── .skills # Team manifest
|
||||
├── skills/ # Local skills
|
||||
└── .skillkit/ # Project-specific
|
||||
├── cache/
|
||||
├── primer-config.json
|
||||
└── memory/
|
||||
```
|
||||
|
||||
## Configuration Profiles
|
||||
|
||||
Create different profiles for different environments:
|
||||
|
||||
```yaml
|
||||
# skillkit.yaml
|
||||
profiles:
|
||||
development:
|
||||
agent: claude
|
||||
autoSync: true
|
||||
mesh:
|
||||
security:
|
||||
mode: development
|
||||
|
||||
production:
|
||||
agent: universal
|
||||
autoSync: false
|
||||
mesh:
|
||||
security:
|
||||
mode: strict
|
||||
```
|
||||
|
||||
Use profiles:
|
||||
|
||||
```bash
|
||||
skillkit --profile production sync
|
||||
```
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [Primer](/docs/primer) - Auto-generate instructions
|
||||
- [Memory System](/docs/memory) - Persistent learning
|
||||
- [Mesh Network](/docs/mesh) - Multi-machine setup
|
||||
- [Team Collaboration](/docs/teams) - Team configuration
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
title: Contributing
|
||||
description: Contribute to SkillKit development
|
||||
---
|
||||
|
||||
# Contributing
|
||||
|
||||
## Setup
|
||||
|
||||
```bash
|
||||
git clone https://github.com/rohitg00/skillkit.git
|
||||
cd skillkit
|
||||
pnpm install
|
||||
pnpm build
|
||||
pnpm test
|
||||
```
|
||||
|
||||
## Requirements
|
||||
|
||||
- Node.js 18+
|
||||
- pnpm 8+
|
||||
- Bun 1.2+ (TUI)
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
skillkit/
|
||||
├── packages/
|
||||
│ ├── core/ # Business logic
|
||||
│ ├── cli/ # CLI
|
||||
│ ├── tui/ # Terminal UI
|
||||
│ └── agents/ # 32 adapters
|
||||
├── marketplace/ # Skills data
|
||||
│ ├── skills.json
|
||||
│ └── sources.json
|
||||
└── docs/
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
git checkout -b feat/my-feature
|
||||
pnpm test
|
||||
pnpm lint
|
||||
pnpm build
|
||||
```
|
||||
|
||||
## Code Style
|
||||
|
||||
- ES modules
|
||||
- `function` keyword
|
||||
- Explicit return types
|
||||
- No unnecessary comments
|
||||
- No nested ternaries
|
||||
|
||||
## Commits
|
||||
|
||||
```
|
||||
feat: add feature
|
||||
fix: resolve bug
|
||||
docs: update docs
|
||||
test: add tests
|
||||
```
|
||||
|
||||
## Links
|
||||
|
||||
- [GitHub Issues](https://github.com/rohitg00/skillkit/issues)
|
||||
- [GitHub Discussions](https://github.com/rohitg00/skillkit/discussions)
|
||||
@@ -0,0 +1,59 @@
|
||||
---
|
||||
title: Custom Agents
|
||||
description: Create custom AI sub-agent definitions
|
||||
---
|
||||
|
||||
# Custom Agents
|
||||
|
||||
Create and manage custom AI sub-agents.
|
||||
|
||||
## Commands
|
||||
|
||||
```bash
|
||||
skillkit agent list # List agents
|
||||
skillkit agent show <name> # Show details
|
||||
skillkit agent create <name> # Create agent
|
||||
skillkit agent translate # Translate format
|
||||
skillkit agent sync # Sync to target
|
||||
skillkit agent validate # Validate
|
||||
```
|
||||
|
||||
## Agent Definition
|
||||
|
||||
```yaml
|
||||
name: my-agent
|
||||
description: Custom agent for tasks
|
||||
format: skill.md
|
||||
skillsDir: .my-agent/skills/
|
||||
|
||||
capabilities:
|
||||
- code-generation
|
||||
- code-review
|
||||
|
||||
triggers:
|
||||
- pattern: "create component"
|
||||
action: generate-component
|
||||
```
|
||||
|
||||
## Structure
|
||||
|
||||
```
|
||||
.my-agent/
|
||||
├── agent.yaml # Definition
|
||||
├── skills/ # Agent skills
|
||||
└── config/ # Settings
|
||||
```
|
||||
|
||||
## Translation
|
||||
|
||||
```bash
|
||||
skillkit agent translate --source ./my-agent --to cursor
|
||||
skillkit agent translate --source ./agents --to cursor --recursive
|
||||
```
|
||||
|
||||
## Validation
|
||||
|
||||
```bash
|
||||
skillkit agent validate
|
||||
skillkit agent validate ./my-agent
|
||||
```
|
||||
@@ -0,0 +1,153 @@
|
||||
---
|
||||
title: SkillKit
|
||||
description: Universal skill management for AI coding agents
|
||||
---
|
||||
|
||||
# SkillKit
|
||||
|
||||
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.
|
||||
|
||||
## Get Started
|
||||
|
||||
```bash
|
||||
npx skillkit@latest
|
||||
```
|
||||
|
||||
That's it. No global install needed. Or if you prefer:
|
||||
|
||||
```bash
|
||||
npm install -g skillkit
|
||||
skillkit init
|
||||
skillkit install anthropics/skills
|
||||
skillkit sync
|
||||
```
|
||||
|
||||
Four commands. Your agents now have skills for PDF processing, code review, and more.
|
||||
|
||||
## What Can You Do?
|
||||
|
||||
### Install skills from anywhere
|
||||
|
||||
```bash
|
||||
skillkit install anthropics/skills # GitHub
|
||||
skillkit install gitlab:team/skills # GitLab
|
||||
skillkit install ./my-local-skills # Local
|
||||
```
|
||||
|
||||
### Translate between agents
|
||||
|
||||
Write for Claude, deploy to Cursor:
|
||||
|
||||
```bash
|
||||
skillkit translate my-skill --to cursor
|
||||
skillkit translate --all --to windsurf # All skills at once
|
||||
```
|
||||
|
||||
### Get smart recommendations
|
||||
|
||||
SkillKit reads your `package.json`, detects your stack, and suggests relevant skills:
|
||||
|
||||
```bash
|
||||
skillkit recommend
|
||||
# 92% vercel-react-best-practices
|
||||
# 87% tailwind-v4-patterns
|
||||
# 85% nextjs-app-router
|
||||
```
|
||||
|
||||
### Discover skills at runtime
|
||||
|
||||
Start an API server and let agents find skills on demand:
|
||||
|
||||
```bash
|
||||
skillkit serve
|
||||
# Server running at http://localhost:3737
|
||||
```
|
||||
|
||||
```bash
|
||||
curl "http://localhost:3737/search?q=react+performance"
|
||||
```
|
||||
|
||||
Or use MCP for native agent integration:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"skillkit": { "command": "npx", "args": ["@skillkit/mcp"] }
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
[REST API](/docs/rest-api) | [MCP Server](/docs/mcp-server) | [Python Client](/docs/python-client)
|
||||
|
||||
## How It Works
|
||||
|
||||
SkillKit sits between your skills and your agents. It handles format translation, discovery, and synchronization automatically.
|
||||
|
||||
| Layer | What It Does |
|
||||
|-------|-------------|
|
||||
| **CLI + TUI** | Install, translate, recommend, sync |
|
||||
| **APIs** | REST server on :3737, MCP via stdio |
|
||||
| **Core** | Translation engine, relevance ranker, skill parser |
|
||||
| **Data** | 15,000+ skills from 31 curated sources |
|
||||
|
||||
## Supported Agents
|
||||
|
||||
32 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)
|
||||
|
||||
## Beyond Basic Skills
|
||||
|
||||
### Session Memory
|
||||
|
||||
Your AI agents learn patterns during sessions, then forget everything. SkillKit captures those learnings and makes them permanent.
|
||||
|
||||
```bash
|
||||
skillkit memory compress
|
||||
skillkit memory search "auth patterns"
|
||||
skillkit memory export auth-patterns
|
||||
```
|
||||
|
||||
### Primer
|
||||
|
||||
Auto-generate CLAUDE.md, .cursorrules, and agent instructions by analyzing your codebase:
|
||||
|
||||
```bash
|
||||
skillkit primer --all-agents
|
||||
```
|
||||
|
||||
### Mesh Network
|
||||
|
||||
Distribute agents across machines with encrypted P2P:
|
||||
|
||||
```bash
|
||||
skillkit mesh init
|
||||
skillkit mesh discover
|
||||
```
|
||||
|
||||
### Team Collaboration
|
||||
|
||||
Share skills via a Git-committable `.skills` manifest:
|
||||
|
||||
```bash
|
||||
skillkit manifest init
|
||||
skillkit manifest add anthropics/skills
|
||||
git commit -m "add team skills"
|
||||
```
|
||||
|
||||
Team members run `skillkit manifest install` and they're in sync.
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [Installation](/docs/installation) — Install and configure
|
||||
- [Quick Start](/docs/quickstart) — First project setup
|
||||
- [Commands](/docs/commands) — Full CLI reference
|
||||
- [REST API](/docs/rest-api) — Runtime discovery server
|
||||
- [MCP Server](/docs/mcp-server) — Agent-native discovery
|
||||
- [Python Client](/docs/python-client) — Python SDK
|
||||
|
||||
**Current version:** v1.12.0 | [npm](https://www.npmjs.com/package/skillkit) | [GitHub](https://github.com/rohitg00/skillkit) | Apache-2.0
|
||||
@@ -0,0 +1,86 @@
|
||||
---
|
||||
title: Installation
|
||||
description: Install SkillKit and set up your first project
|
||||
---
|
||||
|
||||
# Installation
|
||||
|
||||
## No install needed
|
||||
|
||||
The fastest way to start:
|
||||
|
||||
```bash
|
||||
npx skillkit@latest
|
||||
```
|
||||
|
||||
This runs the latest version directly. No global install, no setup.
|
||||
|
||||
## Global install
|
||||
|
||||
For frequent use, install globally:
|
||||
|
||||
```bash
|
||||
npm install -g skillkit
|
||||
```
|
||||
|
||||
Also works with pnpm, yarn, or bun:
|
||||
|
||||
```bash
|
||||
pnpm add -g skillkit
|
||||
yarn global add skillkit
|
||||
bun add -g skillkit
|
||||
```
|
||||
|
||||
Both `skillkit` and `sk` work as command aliases.
|
||||
|
||||
## Verify
|
||||
|
||||
```bash
|
||||
skillkit --version
|
||||
```
|
||||
|
||||
**Requirements:** Node.js 18+ (Bun 1.2+ for the TUI).
|
||||
|
||||
## Initialize a project
|
||||
|
||||
```bash
|
||||
cd my-project
|
||||
skillkit init
|
||||
```
|
||||
|
||||
The init command:
|
||||
|
||||
1. **Detects your AI agent** — scans for `.claude/`, `.cursor/`, `.github/` directories
|
||||
2. **Creates the skills folder** — sets up the right directory for your agent
|
||||
3. **Saves preferences** — remembers your choices for next time
|
||||
|
||||
### Specify an agent directly
|
||||
|
||||
```bash
|
||||
skillkit init --agent cursor
|
||||
skillkit init --list # Show all 32 supported agents
|
||||
skillkit init --quiet # Skip logo and prompts (for CI)
|
||||
```
|
||||
|
||||
### What gets created
|
||||
|
||||
| Agent | Skills Directory | Config |
|
||||
|-------|-----------------|--------|
|
||||
| Claude Code | `.claude/skills/` | `.claude/config.json` |
|
||||
| Cursor | `.cursor/skills/` | `.cursor/config.mdc` |
|
||||
| Codex | `.codex/skills/` | `AGENTS.md` |
|
||||
| GitHub Copilot | `.github/skills/` | — |
|
||||
| Universal | `skills/` | `AGENTS.md` |
|
||||
|
||||
Preferences are stored in `~/.skillkit/preferences.json`.
|
||||
|
||||
## Next steps
|
||||
|
||||
```bash
|
||||
skillkit recommend # Get skill suggestions for your project
|
||||
skillkit install anthropics/skills # Install skills from GitHub
|
||||
skillkit sync # Deploy to your agent
|
||||
skillkit ui # Launch the terminal UI
|
||||
```
|
||||
|
||||
[Quick Start guide](/docs/quickstart) | [Full command reference](/docs/commands)
|
||||
@@ -0,0 +1,86 @@
|
||||
---
|
||||
title: Marketplace
|
||||
description: Browse and install from 15,000+ curated skills
|
||||
---
|
||||
|
||||
# Marketplace
|
||||
|
||||
The SkillKit marketplace indexes 15,000+ skills from curated sources.
|
||||
|
||||
## Browse
|
||||
|
||||
```bash
|
||||
skillkit marketplace
|
||||
```
|
||||
|
||||
## Search
|
||||
|
||||
```bash
|
||||
skillkit marketplace search "react hooks"
|
||||
```
|
||||
|
||||
## Filter by Tags
|
||||
|
||||
```bash
|
||||
skillkit marketplace --tags typescript,testing
|
||||
```
|
||||
|
||||
## Refresh Index
|
||||
|
||||
```bash
|
||||
skillkit marketplace refresh
|
||||
```
|
||||
|
||||
## Popular Sources
|
||||
|
||||
| Repository | Description |
|
||||
|------------|-------------|
|
||||
| [anthropics/skills](https://github.com/anthropics/skills) | PDF, XLSX, DOCX processing |
|
||||
| [vercel-labs/agent-skills](https://github.com/vercel-labs/agent-skills) | React/Next.js best practices |
|
||||
|
||||
## Install from Marketplace
|
||||
|
||||
```bash
|
||||
skillkit install anthropics/skills
|
||||
skillkit install anthropics/skills --skills pdf,xlsx
|
||||
skillkit install anthropics/skills --agent claude-code,cursor
|
||||
```
|
||||
|
||||
## Publish Skills
|
||||
|
||||
### Self-Host on Your Domain (Recommended)
|
||||
|
||||
Generate a well-known URI structure (RFC 8615) to host skills on your own domain:
|
||||
|
||||
```bash
|
||||
# Create and validate your skill
|
||||
skillkit create my-skill
|
||||
skillkit validate my-skill
|
||||
|
||||
# Generate hosting structure
|
||||
skillkit publish ./my-skill --output ./public
|
||||
```
|
||||
|
||||
This creates:
|
||||
```
|
||||
.well-known/skills/
|
||||
index.json # Skill manifest for auto-discovery
|
||||
my-skill/
|
||||
SKILL.md # Your skill content
|
||||
```
|
||||
|
||||
Deploy the `.well-known` folder to your web server. Users can then install via:
|
||||
|
||||
```bash
|
||||
skillkit add https://your-domain.com
|
||||
```
|
||||
|
||||
### Submit to SkillKit Marketplace
|
||||
|
||||
To submit your skill for inclusion in the central marketplace:
|
||||
|
||||
```bash
|
||||
skillkit publish submit
|
||||
```
|
||||
|
||||
This opens a GitHub issue for review by maintainers.
|
||||
@@ -0,0 +1,105 @@
|
||||
---
|
||||
title: MCP Server
|
||||
description: Agent-native skill discovery via Model Context Protocol
|
||||
---
|
||||
|
||||
# MCP Server
|
||||
|
||||
The REST API works great for HTTP clients. But AI agents speak MCP — the Model Context Protocol. The `@skillkit/mcp` package lets agents discover skills natively, without HTTP calls or curl commands.
|
||||
|
||||
Think of it as giving your agent a direct line to the entire skill catalog.
|
||||
|
||||
## Setup
|
||||
|
||||
### Claude Desktop
|
||||
|
||||
Add this to `~/Library/Application Support/Claude/claude_desktop_config.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"skillkit": {
|
||||
"command": "npx",
|
||||
"args": ["@skillkit/mcp"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Restart Claude Desktop. Done.
|
||||
|
||||
### Cursor
|
||||
|
||||
Add to `.cursor/mcp.json` in your project:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"skillkit": {
|
||||
"command": "npx",
|
||||
"args": ["@skillkit/mcp"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Any MCP client
|
||||
|
||||
The server uses stdio transport. Works with any MCP-compatible client:
|
||||
|
||||
```bash
|
||||
npx @skillkit/mcp
|
||||
```
|
||||
|
||||
## What your agent can do
|
||||
|
||||
Once connected, your agent gets four tools:
|
||||
|
||||
### Search skills
|
||||
|
||||
Ask your agent: *"Find skills for React performance optimization"*
|
||||
|
||||
Behind the scenes, it calls `search_skills` with your query and returns ranked results. You can filter by tags, category, or source repository.
|
||||
|
||||
```
|
||||
> Search for authentication skills tagged with "security"
|
||||
```
|
||||
|
||||
The agent searches across the full catalog, ranks results by relevance, and shows you the best matches.
|
||||
|
||||
### Get a specific skill
|
||||
|
||||
Ask: *"Get the pdf-processing skill from anthropics/skills"*
|
||||
|
||||
The agent calls `get_skill` and returns the full skill details — description, tags, content, and references.
|
||||
|
||||
### Get recommendations
|
||||
|
||||
Ask: *"What skills would you recommend for my TypeScript React project?"*
|
||||
|
||||
The agent calls `recommend_skills` with your stack context (languages, frameworks, libraries) and returns personalized suggestions ranked by relevance.
|
||||
|
||||
### Browse categories
|
||||
|
||||
Ask: *"What skill categories are available?"*
|
||||
|
||||
The agent calls `list_categories` and returns all categories with counts, so you know what's out there.
|
||||
|
||||
## Resources
|
||||
|
||||
The server also exposes two read-only resources:
|
||||
|
||||
- **`skills://trending`** — Top 20 skills by relevance score
|
||||
- **`skills://categories`** — All categories with counts
|
||||
|
||||
Agents can read these without making a tool call.
|
||||
|
||||
## How it works
|
||||
|
||||
1. On startup, the server loads all skills from the marketplace catalog
|
||||
2. Your agent sends a natural language request
|
||||
3. The MCP client translates it into a tool call
|
||||
4. The `RelevanceRanker` scores and ranks results (same algorithm as the REST API)
|
||||
5. Results come back as structured JSON through the MCP protocol
|
||||
|
||||
Same ranking, same data, same quality — just native to your agent instead of going through HTTP.
|
||||
@@ -0,0 +1,179 @@
|
||||
---
|
||||
title: Memory System
|
||||
description: Persistent learning across AI agent sessions
|
||||
---
|
||||
|
||||
# Memory System
|
||||
|
||||
Capture learnings from AI sessions and convert them into reusable skills. SkillKit's memory system provides automatic observation capture, intelligent compression, and token-optimized retrieval.
|
||||
|
||||
## Commands
|
||||
|
||||
```bash
|
||||
skillkit memory status # View status
|
||||
skillkit memory search <q> # Search learnings
|
||||
skillkit memory compress # Compress observations to learnings
|
||||
skillkit memory export <name> # Export as skill
|
||||
skillkit memory sync-claude # Update CLAUDE.md with learnings
|
||||
skillkit memory index # View memory index (Layer 1)
|
||||
skillkit memory --global # Global memory operations
|
||||
```
|
||||
|
||||
## How It Works
|
||||
|
||||
### Observation → Learning Pipeline
|
||||
|
||||
1. **Observations** - Track patterns during sessions (tool use, errors, solutions)
|
||||
2. **Compression** - Distill observations into reusable learnings
|
||||
3. **Injection** - Load relevant learnings into new sessions
|
||||
4. **Export** - Convert to shareable skills
|
||||
|
||||
### Lifecycle Hooks
|
||||
|
||||
SkillKit integrates with Claude Code's lifecycle hooks for automatic memory capture:
|
||||
|
||||
| Hook | Trigger | Action |
|
||||
|------|---------|--------|
|
||||
| **SessionStart** | Session begins | Inject relevant learnings |
|
||||
| **PostToolUse** | Tool completes | Capture outcomes as observations |
|
||||
| **SessionEnd** | Session closes | Compress observations to learnings |
|
||||
|
||||
### Progressive Disclosure (Token Optimization)
|
||||
|
||||
Memory retrieval uses a 3-layer system to minimize token usage:
|
||||
|
||||
| Layer | Content | ~Tokens |
|
||||
|-------|---------|---------|
|
||||
| **Index** | Titles, tags, timestamps | 50-100 |
|
||||
| **Timeline** | Context, excerpts, activity | ~200 |
|
||||
| **Details** | Full content, metadata | 500-1000 |
|
||||
|
||||
The system starts with Layer 1 and progressively fetches deeper layers based on relevance and token budget.
|
||||
|
||||
## Storage
|
||||
|
||||
```
|
||||
~/.skillkit/memory/
|
||||
├── observations/ # Raw session data
|
||||
├── learnings/ # Compressed knowledge
|
||||
└── index.json # Memory index
|
||||
|
||||
<project>/.skillkit/memory/
|
||||
├── observations/ # Project-specific observations
|
||||
├── learnings/ # Project learnings
|
||||
└── index.json # Project memory index
|
||||
```
|
||||
|
||||
## Auto-CLAUDE.md Updates
|
||||
|
||||
Sync your most effective learnings to CLAUDE.md:
|
||||
|
||||
```bash
|
||||
skillkit memory sync-claude
|
||||
```
|
||||
|
||||
This populates the `## LEARNED` section with high-effectiveness insights, giving your agent persistent context across sessions.
|
||||
|
||||
## Programmatic API
|
||||
|
||||
### Memory Compression
|
||||
|
||||
```typescript
|
||||
import { MemoryCompressor, LearningStore } from '@skillkit/core'
|
||||
|
||||
const compressor = new MemoryCompressor(projectPath)
|
||||
const { learnings } = await compressor.compress(observations)
|
||||
|
||||
const store = new LearningStore('project', projectPath)
|
||||
await store.add(learning)
|
||||
const results = await store.search('authentication')
|
||||
```
|
||||
|
||||
### Lifecycle Hooks
|
||||
|
||||
```typescript
|
||||
import { MemoryHookManager } from '@skillkit/core'
|
||||
|
||||
const manager = new MemoryHookManager(projectPath)
|
||||
|
||||
// Session start - inject relevant learnings
|
||||
const startResult = await manager.onSessionStart()
|
||||
|
||||
// After tool use - capture outcomes
|
||||
await manager.onToolUse({
|
||||
tool_name: 'Write',
|
||||
tool_input: { file_path: '/src/auth.ts' },
|
||||
tool_result: 'File written successfully',
|
||||
duration_ms: 150
|
||||
})
|
||||
|
||||
// Session end - compress to learnings
|
||||
const endResult = await manager.onSessionEnd()
|
||||
```
|
||||
|
||||
### Progressive Disclosure
|
||||
|
||||
```typescript
|
||||
import { ProgressiveDisclosureManager } from '@skillkit/core'
|
||||
|
||||
const pdm = new ProgressiveDisclosureManager(projectPath)
|
||||
|
||||
// Layer 1: Index (~50 tokens each)
|
||||
const index = pdm.getIndex({ includeGlobal: true })
|
||||
|
||||
// Layer 2: Timeline (~200 tokens each)
|
||||
const timeline = pdm.getTimeline(['id1', 'id2'])
|
||||
|
||||
// Layer 3: Full details (~600 tokens each)
|
||||
const details = pdm.getDetails(['id1'])
|
||||
|
||||
// Smart retrieval with token budget
|
||||
const result = pdm.smartRetrieve('authentication patterns', 2000)
|
||||
// Returns optimal layer based on budget
|
||||
```
|
||||
|
||||
### CLAUDE.md Updater
|
||||
|
||||
```typescript
|
||||
import { ClaudeMdUpdater } from '@skillkit/core'
|
||||
|
||||
const updater = new ClaudeMdUpdater(projectPath)
|
||||
|
||||
// Preview what would be updated
|
||||
const preview = updater.preview({ minEffectiveness: 70 })
|
||||
|
||||
// Update CLAUDE.md
|
||||
const result = updater.update({
|
||||
minEffectiveness: 60,
|
||||
maxLearnings: 20,
|
||||
preserveManualEntries: true
|
||||
})
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
Configure memory behavior in `.skillkit/config.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"memory": {
|
||||
"enabled": true,
|
||||
"autoInjectOnSessionStart": true,
|
||||
"autoCaptureToolUse": true,
|
||||
"autoCompressOnSessionEnd": true,
|
||||
"minRelevanceForCapture": 30,
|
||||
"maxTokensForInjection": 2000,
|
||||
"compressionThreshold": 50
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Claude Code Integration
|
||||
|
||||
Generate hooks configuration for Claude Code:
|
||||
|
||||
```typescript
|
||||
const manager = new MemoryHookManager(projectPath)
|
||||
const config = manager.generateClaudeCodeHooksConfig()
|
||||
// Outputs hooks.json format for Claude Code integration
|
||||
```
|
||||
@@ -0,0 +1,118 @@
|
||||
---
|
||||
title: Mesh Network
|
||||
description: Multi-machine agent distribution with secure peer-to-peer communication
|
||||
---
|
||||
|
||||
# Mesh Network
|
||||
|
||||
SkillKit's mesh network enables secure communication between AI agents across multiple machines. Share skills, synchronize memory, and collaborate across your development environment.
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Initialize mesh on your machine
|
||||
npx skillkit mesh init
|
||||
|
||||
# Discover other hosts on your LAN
|
||||
npx skillkit mesh discover
|
||||
|
||||
# Add a specific host
|
||||
npx skillkit mesh add 192.168.1.100
|
||||
```
|
||||
|
||||
## Security
|
||||
|
||||
The mesh network uses enterprise-grade security:
|
||||
|
||||
- **Ed25519** - Peer identity and message signing
|
||||
- **XChaCha20-Poly1305** - End-to-end message encryption
|
||||
- **TLS 1.3** - Transport layer security
|
||||
- **JWT with EdDSA** - Authentication tokens
|
||||
|
||||
### Initialize Security
|
||||
|
||||
```bash
|
||||
# Generate encryption keys
|
||||
npx skillkit mesh security init
|
||||
|
||||
# Check security status
|
||||
npx skillkit mesh security status
|
||||
```
|
||||
|
||||
### Peer Trust Management
|
||||
|
||||
```bash
|
||||
# Trust a peer by fingerprint
|
||||
npx skillkit mesh peer trust abc123def456
|
||||
|
||||
# Revoke a peer's trust
|
||||
npx skillkit mesh peer revoke abc123def456
|
||||
|
||||
# List trusted peers
|
||||
npx skillkit mesh peer list
|
||||
```
|
||||
|
||||
## Commands Reference
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `mesh init` | Initialize mesh network |
|
||||
| `mesh add <address>` | Add a host to mesh |
|
||||
| `mesh remove <id>` | Remove a host |
|
||||
| `mesh list` | List known hosts |
|
||||
| `mesh discover` | Discover hosts on LAN |
|
||||
| `mesh health` | Check host health |
|
||||
| `mesh status` | Show mesh status |
|
||||
| `mesh security init` | Setup encryption keys |
|
||||
| `mesh security status` | Show security status |
|
||||
| `mesh peer trust <id>` | Trust a peer |
|
||||
| `mesh peer revoke <id>` | Revoke peer trust |
|
||||
| `mesh peer list` | List trusted peers |
|
||||
|
||||
## Security Levels
|
||||
|
||||
| Level | Discovery | Transport | Auth | Use Case |
|
||||
|-------|-----------|-----------|------|----------|
|
||||
| `development` | open | none | none | Local dev |
|
||||
| `signed` | signed | optional | optional | Trusted LAN |
|
||||
| `secure` (default) | signed | required | required | Production |
|
||||
| `strict` | trusted-only | required | mTLS | High security |
|
||||
|
||||
## Architecture
|
||||
|
||||
The mesh network uses:
|
||||
|
||||
1. **UDP Multicast** - LAN discovery with signed announcements
|
||||
2. **WebSocket (WSS)** - Real-time bidirectional communication
|
||||
3. **HTTPS** - RESTful API for management
|
||||
|
||||
All messages are signed and optionally encrypted based on your security level.
|
||||
|
||||
## Programmatic API
|
||||
|
||||
```typescript
|
||||
import { MeshHost, PeerIdentity } from '@skillkit/mesh';
|
||||
|
||||
// Generate identity
|
||||
const identity = await PeerIdentity.generate();
|
||||
|
||||
// Create mesh host
|
||||
const host = new MeshHost({
|
||||
hostId: 'my-workstation',
|
||||
identity,
|
||||
security: { mode: 'secure' },
|
||||
});
|
||||
|
||||
await host.start();
|
||||
|
||||
// Send message to peer
|
||||
await host.send('peer-fingerprint', {
|
||||
type: 'skill-sync',
|
||||
payload: { skills: ['react-patterns'] },
|
||||
});
|
||||
```
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [Inter-Agent Messaging](/docs/messaging) - Send messages between agents
|
||||
- [Memory System](/docs/memory) - Share learnings across the mesh
|
||||
@@ -0,0 +1,98 @@
|
||||
---
|
||||
title: Inter-Agent Messaging
|
||||
description: Send messages between AI agents across the mesh network
|
||||
---
|
||||
|
||||
# Inter-Agent Messaging
|
||||
|
||||
SkillKit's messaging system enables asynchronous communication between AI agents. Send code reviews, share insights, and coordinate work across your team.
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Send a message
|
||||
npx skillkit message send
|
||||
|
||||
# View inbox
|
||||
npx skillkit message inbox
|
||||
|
||||
# Read a message
|
||||
npx skillkit message read <message-id>
|
||||
```
|
||||
|
||||
## Commands Reference
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `message send` | Send message to agent |
|
||||
| `message inbox` | View inbox |
|
||||
| `message read <id>` | Read a message |
|
||||
| `message reply <id>` | Reply to message |
|
||||
| `message archive <id>` | Archive message |
|
||||
| `message sent` | View sent messages |
|
||||
| `message status` | Messaging status |
|
||||
|
||||
## Message Types
|
||||
|
||||
Messages can include:
|
||||
|
||||
- **Text** - Plain text messages
|
||||
- **Code** - Code snippets with syntax highlighting
|
||||
- **Diffs** - Code changes and patches
|
||||
- **Skills** - Skill file attachments
|
||||
|
||||
## Priority Levels
|
||||
|
||||
- **urgent** - Immediate attention required
|
||||
- **normal** - Standard priority (default)
|
||||
- **low** - Can be addressed when convenient
|
||||
|
||||
## Inbox Management
|
||||
|
||||
```bash
|
||||
# View unread messages
|
||||
npx skillkit message inbox --unread
|
||||
|
||||
# Archive old messages
|
||||
npx skillkit message archive <id>
|
||||
|
||||
# View sent messages
|
||||
npx skillkit message sent
|
||||
```
|
||||
|
||||
## Programmatic API
|
||||
|
||||
```typescript
|
||||
import { MessagingClient } from '@skillkit/messaging';
|
||||
import { MeshHost } from '@skillkit/mesh';
|
||||
|
||||
// Create messaging client
|
||||
const messaging = new MessagingClient({
|
||||
meshHost: host,
|
||||
storagePath: '~/.skillkit/messages',
|
||||
});
|
||||
|
||||
await messaging.init();
|
||||
|
||||
// Send a message
|
||||
await messaging.send({
|
||||
to: 'claude@laptop',
|
||||
subject: 'Code review completed',
|
||||
body: 'I reviewed the auth module...',
|
||||
priority: 'normal',
|
||||
});
|
||||
|
||||
// Listen for new messages
|
||||
messaging.on('message', (msg) => {
|
||||
console.log('New message from:', msg.from);
|
||||
});
|
||||
```
|
||||
|
||||
## TUI Navigation
|
||||
|
||||
In the Terminal UI, press `j` to access the Messages screen.
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [Mesh Network](/docs/mesh) - Configure the underlying network
|
||||
- [Team Collaboration](/docs/teams) - Share skills with your team
|
||||
@@ -0,0 +1,31 @@
|
||||
{
|
||||
"title": "SkillKit",
|
||||
"pages": [
|
||||
"index",
|
||||
"installation",
|
||||
"quickstart",
|
||||
"tui",
|
||||
"skills",
|
||||
"agents",
|
||||
"translation",
|
||||
"marketplace",
|
||||
"tree",
|
||||
"recommendations",
|
||||
"primer",
|
||||
"memory",
|
||||
"mesh",
|
||||
"messaging",
|
||||
"workflows",
|
||||
"testing",
|
||||
"commands",
|
||||
"configuration",
|
||||
"api-reference",
|
||||
"rest-api",
|
||||
"mcp-server",
|
||||
"python-client",
|
||||
"cicd",
|
||||
"teams",
|
||||
"custom-agents",
|
||||
"contributing"
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,303 @@
|
||||
---
|
||||
title: Primer
|
||||
description: Auto-generate AI agent instructions from your codebase
|
||||
---
|
||||
|
||||
# Primer
|
||||
|
||||
Primer analyzes your codebase and automatically generates optimized instructions for all 32 AI agents. No more manual configuration—let SkillKit detect your tech stack, coding patterns, and project structure.
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Analyze current project
|
||||
skillkit primer
|
||||
|
||||
# Generate for specific agents
|
||||
skillkit primer --agent claude,cursor,windsurf
|
||||
|
||||
# Generate for all 32 agents
|
||||
skillkit primer --all-agents
|
||||
|
||||
# Preview without writing files
|
||||
skillkit primer --dry-run
|
||||
```
|
||||
|
||||
## What Primer Detects
|
||||
|
||||
### Tech Stack
|
||||
- **Frameworks**: React, Next.js, Vue, Angular, Svelte, etc.
|
||||
- **Languages**: TypeScript, JavaScript, Python, Go, Rust, etc.
|
||||
- **Build Tools**: Vite, Webpack, Turbopack, esbuild
|
||||
- **Package Managers**: npm, pnpm, yarn, bun
|
||||
|
||||
### Project Patterns
|
||||
- **Architecture**: Monorepo, microservices, serverless
|
||||
- **Code Style**: Formatting rules, naming conventions
|
||||
- **Directory Structure**: Feature-based, layer-based, domain-driven
|
||||
- **Dependencies**: Key libraries and their versions
|
||||
|
||||
### Best Practices
|
||||
- **Testing Setup**: Jest, Vitest, Playwright, Cypress
|
||||
- **Linting**: ESLint, Prettier, TypeScript strict mode
|
||||
- **Documentation**: JSDoc, TSDoc, README patterns
|
||||
- **Git Workflow**: Branch strategy, commit conventions
|
||||
|
||||
## Generated Instructions
|
||||
|
||||
Primer creates agent-specific instructions for:
|
||||
|
||||
### Claude Code
|
||||
```
|
||||
.claude/
|
||||
└── CLAUDE.md # Full project context
|
||||
```
|
||||
|
||||
### Cursor
|
||||
```
|
||||
.cursor/
|
||||
└── .cursorrules # IDE-specific rules
|
||||
```
|
||||
|
||||
### GitHub Copilot
|
||||
```
|
||||
.github/
|
||||
└── copilot-instructions.md
|
||||
```
|
||||
|
||||
### All 32 Agents
|
||||
Each agent gets optimized instructions in their native format.
|
||||
|
||||
## Example Output
|
||||
|
||||
```bash
|
||||
$ skillkit primer
|
||||
|
||||
🔍 Analyzing project...
|
||||
|
||||
Detected:
|
||||
Framework: Next.js 14 (App Router)
|
||||
Language: TypeScript (strict mode)
|
||||
Styling: Tailwind CSS v3
|
||||
Testing: Vitest + Playwright
|
||||
Package Manager: pnpm
|
||||
|
||||
✅ Generated instructions for:
|
||||
- Claude Code (.claude/CLAUDE.md)
|
||||
- Cursor (.cursor/.cursorrules)
|
||||
- Codex (.codex/instructions.md)
|
||||
+ 29 more agents
|
||||
|
||||
💡 Tip: Run `skillkit sync` to apply changes
|
||||
```
|
||||
|
||||
## Customization
|
||||
|
||||
### Configuration File
|
||||
|
||||
Create `.skillkit/primer-config.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"include": {
|
||||
"techStack": true,
|
||||
"codeStyle": true,
|
||||
"testingPatterns": true,
|
||||
"customRules": [
|
||||
"Always use async/await over promises",
|
||||
"Prefer functional components in React",
|
||||
"Use Zod for runtime validation"
|
||||
]
|
||||
},
|
||||
"exclude": {
|
||||
"directories": ["node_modules", "dist", ".next"],
|
||||
"patterns": ["*.test.ts", "*.spec.ts"]
|
||||
},
|
||||
"agents": {
|
||||
"priority": ["claude", "cursor", "windsurf"],
|
||||
"customize": {
|
||||
"claude": {
|
||||
"tone": "detailed",
|
||||
"examples": true
|
||||
},
|
||||
"cursor": {
|
||||
"tone": "concise",
|
||||
"shortcuts": true
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Template Overrides
|
||||
|
||||
Override default templates in `.skillkit/primer-templates/`:
|
||||
|
||||
```
|
||||
.skillkit/primer-templates/
|
||||
├── claude.template.md
|
||||
├── cursor.template.md
|
||||
└── shared/
|
||||
├── header.md
|
||||
└── footer.md
|
||||
```
|
||||
|
||||
## Update Strategies
|
||||
|
||||
### Incremental Updates
|
||||
|
||||
```bash
|
||||
# Update only when changes detected
|
||||
skillkit primer --incremental
|
||||
|
||||
# Force regeneration
|
||||
skillkit primer --force
|
||||
```
|
||||
|
||||
### Git Integration
|
||||
|
||||
```bash
|
||||
# Auto-generate on git hooks
|
||||
cat > .git/hooks/post-checkout << 'EOF'
|
||||
#!/usr/bin/env bash
|
||||
skillkit primer --incremental
|
||||
EOF
|
||||
chmod +x .git/hooks/post-checkout
|
||||
```
|
||||
|
||||
### CI/CD Pipeline
|
||||
|
||||
```yaml
|
||||
# .github/workflows/primer.yml
|
||||
name: Update Agent Instructions
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
paths:
|
||||
- 'package.json'
|
||||
- 'tsconfig.json'
|
||||
- 'src/**'
|
||||
|
||||
jobs:
|
||||
primer:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- run: npx skillkit primer --all-agents
|
||||
- uses: stefanzweifel/git-auto-commit-action@v4
|
||||
with:
|
||||
commit_message: "chore: update agent instructions"
|
||||
```
|
||||
|
||||
## Programmatic API
|
||||
|
||||
```typescript
|
||||
import { analyzeProject, generateInstructions } from '@skillkit/core';
|
||||
|
||||
// Analyze project
|
||||
const analysis = await analyzeProject('./my-project');
|
||||
console.log(analysis.techStack);
|
||||
// { framework: 'Next.js', language: 'TypeScript', ... }
|
||||
|
||||
// Generate instructions
|
||||
const instructions = await generateInstructions(analysis, {
|
||||
agents: ['claude', 'cursor'],
|
||||
includeExamples: true,
|
||||
tone: 'detailed',
|
||||
});
|
||||
|
||||
// Write to files
|
||||
for (const [agent, content] of Object.entries(instructions)) {
|
||||
await writeAgentFile(agent, content);
|
||||
}
|
||||
```
|
||||
|
||||
## Best Practices
|
||||
|
||||
### When to Run Primer
|
||||
|
||||
- **Initial Setup** - First time configuring agents
|
||||
- **Major Changes** - New frameworks or architecture changes
|
||||
- **Team Onboarding** - New developers joining the project
|
||||
- **Agent Migration** - Switching to new AI coding tools
|
||||
|
||||
### What to Commit
|
||||
|
||||
```text
|
||||
# Commit generated instructions
|
||||
.claude/
|
||||
.cursor/
|
||||
.github/copilot-instructions.md
|
||||
|
||||
# Don't commit
|
||||
.skillkit/cache/
|
||||
.skillkit/primer-temp/
|
||||
```
|
||||
|
||||
### Combining with Skills
|
||||
|
||||
Primer generates base instructions. Layer on specific skills:
|
||||
|
||||
```bash
|
||||
# 1. Generate base instructions
|
||||
skillkit primer --all-agents
|
||||
|
||||
# 2. Install domain-specific skills
|
||||
skillkit install anthropics/skills --skill pdf,xlsx
|
||||
|
||||
# 3. Sync everything
|
||||
skillkit sync
|
||||
```
|
||||
|
||||
## Comparison
|
||||
|
||||
| Method | Setup Time | Accuracy | Maintenance |
|
||||
|--------|-----------|----------|-------------|
|
||||
| **Manual Writing** | Hours | Variable | Manual updates |
|
||||
| **AI Generation** | Minutes | High | Auto-detect changes |
|
||||
| **Copy/Paste** | Minutes | Low | Stale quickly |
|
||||
| **Primer** | Seconds | Very High | Auto-incremental |
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Primer Not Detecting Framework
|
||||
|
||||
```bash
|
||||
# Specify manually
|
||||
skillkit primer --framework nextjs --language typescript
|
||||
|
||||
# Check detection logs
|
||||
skillkit primer --verbose
|
||||
```
|
||||
|
||||
### Generated Instructions Too Generic
|
||||
|
||||
Customize with `primer-config.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"tone": "detailed",
|
||||
"includeExamples": true,
|
||||
"customRules": [
|
||||
"Your specific coding guidelines..."
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### Instructions Out of Sync
|
||||
|
||||
```bash
|
||||
# Force regeneration
|
||||
skillkit primer --force
|
||||
|
||||
# Clean cache
|
||||
rm -rf .skillkit/cache/primer
|
||||
```
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [Memory System](/docs/memory) - Capture learnings from sessions
|
||||
- [Skills](/docs/skills) - Install domain-specific skills
|
||||
- [Translation](/docs/translation) - Convert between agent formats
|
||||
- [Team Collaboration](/docs/teams) - Share instructions with your team
|
||||
@@ -0,0 +1,105 @@
|
||||
---
|
||||
title: Python Client
|
||||
description: Async Python SDK for skill discovery
|
||||
---
|
||||
|
||||
# Python Client
|
||||
|
||||
Not everything runs on Node. The `skillkit-client` package gives Python apps the same skill discovery capabilities as the REST API — async, typed, and ready to go.
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
pip install skillkit-client
|
||||
```
|
||||
|
||||
Requires Python 3.10+.
|
||||
|
||||
## Quick start
|
||||
|
||||
```python
|
||||
from skillkit import SkillKitClient
|
||||
|
||||
async with SkillKitClient() as client:
|
||||
results = await client.search("react performance", limit=5)
|
||||
for skill in results.skills:
|
||||
print(f"{skill.name}: {skill.description}")
|
||||
```
|
||||
|
||||
The client connects to `http://localhost:3737` by default. Make sure the API server is running:
|
||||
|
||||
```bash
|
||||
skillkit serve
|
||||
```
|
||||
|
||||
## Search with filters
|
||||
|
||||
```python
|
||||
results = await client.search_with_filters(
|
||||
"authentication",
|
||||
tags=["security"],
|
||||
category="backend",
|
||||
limit=10,
|
||||
)
|
||||
```
|
||||
|
||||
## Get a specific skill
|
||||
|
||||
```python
|
||||
skill = await client.get_skill("anthropics/skills", "pdf-processing")
|
||||
print(skill.name, skill.description, skill.tags)
|
||||
```
|
||||
|
||||
## Trending and categories
|
||||
|
||||
```python
|
||||
trending = await client.trending(limit=10)
|
||||
categories = await client.categories()
|
||||
|
||||
for skill in trending:
|
||||
print(f"{skill.name} ({skill.source})")
|
||||
|
||||
for cat in categories:
|
||||
print(f"{cat.name}: {cat.count} skills")
|
||||
```
|
||||
|
||||
## Health and cache
|
||||
|
||||
```python
|
||||
health = await client.health()
|
||||
print(f"v{health.version} — {health.skill_count} skills loaded")
|
||||
|
||||
stats = await client.cache_stats()
|
||||
print(f"Cache hit rate: {stats.hit_rate:.0%}")
|
||||
```
|
||||
|
||||
## Connect to a remote server
|
||||
|
||||
```python
|
||||
async with SkillKitClient("https://my-server.example.com:3737") as client:
|
||||
results = await client.search("deployment")
|
||||
```
|
||||
|
||||
## Models
|
||||
|
||||
The client returns typed dataclasses:
|
||||
|
||||
```python
|
||||
Skill(name, source, description, tags, category, content, score)
|
||||
SearchResponse(skills, total, query, limit)
|
||||
HealthResponse(status, version, skill_count, uptime)
|
||||
Category(name, count)
|
||||
CacheStats(hits, misses, size, max_size, hit_rate)
|
||||
```
|
||||
|
||||
All fields except `name` and `source` on `Skill` are optional — they depend on what the server returns and whether you requested `include_content`.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
The Python client talks to the SkillKit REST API. You need a running server:
|
||||
|
||||
```bash
|
||||
skillkit serve
|
||||
```
|
||||
|
||||
Then run your Python script in another terminal. The client handles connection management, retries, and cleanup automatically when used with `async with`.
|
||||
@@ -0,0 +1,122 @@
|
||||
---
|
||||
title: Quick Start
|
||||
description: Get productive with SkillKit in under 5 minutes
|
||||
---
|
||||
|
||||
# Quick Start
|
||||
|
||||
Go from zero to skills-enabled in four steps.
|
||||
|
||||
## 1. Init
|
||||
|
||||
```bash
|
||||
npx skillkit@latest init
|
||||
```
|
||||
|
||||
SkillKit detects your AI agent, creates the skills directory, and saves your preferences.
|
||||
|
||||
## 2. Get recommendations
|
||||
|
||||
```bash
|
||||
skillkit recommend
|
||||
```
|
||||
|
||||
SkillKit reads your project (package.json, languages, frameworks) and suggests relevant skills:
|
||||
|
||||
```
|
||||
Project: my-app (Next.js + TypeScript + Tailwind)
|
||||
|
||||
Recommended Skills:
|
||||
92% vercel-react-best-practices
|
||||
87% tailwind-v4-patterns
|
||||
85% nextjs-app-router
|
||||
```
|
||||
|
||||
## 3. Install
|
||||
|
||||
```bash
|
||||
skillkit install anthropics/skills
|
||||
```
|
||||
|
||||
Pick which skills to install, choose target agents, and you're set. For CI/CD or scripting:
|
||||
|
||||
```bash
|
||||
skillkit install anthropics/skills --skills=pdf,xlsx --agent claude --yes
|
||||
```
|
||||
|
||||
Install for multiple agents at once:
|
||||
|
||||
```bash
|
||||
skillkit install vercel-labs/agent-skills --agent claude,cursor,windsurf
|
||||
```
|
||||
|
||||
## 4. Sync
|
||||
|
||||
```bash
|
||||
skillkit sync
|
||||
```
|
||||
|
||||
Skills are now in your agent's configuration. Start coding.
|
||||
|
||||
## What else?
|
||||
|
||||
### Translate between agents
|
||||
|
||||
Already have Claude skills? Deploy them to Cursor:
|
||||
|
||||
```bash
|
||||
skillkit translate my-skill --to cursor
|
||||
```
|
||||
|
||||
### Auto-generate agent instructions
|
||||
|
||||
Let SkillKit analyze your codebase and create CLAUDE.md, .cursorrules, etc.:
|
||||
|
||||
```bash
|
||||
skillkit primer --all-agents
|
||||
```
|
||||
|
||||
### Launch the TUI
|
||||
|
||||
```bash
|
||||
skillkit ui
|
||||
```
|
||||
|
||||
`h` Home | `m` Marketplace | `r` Recommend | `i` Installed | `s` Sync | `q` Quit
|
||||
|
||||
### Start the discovery server
|
||||
|
||||
Let agents find skills at runtime:
|
||||
|
||||
```bash
|
||||
skillkit serve
|
||||
```
|
||||
|
||||
[REST API](/docs/rest-api) | [MCP Server](/docs/mcp-server)
|
||||
|
||||
### Share with your team
|
||||
|
||||
```bash
|
||||
skillkit manifest init
|
||||
skillkit manifest add anthropics/skills
|
||||
git add .skills && git commit -m "add team skills"
|
||||
```
|
||||
|
||||
Team members run `skillkit manifest install` and get the same setup.
|
||||
|
||||
## Full workflow
|
||||
|
||||
```bash
|
||||
npx skillkit@latest init # Detect agents, create dirs
|
||||
skillkit recommend # Get smart suggestions
|
||||
skillkit install anthropics/skills # Install from marketplace
|
||||
skillkit primer --all-agents # Generate agent instructions
|
||||
skillkit sync # Deploy everything
|
||||
```
|
||||
|
||||
## Next steps
|
||||
|
||||
- [Commands](/docs/commands) — Full CLI reference
|
||||
- [Skills](/docs/skills) — Skill format and lifecycle
|
||||
- [Memory](/docs/memory) — Persistent session learning
|
||||
- [Mesh](/docs/mesh) — Multi-machine distribution
|
||||
@@ -0,0 +1,98 @@
|
||||
---
|
||||
title: Recommendations
|
||||
description: Get smart skill suggestions for your project
|
||||
---
|
||||
|
||||
# Recommendations
|
||||
|
||||
SkillKit analyzes your project and suggests relevant skills.
|
||||
|
||||
## Get Recommendations
|
||||
|
||||
```bash
|
||||
skillkit recommend
|
||||
```
|
||||
|
||||
Output:
|
||||
|
||||
```
|
||||
Project: my-app (Next.js + TypeScript + Tailwind)
|
||||
|
||||
Recommended Skills:
|
||||
92% vercel-react-best-practices
|
||||
87% tailwind-v4-patterns
|
||||
85% nextjs-app-router
|
||||
```
|
||||
|
||||
## Filters
|
||||
|
||||
```bash
|
||||
skillkit recommend --search "auth"
|
||||
skillkit recommend --category security
|
||||
skillkit recommend --min-score 80
|
||||
```
|
||||
|
||||
## Explainable Recommendations
|
||||
|
||||
See WHY skills match your project:
|
||||
|
||||
```bash
|
||||
skillkit recommend --explain
|
||||
```
|
||||
|
||||
Output:
|
||||
|
||||
```
|
||||
vercel-react-best-practices (Score: 92)
|
||||
├── Matched: React, TypeScript, Next.js
|
||||
├── Your stack: Next.js 14, React 18
|
||||
└── Path: Frontend > React > Best Practices
|
||||
```
|
||||
|
||||
## LLM-Based Reasoning
|
||||
|
||||
Use reasoning-based discovery for complex queries:
|
||||
|
||||
```bash
|
||||
skillkit recommend --reasoning
|
||||
```
|
||||
|
||||
This uses an LLM to traverse the skill taxonomy and find the most relevant skills based on semantic understanding.
|
||||
|
||||
## How It Works
|
||||
|
||||
The engine analyzes:
|
||||
- **Project structure** - Frameworks, languages, tools
|
||||
- **Dependencies** - package.json, requirements.txt
|
||||
- **File patterns** - Code patterns in your codebase
|
||||
|
||||
## Scoring
|
||||
|
||||
Scores based on:
|
||||
- Stack match
|
||||
- Quality score (0-100)
|
||||
- Popularity
|
||||
- Task relevance
|
||||
|
||||
## Programmatic API
|
||||
|
||||
```typescript
|
||||
import {
|
||||
RecommendationEngine,
|
||||
ReasoningRecommendationEngine,
|
||||
analyzeProject
|
||||
} from '@skillkit/core'
|
||||
|
||||
// Basic recommendations
|
||||
const engine = new RecommendationEngine()
|
||||
const profile = await analyzeProject('./my-project')
|
||||
const recs = engine.recommend(profile)
|
||||
|
||||
// With reasoning and explanations
|
||||
const reasoningEngine = new ReasoningRecommendationEngine()
|
||||
await reasoningEngine.initReasoning()
|
||||
const explained = await reasoningEngine.recommendWithReasoning(profile, {
|
||||
reasoning: true,
|
||||
explain: true
|
||||
})
|
||||
```
|
||||
@@ -0,0 +1,205 @@
|
||||
---
|
||||
title: REST API
|
||||
description: Runtime skill discovery via HTTP
|
||||
---
|
||||
|
||||
# REST API
|
||||
|
||||
Skills shouldn't require pre-installation. With the SkillKit REST API, any agent, framework, or tool can discover and retrieve skills on demand over HTTP.
|
||||
|
||||
## Start the server
|
||||
|
||||
```bash
|
||||
skillkit serve
|
||||
```
|
||||
|
||||
That's it. The API is now running at `http://localhost:3737`.
|
||||
|
||||
## Search for skills
|
||||
|
||||
```bash
|
||||
curl "http://localhost:3737/search?q=react+performance"
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"skills": [
|
||||
{
|
||||
"name": "react-performance",
|
||||
"description": "React app performance optimization",
|
||||
"source": "anthropics/skills",
|
||||
"tags": ["react", "performance"],
|
||||
"score": 87
|
||||
}
|
||||
],
|
||||
"total": 42,
|
||||
"query": "react performance",
|
||||
"limit": 20
|
||||
}
|
||||
```
|
||||
|
||||
Results are ranked by a multi-signal scoring system. The best matches come first.
|
||||
|
||||
### With filters
|
||||
|
||||
Use POST for advanced filtering:
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:3737/search \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"query": "auth",
|
||||
"filters": { "tags": ["security"], "category": "backend" }
|
||||
}'
|
||||
```
|
||||
|
||||
### Include full content
|
||||
|
||||
Add `include_content=true` to get the complete SKILL.md body:
|
||||
|
||||
```bash
|
||||
curl "http://localhost:3737/search?q=pdf&include_content=true&limit=3"
|
||||
```
|
||||
|
||||
## Get a specific skill
|
||||
|
||||
```bash
|
||||
curl http://localhost:3737/skills/anthropics/skills/pdf-processing
|
||||
```
|
||||
|
||||
The path follows the pattern `/skills/:owner/:repo/:skill-name`.
|
||||
|
||||
## Browse trending skills
|
||||
|
||||
```bash
|
||||
curl http://localhost:3737/trending?limit=10
|
||||
```
|
||||
|
||||
Returns the top skills ranked by relevance score across all sources.
|
||||
|
||||
## List categories
|
||||
|
||||
```bash
|
||||
curl http://localhost:3737/categories
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"categories": [
|
||||
{ "name": "react", "count": 156 },
|
||||
{ "name": "typescript", "count": 134 },
|
||||
{ "name": "testing", "count": 89 }
|
||||
],
|
||||
"total": 89
|
||||
}
|
||||
```
|
||||
|
||||
## How ranking works
|
||||
|
||||
Every search result gets a score from 0 to 100, computed from four signals:
|
||||
|
||||
| Signal | Points | What it measures |
|
||||
|--------|--------|-----------------|
|
||||
| Content | 40 | Has a description and SKILL.md body |
|
||||
| Query match | 30 | How well the name/description matches your search |
|
||||
| Popularity | 15 | GitHub stars + install count (log-scaled) |
|
||||
| References | 15 | Has example files, docs, or resources |
|
||||
|
||||
A skill with full content, an exact name match, high stars, and example files scores close to 100. A skill with just a name and no content scores around 10.
|
||||
|
||||
## Server options
|
||||
|
||||
```bash
|
||||
skillkit serve --port 8080 --host localhost --cors "http://localhost:3000"
|
||||
```
|
||||
|
||||
| Option | Default | What it does |
|
||||
|--------|---------|-------------|
|
||||
| `--port` / `-p` | `3737` | Port to listen on |
|
||||
| `--host` / `-H` | `0.0.0.0` | Host to bind to |
|
||||
| `--cors` | `*` | Allowed CORS origin |
|
||||
| `--cache-ttl` | `86400000` | Cache lifetime in ms (default 24h) |
|
||||
|
||||
## Rate limiting
|
||||
|
||||
60 requests per minute per IP. Response headers tell you where you stand:
|
||||
|
||||
| Header | Meaning |
|
||||
|--------|---------|
|
||||
| `X-RateLimit-Remaining` | Requests left in this window |
|
||||
| `X-RateLimit-Reset` | When the window resets |
|
||||
|
||||
Exceed the limit and you'll get HTTP 429 with a `retryAfter` field.
|
||||
|
||||
## Caching
|
||||
|
||||
Search results are cached in memory using an LRU strategy. Same query, same results, no recomputation. Check cache performance:
|
||||
|
||||
```bash
|
||||
curl http://localhost:3737/cache/stats
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"hits": 142,
|
||||
"misses": 38,
|
||||
"size": 45,
|
||||
"maxSize": 500,
|
||||
"hitRate": 0.789
|
||||
}
|
||||
```
|
||||
|
||||
## Health check
|
||||
|
||||
```bash
|
||||
curl http://localhost:3737/health
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "ok",
|
||||
"version": "1.12.0",
|
||||
"skillCount": 15062,
|
||||
"uptime": 3600
|
||||
}
|
||||
```
|
||||
|
||||
## Use it programmatically
|
||||
|
||||
```typescript
|
||||
import { createApp, startServer } from '@skillkit/api';
|
||||
|
||||
const { server, app, cache } = await startServer({
|
||||
port: 3737,
|
||||
skills: mySkillsArray,
|
||||
});
|
||||
```
|
||||
|
||||
Or get just the Hono app for testing:
|
||||
|
||||
```typescript
|
||||
const { app, cache } = createApp({
|
||||
skills: mySkillsArray,
|
||||
cacheTtlMs: 3_600_000,
|
||||
});
|
||||
```
|
||||
|
||||
## Interactive docs
|
||||
|
||||
The server includes built-in Swagger UI at `/docs` and an OpenAPI 3.1 spec at `/openapi.json`. Open `http://localhost:3737/docs` in your browser to try endpoints interactively.
|
||||
|
||||
The hosted version is available at [agenstskills.com/api](https://agenstskills.com/api).
|
||||
|
||||
## All endpoints
|
||||
|
||||
| Method | Path | Description |
|
||||
|--------|------|-------------|
|
||||
| GET | `/search?q=...` | Search skills |
|
||||
| POST | `/search` | Search with filters |
|
||||
| GET | `/skills/:owner/:repo/:id` | Get specific skill |
|
||||
| GET | `/trending?limit=20` | Trending skills |
|
||||
| GET | `/categories` | Skill categories |
|
||||
| GET | `/health` | Server health |
|
||||
| GET | `/cache/stats` | Cache statistics |
|
||||
| GET | `/docs` | Swagger UI |
|
||||
| GET | `/openapi.json` | OpenAPI spec |
|
||||
@@ -0,0 +1,115 @@
|
||||
---
|
||||
title: Skills
|
||||
description: Understanding AI agent skills - format, lifecycle, and quality
|
||||
---
|
||||
|
||||
# Skills
|
||||
|
||||
A skill is an instruction file that teaches AI coding agents how to handle specific tasks. Each skill uses a universal Markdown format (SKILL.md) with YAML frontmatter.
|
||||
|
||||
## Skills vs Context vs Commands
|
||||
|
||||
| Type | Purpose | Format |
|
||||
|------|---------|--------|
|
||||
| **Skills** | Task-specific reusable instructions | SKILL.md |
|
||||
| **Context** | Project-wide environment info | JSON/YAML |
|
||||
| **Commands** | Quick-action slash commands | Various |
|
||||
|
||||
## Skill Format
|
||||
|
||||
```markdown
|
||||
---
|
||||
name: my-skill
|
||||
description: What this skill does
|
||||
license: MIT
|
||||
metadata:
|
||||
author: your-name
|
||||
version: "1.0"
|
||||
tags:
|
||||
- react
|
||||
- typescript
|
||||
---
|
||||
|
||||
# My Skill
|
||||
|
||||
Instructions for the AI agent.
|
||||
|
||||
## When to Use
|
||||
|
||||
- Scenario 1
|
||||
- Scenario 2
|
||||
|
||||
## Steps
|
||||
|
||||
1. First step
|
||||
2. Second step
|
||||
```
|
||||
|
||||
## Skill Lifecycle
|
||||
|
||||
Skills progress through six stages:
|
||||
|
||||
1. **Discovery** - `findAllSkills()` scans directories for SKILL.md files
|
||||
2. **Quality Evaluation** - `evaluateSkillContent()` produces 0-100 scores (grades A-F)
|
||||
3. **Parsing** - `parseSkillFile()` extracts YAML frontmatter and markdown content
|
||||
4. **Translation** - `translateSkill()` converts to agent-specific formats
|
||||
5. **Installation** - Skills deployed to agent directories with metadata tracking
|
||||
6. **Testing** - Test suites with 14+ assertion types validate skills
|
||||
|
||||
## Quality Evaluation
|
||||
|
||||
Skills receive scores across four weighted dimensions:
|
||||
|
||||
- **Structure** - 25 points: Frontmatter completeness, markdown sections
|
||||
- **Clarity** - 30 points: Description quality, instruction precision
|
||||
- **Specificity** - 30 points: Concrete examples, actionable steps
|
||||
- **Advanced** - 15 points: Test coverage, version info, examples
|
||||
|
||||
**Grades:**
|
||||
- A: 90 to 100
|
||||
- B: 80 to 89
|
||||
- C: 70 to 79
|
||||
- D: 60 to 69
|
||||
- F: below 60
|
||||
|
||||
## Skill Sources
|
||||
|
||||
| Source | Description |
|
||||
|--------|-------------|
|
||||
| **GitHub/GitLab** | Remote repository collections |
|
||||
| **Local filesystem** | Project-specific skills |
|
||||
| **Marketplace** | 15,000+ curated skills with search |
|
||||
|
||||
## Creating Skills
|
||||
|
||||
```bash
|
||||
skillkit create my-skill
|
||||
```
|
||||
|
||||
Or manually create a `SKILL.md` file following the format above.
|
||||
|
||||
## Publishing Skills
|
||||
|
||||
```bash
|
||||
# Test locally
|
||||
skillkit validate ./my-skill
|
||||
|
||||
# Generate well-known hosting structure for self-hosting
|
||||
skillkit publish ./my-skill --output ./public
|
||||
|
||||
# Or submit to SkillKit marketplace
|
||||
skillkit publish submit
|
||||
```
|
||||
|
||||
### Self-Hosting
|
||||
|
||||
The `skillkit publish` command generates an RFC 8615 well-known URI structure:
|
||||
|
||||
```
|
||||
.well-known/skills/
|
||||
index.json # Manifest for auto-discovery
|
||||
my-skill/
|
||||
SKILL.md # Skill content
|
||||
```
|
||||
|
||||
Deploy to your domain and users can install via `skillkit add https://your-domain.com`.
|
||||
@@ -0,0 +1,455 @@
|
||||
---
|
||||
title: Team Collaboration
|
||||
description: Share skills and maintain consistency across your development team
|
||||
---
|
||||
|
||||
# Team Collaboration
|
||||
|
||||
SkillKit provides powerful team collaboration features to ensure every developer has the same AI agent capabilities, follows the same patterns, and stays in sync.
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Initialize team manifest
|
||||
skillkit team init
|
||||
|
||||
# Add skills to team manifest
|
||||
skillkit team add anthropics/skills
|
||||
skillkit team add ./local-skills
|
||||
|
||||
# Share with team (commit to Git)
|
||||
git add .skills
|
||||
git commit -m "Add team skills manifest"
|
||||
git push
|
||||
|
||||
# Team members install
|
||||
git pull
|
||||
skillkit team install
|
||||
```
|
||||
|
||||
## Team Manifest (.skills)
|
||||
|
||||
The `.skills` file is a Git-committable manifest that defines your team's skill stack.
|
||||
|
||||
### Example Manifest
|
||||
|
||||
```json
|
||||
{
|
||||
"version": "1.0",
|
||||
"name": "my-team",
|
||||
"skills": [
|
||||
{
|
||||
"source": "anthropics/skills",
|
||||
"skills": ["pdf", "xlsx", "docx"],
|
||||
"version": "1.2.0"
|
||||
},
|
||||
{
|
||||
"source": "vercel-labs/agent-skills",
|
||||
"skills": ["react-best-practices", "nextjs-patterns"],
|
||||
"version": "latest"
|
||||
},
|
||||
{
|
||||
"source": "./local-skills",
|
||||
"skills": ["company-coding-standards", "api-guidelines"],
|
||||
"type": "local"
|
||||
}
|
||||
],
|
||||
"agents": ["claude", "cursor", "windsurf"],
|
||||
"config": {
|
||||
"autoSync": true,
|
||||
"syncOnPull": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
### Initialize Team
|
||||
|
||||
```bash
|
||||
# Create .skills manifest
|
||||
skillkit team init
|
||||
|
||||
# Specify team name
|
||||
skillkit team init --name engineering-team
|
||||
|
||||
# Add initial skills
|
||||
skillkit team init --skills anthropics/skills,vercel-labs/agent-skills
|
||||
```
|
||||
|
||||
### Manage Skills
|
||||
|
||||
```bash
|
||||
# Add skill source
|
||||
skillkit team add anthropics/skills
|
||||
|
||||
# Add specific skills
|
||||
skillkit team add anthropics/skills --skills pdf,xlsx
|
||||
|
||||
# Remove skill
|
||||
skillkit team remove anthropics/skills
|
||||
|
||||
# List team skills
|
||||
skillkit team list
|
||||
```
|
||||
|
||||
### Install & Sync
|
||||
|
||||
```bash
|
||||
# Install all team skills
|
||||
skillkit team install
|
||||
|
||||
# Install and sync
|
||||
skillkit team install --sync
|
||||
|
||||
# Force reinstall
|
||||
skillkit team install --force
|
||||
```
|
||||
|
||||
### Share & Update
|
||||
|
||||
```bash
|
||||
# Share current skills as team manifest
|
||||
skillkit team share
|
||||
|
||||
# Update team manifest from installed skills
|
||||
skillkit team update
|
||||
|
||||
# Sync team manifest with Git remote
|
||||
skillkit team sync
|
||||
```
|
||||
|
||||
## Git Integration
|
||||
|
||||
### Auto-Install on Pull
|
||||
|
||||
Add to `.git/hooks/post-merge`:
|
||||
|
||||
```bash
|
||||
#!/bin/sh
|
||||
if [ -f .skills ]; then
|
||||
echo "📦 Installing team skills..."
|
||||
skillkit team install --yes
|
||||
fi
|
||||
```
|
||||
|
||||
Make it executable:
|
||||
|
||||
```bash
|
||||
chmod +x .git/hooks/post-merge
|
||||
```
|
||||
|
||||
### Pre-Commit Validation
|
||||
|
||||
Ensure skills are valid before committing:
|
||||
|
||||
```bash
|
||||
# .git/hooks/pre-commit
|
||||
#!/bin/sh
|
||||
if [ -f .skills ]; then
|
||||
echo "🔍 Validating team skills..."
|
||||
skillkit team validate
|
||||
if [ $? -ne 0 ]; then
|
||||
echo "❌ Team skills validation failed"
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
```
|
||||
|
||||
## CI/CD Integration
|
||||
|
||||
### GitHub Actions
|
||||
|
||||
```yaml
|
||||
# .github/workflows/skills.yml
|
||||
name: Team Skills
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
paths:
|
||||
- '.skills'
|
||||
|
||||
jobs:
|
||||
validate:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Setup Node
|
||||
uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: '18'
|
||||
|
||||
- name: Install SkillKit
|
||||
run: npm install -g skillkit
|
||||
|
||||
- name: Validate Team Manifest
|
||||
run: skillkit team validate
|
||||
|
||||
- name: Install Skills
|
||||
run: skillkit team install --yes
|
||||
|
||||
- name: Run Skill Tests
|
||||
run: skillkit test
|
||||
```
|
||||
|
||||
### GitLab CI
|
||||
|
||||
```yaml
|
||||
# .gitlab-ci.yml
|
||||
skills:validate:
|
||||
stage: test
|
||||
script:
|
||||
- npm install -g skillkit
|
||||
- skillkit team validate
|
||||
- skillkit team install --yes
|
||||
- skillkit test
|
||||
only:
|
||||
changes:
|
||||
- .skills
|
||||
```
|
||||
|
||||
## Private Registries
|
||||
|
||||
Host proprietary skills in private repositories.
|
||||
|
||||
### Setup Private Registry
|
||||
|
||||
```bash
|
||||
# Add private registry
|
||||
skillkit registry add company-skills \
|
||||
--url https://github.com/mycompany/skills \
|
||||
--token $GITHUB_TOKEN
|
||||
|
||||
# Install from private registry
|
||||
skillkit install company-skills/auth-patterns
|
||||
```
|
||||
|
||||
### Team Manifest with Private Skills
|
||||
|
||||
```json
|
||||
{
|
||||
"skills": [
|
||||
{
|
||||
"source": "company-skills/proprietary-skills",
|
||||
"registry": "company-skills",
|
||||
"skills": ["auth-patterns", "payment-processing"],
|
||||
"private": true
|
||||
}
|
||||
],
|
||||
"registries": [
|
||||
{
|
||||
"name": "company-skills",
|
||||
"url": "https://github.com/mycompany/skills",
|
||||
"auth": "env:GITHUB_TOKEN"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Team Workflows
|
||||
|
||||
### Onboarding New Developers
|
||||
|
||||
```bash
|
||||
# 1. Clone repository
|
||||
git clone https://github.com/company/project
|
||||
cd project
|
||||
|
||||
# 2. Install team skills
|
||||
skillkit team install
|
||||
|
||||
# 3. Generate project instructions
|
||||
skillkit primer --all-agents
|
||||
|
||||
# 4. Sync to agents
|
||||
skillkit sync
|
||||
|
||||
# ✅ Developer is ready!
|
||||
```
|
||||
|
||||
### Creating Team-Wide Skills
|
||||
|
||||
```bash
|
||||
# 1. Create new skill
|
||||
skillkit create company-coding-standards
|
||||
|
||||
# 2. Add to local skills
|
||||
mv company-coding-standards ./local-skills/
|
||||
|
||||
# 3. Add to team manifest
|
||||
skillkit team add ./local-skills
|
||||
|
||||
# 4. Commit and push
|
||||
git add .skills local-skills/
|
||||
git commit -m "Add company coding standards"
|
||||
git push
|
||||
```
|
||||
|
||||
### Updating Team Skills
|
||||
|
||||
```bash
|
||||
# 1. Update skill version
|
||||
skillkit team update anthropics/skills --version 1.3.0
|
||||
|
||||
# 2. Test locally
|
||||
skillkit team install
|
||||
skillkit test
|
||||
|
||||
# 3. Commit if tests pass
|
||||
git add .skills
|
||||
git commit -m "Update anthropics/skills to v1.3.0"
|
||||
git push
|
||||
```
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Version Pinning
|
||||
|
||||
Pin critical skills to specific versions:
|
||||
|
||||
```json
|
||||
{
|
||||
"skills": [
|
||||
{
|
||||
"source": "anthropics/skills",
|
||||
"version": "1.2.0",
|
||||
"pinned": true
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### Skill Categories
|
||||
|
||||
Organize by category:
|
||||
|
||||
```json
|
||||
{
|
||||
"skills": [
|
||||
{
|
||||
"category": "core",
|
||||
"source": "anthropics/skills",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"category": "optional",
|
||||
"source": "vercel-labs/agent-skills",
|
||||
"required": false
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### Environment-Specific Skills
|
||||
|
||||
```json
|
||||
{
|
||||
"environments": {
|
||||
"development": {
|
||||
"skills": ["debug-tools", "dev-server-patterns"]
|
||||
},
|
||||
"production": {
|
||||
"skills": ["performance-monitoring", "error-tracking"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Conflict Resolution
|
||||
|
||||
### Skill Name Conflicts
|
||||
|
||||
When multiple sources provide the same skill name:
|
||||
|
||||
```bash
|
||||
# List conflicts
|
||||
skillkit team conflicts
|
||||
|
||||
# Resolve by priority
|
||||
skillkit team resolve --priority "local,anthropics,vercel"
|
||||
```
|
||||
|
||||
### Version Conflicts
|
||||
|
||||
```bash
|
||||
# Show version mismatches
|
||||
skillkit team check-versions
|
||||
|
||||
# Align to latest
|
||||
skillkit team align --strategy latest
|
||||
|
||||
# Align to pinned
|
||||
skillkit team align --strategy pinned
|
||||
```
|
||||
|
||||
## Programmatic API
|
||||
|
||||
```typescript
|
||||
import { TeamManifest, TeamSync } from '@skillkit/core'
|
||||
|
||||
// Load team manifest
|
||||
const manifest = await TeamManifest.load('./.skills')
|
||||
|
||||
// Install team skills
|
||||
const sync = new TeamSync(manifest)
|
||||
await sync.install({
|
||||
agents: ['claude', 'cursor'],
|
||||
force: false,
|
||||
})
|
||||
|
||||
// Update manifest
|
||||
manifest.addSkill({
|
||||
source: 'anthropics/skills',
|
||||
skills: ['pdf'],
|
||||
version: '1.2.0',
|
||||
})
|
||||
|
||||
await manifest.save()
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Skills Not Syncing
|
||||
|
||||
```bash
|
||||
# Force reinstall
|
||||
skillkit team install --force
|
||||
|
||||
# Clear cache
|
||||
skillkit team clean
|
||||
|
||||
# Reinstall
|
||||
skillkit team install
|
||||
```
|
||||
|
||||
### Manifest Validation Errors
|
||||
|
||||
```bash
|
||||
# Validate manifest
|
||||
skillkit team validate --verbose
|
||||
|
||||
# Fix common issues
|
||||
skillkit team validate --fix
|
||||
```
|
||||
|
||||
### Merge Conflicts in .skills
|
||||
|
||||
```bash
|
||||
# Accept theirs
|
||||
git checkout --theirs .skills
|
||||
skillkit team install
|
||||
|
||||
# Accept ours
|
||||
git checkout --ours .skills
|
||||
skillkit team install
|
||||
|
||||
# Merge manually
|
||||
skillkit team merge-conflicts
|
||||
```
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [CI/CD Integration](/docs/cicd) - Automate skill deployment
|
||||
- [Workflows](/docs/workflows) - Team-wide automation
|
||||
- [Testing](/docs/testing) - Validate skills before deployment
|
||||
@@ -0,0 +1,66 @@
|
||||
---
|
||||
title: Testing
|
||||
description: Test skills with multiple assertion types
|
||||
---
|
||||
|
||||
# Testing
|
||||
|
||||
SkillKit includes a testing framework with multiple assertion types.
|
||||
|
||||
## Run Tests
|
||||
|
||||
```bash
|
||||
skillkit test # All tests
|
||||
skillkit test ./my-skill # Specific skill
|
||||
skillkit test --tags unit # By tag
|
||||
skillkit test --json # CI output
|
||||
```
|
||||
|
||||
## Test File
|
||||
|
||||
Create `test.yaml` alongside your skill:
|
||||
|
||||
```yaml
|
||||
name: my-skill-tests
|
||||
skill: my-skill
|
||||
|
||||
tests:
|
||||
- name: validates input
|
||||
input: |
|
||||
Process this file
|
||||
assertions:
|
||||
- contains: "processed"
|
||||
- not_contains: "error"
|
||||
```
|
||||
|
||||
## Assertion Types
|
||||
|
||||
| Assertion | Description |
|
||||
|-----------|-------------|
|
||||
| `contains` | Text present |
|
||||
| `not_contains` | Text absent |
|
||||
| `matches` | Regex match |
|
||||
| `starts_with` | Prefix check |
|
||||
| `ends_with` | Suffix check |
|
||||
| `has_section` | Markdown section |
|
||||
| `has_code_block` | Code block with lang |
|
||||
| `word_count_min` | Minimum words |
|
||||
| `word_count_max` | Maximum words |
|
||||
| `no_todos` | No TODO comments |
|
||||
| `has_frontmatter` | YAML present |
|
||||
|
||||
## CI Integration
|
||||
|
||||
```yaml
|
||||
- name: Test Skills
|
||||
run: skillkit test --json > results.json
|
||||
```
|
||||
|
||||
## Programmatic API
|
||||
|
||||
```typescript
|
||||
import { SkillTestRunner } from '@skillkit/core'
|
||||
|
||||
const runner = new SkillTestRunner()
|
||||
const results = await runner.run('./my-skill')
|
||||
```
|
||||
@@ -0,0 +1,55 @@
|
||||
---
|
||||
title: Translation
|
||||
description: Convert skills between AI agent formats
|
||||
---
|
||||
|
||||
# Translation
|
||||
|
||||
SkillKit automatically converts between all 32 agent formats using an adapter pattern.
|
||||
|
||||
## Basic Translation
|
||||
|
||||
```bash
|
||||
skillkit translate react-patterns --to cursor
|
||||
```
|
||||
|
||||
## Translate All
|
||||
|
||||
```bash
|
||||
skillkit translate --all --to windsurf
|
||||
```
|
||||
|
||||
## Preview Mode
|
||||
|
||||
```bash
|
||||
skillkit translate my-skill --to codex --dry-run
|
||||
```
|
||||
|
||||
## Batch Translation
|
||||
|
||||
```bash
|
||||
skillkit agent translate --source ./my-skills --to cursor
|
||||
skillkit agent translate --source ./skills --to cursor --recursive
|
||||
```
|
||||
|
||||
## Format Mapping
|
||||
|
||||
| Source | Target | Notes |
|
||||
|--------|--------|-------|
|
||||
| SKILL.md | .mdc | Cursor format |
|
||||
| SKILL.md | Markdown | GitHub Copilot |
|
||||
| .mdc | SKILL.md | Reverse conversion |
|
||||
|
||||
## How It Works
|
||||
|
||||
```
|
||||
Universal Format (SKILL.md)
|
||||
↓
|
||||
Adapter Interface
|
||||
↓
|
||||
Agent-Specific Formats
|
||||
```
|
||||
|
||||
Each adapter implements:
|
||||
- `getConfigPath()` - Returns skill directory
|
||||
- `generateConfig()` - Converts content to target format
|
||||
@@ -0,0 +1,144 @@
|
||||
---
|
||||
title: Skill Tree
|
||||
description: Browse skills in a hierarchical taxonomy
|
||||
---
|
||||
|
||||
# Skill Tree
|
||||
|
||||
Browse and navigate skills organized in a hierarchical taxonomy structure.
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Show full skill tree
|
||||
skillkit tree
|
||||
|
||||
# Navigate to a category
|
||||
skillkit tree Frontend
|
||||
|
||||
# Navigate to subcategory
|
||||
skillkit tree "Frontend > React"
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
### Display Tree
|
||||
|
||||
```bash
|
||||
skillkit tree # Full tree
|
||||
skillkit tree Development # Specific category
|
||||
skillkit tree --depth 2 # Limit display depth
|
||||
```
|
||||
|
||||
### Generate Tree
|
||||
|
||||
```bash
|
||||
skillkit tree --generate # Generate from skill index
|
||||
```
|
||||
|
||||
This builds a hierarchical tree from the skill index based on tags and metadata.
|
||||
|
||||
### Export Formats
|
||||
|
||||
```bash
|
||||
skillkit tree --json # JSON output
|
||||
skillkit tree --markdown # Markdown output
|
||||
```
|
||||
|
||||
### Statistics
|
||||
|
||||
```bash
|
||||
skillkit tree --stats
|
||||
```
|
||||
|
||||
Output:
|
||||
|
||||
```
|
||||
Overview:
|
||||
Total Skills: 15,064
|
||||
Categories: 156
|
||||
Max Depth: 4
|
||||
|
||||
Top-Level Categories:
|
||||
Development 4,521 skills (30.0%)
|
||||
Frontend (1,245), Backend (1,102), Mobile (456)
|
||||
DevOps 2,340 skills (15.5%)
|
||||
CI/CD (890), Kubernetes (567), Docker (445)
|
||||
AI/ML 1,890 skills (12.5%)
|
||||
LLM Integration (756), Agents (445), RAG (312)
|
||||
```
|
||||
|
||||
## Categories
|
||||
|
||||
The tree organizes skills into 12 top-level categories:
|
||||
|
||||
| Category | Description |
|
||||
|----------|-------------|
|
||||
| Development | General coding, programming patterns |
|
||||
| Frontend | React, Vue, Angular, Svelte, UI/UX |
|
||||
| Backend | Node.js, Python, Go, APIs, servers |
|
||||
| Mobile | React Native, Flutter, iOS, Android |
|
||||
| DevOps | CI/CD, Kubernetes, Docker, cloud |
|
||||
| Testing | Unit, E2E, integration, TDD |
|
||||
| Security | Auth, encryption, vulnerabilities |
|
||||
| AI/ML | LLM, agents, RAG, embeddings |
|
||||
| Database | SQL, NoSQL, ORM, migrations |
|
||||
| Tooling | Linting, formatting, bundling |
|
||||
| Documentation | API docs, guides, READMEs |
|
||||
| Performance | Optimization, caching, profiling |
|
||||
|
||||
## TUI Tree View
|
||||
|
||||
In the TUI, press `v` to toggle tree view in the Marketplace:
|
||||
|
||||
- **Arrow keys** - Navigate tree
|
||||
- **Enter** - Expand category / select skill
|
||||
- **←** - Go back / collapse
|
||||
- **v** - Toggle list/tree view
|
||||
|
||||
## Related Skills Graph
|
||||
|
||||
Find skills related to each other:
|
||||
|
||||
```typescript
|
||||
import { buildSkillGraph, getRelatedSkills } from '@skillkit/core'
|
||||
|
||||
const graph = buildSkillGraph(skills)
|
||||
const related = getRelatedSkills('react-patterns', graph, skills, {
|
||||
limit: 5,
|
||||
types: ['similar', 'complementary']
|
||||
})
|
||||
```
|
||||
|
||||
### Relation Types
|
||||
|
||||
- **similar** - Shares tags and functionality
|
||||
- **complementary** - Works well together
|
||||
- **dependency** - Required by other skills
|
||||
- **alternative** - Different approach to same problem
|
||||
|
||||
## Programmatic API
|
||||
|
||||
```typescript
|
||||
import {
|
||||
TreeGenerator,
|
||||
generateSkillTree,
|
||||
loadTree,
|
||||
saveTree,
|
||||
treeToMarkdown
|
||||
} from '@skillkit/core'
|
||||
|
||||
// Generate tree from skills
|
||||
const generator = new TreeGenerator({ maxDepth: 3 })
|
||||
const tree = generator.generateTree(skills)
|
||||
|
||||
// Or use the helper function
|
||||
const tree = generateSkillTree(skills)
|
||||
|
||||
// Save and load
|
||||
saveTree(tree, './skill-tree.json')
|
||||
const loaded = loadTree('./skill-tree.json')
|
||||
|
||||
// Export to markdown
|
||||
const markdown = treeToMarkdown(tree)
|
||||
```
|
||||
@@ -0,0 +1,225 @@
|
||||
---
|
||||
title: Terminal UI
|
||||
description: Interactive keyboard-driven interface for managing skills
|
||||
---
|
||||
|
||||
# Terminal UI
|
||||
|
||||
The TUI provides an interactive, keyboard-driven interface for managing skills with visual browsing, searching, and installation capabilities.
|
||||
|
||||
## Launch
|
||||
|
||||
```bash
|
||||
skillkit ui
|
||||
# or just
|
||||
skillkit
|
||||
```
|
||||
|
||||
## Framework
|
||||
|
||||
Built on modern technologies:
|
||||
- **@opentui/solid** - Terminal rendering with Solid.js
|
||||
- **Solid.js 1.9.0** - Reactive component architecture
|
||||
- **Bun 1.2.0+** - Runtime requirement
|
||||
|
||||
The TUI was migrated from React to Solid.js in v1.8.0 for improved performance and smaller bundle size.
|
||||
|
||||
## Screens
|
||||
|
||||
| Screen | Key | Purpose |
|
||||
|--------|-----|---------|
|
||||
| **Home** | `h` | Entry point dashboard with quick navigation |
|
||||
| **Browse** | `b` | Skill repository browser with search |
|
||||
| **Marketplace** | `m` | 15,000+ skills with categories |
|
||||
| **Installed** | `i` | Local skill management |
|
||||
| **Recommend** | `r` | AI-powered suggestions |
|
||||
| **Translate** | `t` | Format conversion |
|
||||
| **Context** | `c` | Project context management |
|
||||
| **Sync** | `s` | Synchronize to agents |
|
||||
|
||||
## Keyboard Navigation
|
||||
|
||||
### Global Shortcuts
|
||||
|
||||
| Key | Action |
|
||||
|-----|--------|
|
||||
| `h` | Go to Home |
|
||||
| `b` | Go to Browse |
|
||||
| `m` | Go to Marketplace |
|
||||
| `i` | Go to Installed |
|
||||
| `r` | Go to Recommend |
|
||||
| `t` | Go to Translate |
|
||||
| `c` | Go to Context |
|
||||
| `s` | Go to Sync |
|
||||
| `/` | Open Help |
|
||||
| `q` | Quit TUI |
|
||||
|
||||
### List Navigation
|
||||
|
||||
| Key | Action |
|
||||
|-----|--------|
|
||||
| `j` or `↓` | Move down |
|
||||
| `k` or `↑` | Move up |
|
||||
| `Enter` | Select/activate |
|
||||
| `Esc` | Go back |
|
||||
| `/` | Enter search mode |
|
||||
|
||||
### Search Mode
|
||||
|
||||
| Key | Action |
|
||||
|-----|--------|
|
||||
| `/` | Enter search mode |
|
||||
| Type | Filter list |
|
||||
| `Enter` | Confirm search |
|
||||
| `Esc` | Exit search |
|
||||
|
||||
## Screen Details
|
||||
|
||||
### Home Screen
|
||||
|
||||
Dashboard with:
|
||||
- Quick navigation shortcuts
|
||||
- Recent activity
|
||||
- System status
|
||||
|
||||
### Browse Screen
|
||||
|
||||
Repository browser with:
|
||||
- Search functionality
|
||||
- Pagination
|
||||
- Quality indicators
|
||||
- Animation phases for smooth loading
|
||||
|
||||
### Installed Screen
|
||||
|
||||
Manage local skills:
|
||||
- Enable/disable skills
|
||||
- Quality grades (A-F)
|
||||
- Live search filtering
|
||||
- Status icons: `●` enabled, `○` disabled
|
||||
|
||||
### Marketplace Screen
|
||||
|
||||
Browse 15,000+ skills:
|
||||
- Category filtering
|
||||
- Featured skills
|
||||
- 3-phase animation loading
|
||||
- Quality scoring
|
||||
- **Tree View** - Press `v` to toggle hierarchical navigation
|
||||
|
||||
#### Tree View Mode
|
||||
|
||||
Navigate skills in a hierarchical taxonomy:
|
||||
|
||||
| Key | Action |
|
||||
|-----|--------|
|
||||
| `v` | Toggle tree/list view |
|
||||
| `→` or `Enter` | Expand category |
|
||||
| `←` | Collapse / go back |
|
||||
| `↑`/`↓` | Navigate |
|
||||
|
||||
Categories include: Development, Frontend, Backend, Mobile, DevOps, Testing, Security, AI/ML, Database, Tooling, Documentation, Performance
|
||||
|
||||
### Recommend Screen
|
||||
|
||||
AI-powered suggestions:
|
||||
- Project analysis
|
||||
- Confidence scoring
|
||||
- Progress tracking
|
||||
- Match percentages
|
||||
|
||||
## Visual Indicators
|
||||
|
||||
### Quality Grades
|
||||
|
||||
| Grade | Score | Color |
|
||||
|-------|-------|-------|
|
||||
| A | 90-100 | Green |
|
||||
| B | 80-89 | Green |
|
||||
| C | 70-79 | Yellow |
|
||||
| D | 60-69 | Red |
|
||||
| F | Below 60 | Red |
|
||||
|
||||
### Status Icons
|
||||
|
||||
| Icon | Meaning |
|
||||
|------|---------|
|
||||
| `●` | Enabled |
|
||||
| `○` | Disabled |
|
||||
| `⟁` | Claude Code |
|
||||
| `◫` | Cursor |
|
||||
| `◎` | Codex |
|
||||
| `✦` | Gemini |
|
||||
| `⬡` | OpenCode |
|
||||
|
||||
## Theme System
|
||||
|
||||
The TUI uses a monochromatic design with:
|
||||
- Consistent color coding
|
||||
- Terminal-compatible colors
|
||||
- Visual accents for selection
|
||||
- Muted states for disabled items
|
||||
|
||||
## Architecture
|
||||
|
||||
### State Management
|
||||
|
||||
```
|
||||
loadSkills()
|
||||
→ getSearchDirs(agentType)
|
||||
→ findAllSkills(searchDirs)
|
||||
→ evaluateSkillDirectory() for each
|
||||
→ getQualityGrade(quality.overall)
|
||||
→ SkillsState
|
||||
```
|
||||
|
||||
### Performance Optimizations
|
||||
|
||||
- `createMemo` for filtered lists and computed values
|
||||
- `createSignal` for reactive state management
|
||||
- `createEffect` for side effects and subscriptions
|
||||
- Windowed list rendering for large datasets
|
||||
- Pagination limits rendered items
|
||||
- Progressive animation with phases
|
||||
|
||||
### Animation Timing
|
||||
|
||||
| Animation | Delay |
|
||||
|-----------|-------|
|
||||
| Entrance | 100ms between phases |
|
||||
| Spinner | 80ms interval |
|
||||
| Progress | 200ms interval |
|
||||
|
||||
## Integration
|
||||
|
||||
The TUI integrates with @skillkit/core using Solid.js reactive patterns:
|
||||
|
||||
```typescript
|
||||
import { createSignal, createMemo, createEffect } from 'solid-js';
|
||||
|
||||
const [skills, setSkills] = createSignal([]);
|
||||
|
||||
createEffect(async () => {
|
||||
const result = await findAllSkills(searchDirs);
|
||||
setSkills(result);
|
||||
});
|
||||
|
||||
const filteredSkills = createMemo(() =>
|
||||
skills().filter(s => s.name.includes(searchTerm()))
|
||||
);
|
||||
```
|
||||
|
||||
Core functions:
|
||||
- `findAllSkills(searchDirs)` - Returns skill metadata
|
||||
- `evaluateSkillDirectory(path)` - Quality metrics
|
||||
- `getQualityGrade(score)` - 0-100 to A-F
|
||||
|
||||
## Graceful Exit
|
||||
|
||||
The TUI handles shutdown gracefully:
|
||||
1. Runs Solid.js cleanup functions (`onCleanup`)
|
||||
2. Restores terminal state
|
||||
3. Cleans up signal handlers
|
||||
4. Exits process cleanly
|
||||
|
||||
Press `q` from Home screen or `Ctrl+C` to exit.
|
||||
@@ -0,0 +1,67 @@
|
||||
---
|
||||
title: Workflows
|
||||
description: Compose skills into multi-step orchestrations
|
||||
---
|
||||
|
||||
# Workflows
|
||||
|
||||
Compose skills into multi-step processes.
|
||||
|
||||
## Commands
|
||||
|
||||
```bash
|
||||
skillkit workflow list # List workflows
|
||||
skillkit workflow run <name> # Run workflow
|
||||
skillkit workflow create <name> # Create workflow
|
||||
```
|
||||
|
||||
## Workflow File
|
||||
|
||||
```yaml
|
||||
name: feature-development
|
||||
description: Complete feature workflow
|
||||
|
||||
steps:
|
||||
- name: plan
|
||||
skill: planning
|
||||
|
||||
- name: implement
|
||||
skill: coding-standards
|
||||
|
||||
- name: test
|
||||
skill: testing-patterns
|
||||
|
||||
- name: review
|
||||
skill: code-review
|
||||
```
|
||||
|
||||
## Features
|
||||
|
||||
### Conditional Steps
|
||||
|
||||
```yaml
|
||||
steps:
|
||||
- name: security
|
||||
skill: security-audit
|
||||
condition: "files.any('**/*.ts')"
|
||||
```
|
||||
|
||||
### Parallel Execution
|
||||
|
||||
```yaml
|
||||
steps:
|
||||
- name: checks
|
||||
parallel:
|
||||
- skill: linting
|
||||
- skill: testing
|
||||
```
|
||||
|
||||
## Programmatic API
|
||||
|
||||
```typescript
|
||||
import { WorkflowOrchestrator } from '@skillkit/core'
|
||||
|
||||
const orchestrator = new WorkflowOrchestrator()
|
||||
const workflow = await orchestrator.load('./workflow.yaml')
|
||||
await orchestrator.run(workflow)
|
||||
```
|
||||
@@ -0,0 +1,6 @@
|
||||
/// <reference types="next" />
|
||||
/// <reference types="next/image-types/global" />
|
||||
import "./.next/types/routes.d.ts";
|
||||
|
||||
// NOTE: This file should not be edited
|
||||
// see https://nextjs.org/docs/app/api-reference/config/typescript for more information.
|
||||
@@ -0,0 +1,13 @@
|
||||
import { createMDX } from 'fumadocs-mdx/next';
|
||||
|
||||
const withMDX = createMDX();
|
||||
|
||||
/** @type {import('next').NextConfig} */
|
||||
const config = {
|
||||
reactStrictMode: true,
|
||||
trailingSlash: false,
|
||||
skipTrailingSlashRedirect: true,
|
||||
assetPrefix: 'https://skillkit-docs.vercel.app',
|
||||
};
|
||||
|
||||
export default withMDX(config);
|
||||
@@ -0,0 +1,36 @@
|
||||
{
|
||||
"name": "skillkit-docs",
|
||||
"version": "1.14.0",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"build": "next build",
|
||||
"dev": "next dev",
|
||||
"start": "next start",
|
||||
"types:check": "fumadocs-mdx && next typegen && tsc --noEmit",
|
||||
"postinstall": "fumadocs-mdx",
|
||||
"lint": "next lint"
|
||||
},
|
||||
"dependencies": {
|
||||
"@google/genai": "^1.38.0",
|
||||
"clsx": "^2.1.1",
|
||||
"fumadocs-core": "16.3.2",
|
||||
"fumadocs-mdx": "14.2.2",
|
||||
"fumadocs-ui": "16.3.2",
|
||||
"lucide-react": "^0.561.0",
|
||||
"next": "16.0.10",
|
||||
"next-themes": "^0.4.6",
|
||||
"react": "^19.2.3",
|
||||
"react-dom": "^19.2.3",
|
||||
"tailwind-merge": "^3.4.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@tailwindcss/postcss": "^4.1.18",
|
||||
"@types/mdx": "^2.0.13",
|
||||
"@types/node": "^24.10.2",
|
||||
"@types/react": "^19.2.7",
|
||||
"@types/react-dom": "^19.2.3",
|
||||
"postcss": "^8.5.6",
|
||||
"tailwindcss": "^4.1.18",
|
||||
"typescript": "^5.9.3"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,5 @@
|
||||
export default {
|
||||
plugins: {
|
||||
'@tailwindcss/postcss': {},
|
||||
},
|
||||
};
|
||||
|
After Width: | Height: | Size: 1.0 KiB |
|
After Width: | Height: | Size: 437 B |
@@ -0,0 +1,4 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32">
|
||||
<rect width="32" height="32" fill="#000000"/>
|
||||
<rect x="8" y="8" width="16" height="16" fill="#ffffff"/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 176 B |
|
After Width: | Height: | Size: 158 KiB |
@@ -0,0 +1,21 @@
|
||||
import {
|
||||
defineConfig,
|
||||
defineDocs,
|
||||
frontmatterSchema,
|
||||
metaSchema,
|
||||
} from 'fumadocs-mdx/config';
|
||||
|
||||
export const docs = defineDocs({
|
||||
dir: 'content/docs',
|
||||
docs: {
|
||||
schema: frontmatterSchema,
|
||||
postprocess: {
|
||||
includeProcessedMarkdown: true,
|
||||
},
|
||||
},
|
||||
meta: {
|
||||
schema: metaSchema,
|
||||
},
|
||||
});
|
||||
|
||||
export default defineConfig({});
|
||||
@@ -0,0 +1,41 @@
|
||||
import Link from 'next/link'
|
||||
|
||||
export default function HomeLayout({
|
||||
children,
|
||||
}: {
|
||||
children: React.ReactNode
|
||||
}) {
|
||||
return (
|
||||
<>
|
||||
<nav className="fixed top-0 left-0 right-0 z-50 border-b border-zinc-800 bg-black/90 backdrop-blur-md">
|
||||
<div className="mx-auto max-w-5xl px-4 sm:px-6 lg:px-8">
|
||||
<div className="flex h-14 items-center justify-between">
|
||||
<Link href="/" className="flex items-center gap-2">
|
||||
<div className="w-4 h-4 bg-white"></div>
|
||||
<span className="text-base font-bold tracking-tight text-white font-mono">SKILLKIT</span>
|
||||
</Link>
|
||||
<div className="flex items-center gap-4">
|
||||
<Link
|
||||
href="/docs"
|
||||
className="text-zinc-400 hover:text-white transition-colors text-sm font-mono"
|
||||
>
|
||||
Docs
|
||||
</Link>
|
||||
<a
|
||||
href="https://github.com/rohitg00/skillkit"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
className="text-zinc-400 hover:text-white transition-colors text-sm font-mono"
|
||||
>
|
||||
GitHub
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
<div className="pt-14">
|
||||
{children}
|
||||
</div>
|
||||
</>
|
||||
)
|
||||
}
|
||||
@@ -0,0 +1,96 @@
|
||||
import Link from 'next/link'
|
||||
|
||||
export default function HomePage() {
|
||||
return (
|
||||
<div className="min-h-screen bg-black text-zinc-100">
|
||||
<main className="mx-auto max-w-5xl px-4 sm:px-6 lg:px-8 py-20">
|
||||
{/* Hero */}
|
||||
<div className="text-center mb-16">
|
||||
<div className="inline-flex items-center space-x-2 border border-zinc-800 bg-zinc-900/50 px-3 py-1 mb-6">
|
||||
<span className="flex h-2 w-2 bg-white rounded-full"></span>
|
||||
<span className="text-sm font-mono text-zinc-400">v1.8.0</span>
|
||||
</div>
|
||||
|
||||
<h1 className="text-4xl sm:text-5xl lg:text-6xl font-bold tracking-tight text-white mb-6 font-mono">
|
||||
Universal Skills for<br />
|
||||
<span className="text-zinc-500">AI Coding Agents</span>
|
||||
</h1>
|
||||
|
||||
<p className="text-lg text-zinc-400 mb-8 max-w-2xl mx-auto font-mono">
|
||||
One CLI to install, sync, and manage skills across Claude Code, Cursor,
|
||||
Windsurf, Copilot, and 28 more agents. 15,000+ skills ready to use.
|
||||
</p>
|
||||
|
||||
<div className="flex flex-wrap justify-center gap-4 mb-12">
|
||||
<code className="inline-flex items-center bg-zinc-900 border border-zinc-700 px-4 py-3 text-sm font-mono">
|
||||
<span className="text-zinc-500 mr-2">$</span>
|
||||
<span className="text-white">npx skillkit@latest</span>
|
||||
</code>
|
||||
|
||||
<Link
|
||||
href="/docs"
|
||||
className="inline-flex items-center bg-white text-black px-6 py-3 font-mono text-sm hover:bg-zinc-200 transition-colors"
|
||||
>
|
||||
Read the Docs →
|
||||
</Link>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{/* Features Grid */}
|
||||
<div className="grid grid-cols-1 md:grid-cols-3 gap-6 mb-16">
|
||||
<div className="border border-zinc-800 bg-zinc-900/30 p-6">
|
||||
<h3 className="text-lg font-bold text-white mb-2 font-mono">32 Agents</h3>
|
||||
<p className="text-zinc-500 text-sm">Claude, Cursor, Codex, Windsurf, Copilot, and 27 more supported out of the box.</p>
|
||||
</div>
|
||||
<div className="border border-zinc-800 bg-zinc-900/30 p-6">
|
||||
<h3 className="text-lg font-bold text-white mb-2 font-mono">15,000+ Skills</h3>
|
||||
<p className="text-zinc-500 text-sm">Browse the marketplace or create your own. Install with a single command.</p>
|
||||
</div>
|
||||
<div className="border border-zinc-800 bg-zinc-900/30 p-6">
|
||||
<h3 className="text-lg font-bold text-white mb-2 font-mono">Auto Translation</h3>
|
||||
<p className="text-zinc-500 text-sm">Write once, deploy everywhere. Automatic format conversion between all agents.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{/* Quick Links */}
|
||||
<div className="text-center">
|
||||
<h2 className="text-2xl font-bold text-white mb-6 font-mono">Get Started</h2>
|
||||
<div className="flex flex-wrap justify-center gap-4">
|
||||
<Link href="/docs/quickstart" className="text-zinc-400 hover:text-white font-mono text-sm border border-zinc-800 px-4 py-2 hover:border-zinc-600 transition-colors">
|
||||
Quick Start
|
||||
</Link>
|
||||
<Link href="/docs/primer" className="text-zinc-400 hover:text-white font-mono text-sm border border-zinc-800 px-4 py-2 hover:border-zinc-600 transition-colors">
|
||||
Primer
|
||||
</Link>
|
||||
<Link href="/docs/memory" className="text-zinc-400 hover:text-white font-mono text-sm border border-zinc-800 px-4 py-2 hover:border-zinc-600 transition-colors">
|
||||
Memory System
|
||||
</Link>
|
||||
<Link href="/docs/mesh" className="text-zinc-400 hover:text-white font-mono text-sm border border-zinc-800 px-4 py-2 hover:border-zinc-600 transition-colors">
|
||||
Mesh Network
|
||||
</Link>
|
||||
<Link href="/docs/api-reference" className="text-zinc-400 hover:text-white font-mono text-sm border border-zinc-800 px-4 py-2 hover:border-zinc-600 transition-colors">
|
||||
API Reference
|
||||
</Link>
|
||||
</div>
|
||||
</div>
|
||||
</main>
|
||||
|
||||
{/* Footer */}
|
||||
<footer className="border-t border-zinc-800 py-8">
|
||||
<div className="mx-auto max-w-5xl px-4 sm:px-6 lg:px-8">
|
||||
<div className="flex flex-col sm:flex-row items-center justify-between gap-4">
|
||||
<div className="flex items-center gap-2">
|
||||
<div className="w-4 h-4 bg-white"></div>
|
||||
<span className="font-mono font-bold text-white">SKILLKIT</span>
|
||||
</div>
|
||||
<div className="flex items-center gap-6 text-sm font-mono text-zinc-500">
|
||||
<a href="https://github.com/rohitg00/skillkit" target="_blank" rel="noopener noreferrer" className="hover:text-white transition-colors">GitHub</a>
|
||||
<a href="https://www.npmjs.com/package/skillkit" target="_blank" rel="noopener noreferrer" className="hover:text-white transition-colors">npm</a>
|
||||
<Link href="/docs" className="hover:text-white transition-colors">Docs</Link>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
@@ -0,0 +1,190 @@
|
||||
import { GoogleGenAI, Type, Schema } from "@google/genai";
|
||||
import { NextRequest, NextResponse } from "next/server";
|
||||
|
||||
const rateLimitMap = new Map<string, { count: number; resetTime: number }>();
|
||||
const RATE_LIMIT_WINDOW_MS = 60 * 1000;
|
||||
const RATE_LIMIT_MAX_REQUESTS = 10;
|
||||
|
||||
function getRateLimitKey(request: NextRequest): string {
|
||||
const forwarded = request.headers.get("x-forwarded-for");
|
||||
const ip = forwarded ? forwarded.split(",")[0].trim() : "unknown";
|
||||
return ip;
|
||||
}
|
||||
|
||||
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 agentSkillSchema: Schema = {
|
||||
type: Type.OBJECT,
|
||||
properties: {
|
||||
name: { type: Type.STRING, description: "Skill name in slug format (e.g., 'react-best-practices')" },
|
||||
title: { type: Type.STRING, description: "Human readable title" },
|
||||
description: { type: Type.STRING, description: "Brief description of what this skill teaches AI agents" },
|
||||
version: { type: Type.STRING, description: "Semantic version (e.g., '1.0.0')" },
|
||||
tags: {
|
||||
type: Type.ARRAY,
|
||||
items: { type: Type.STRING },
|
||||
description: "Tags for categorization"
|
||||
},
|
||||
applicability: { type: Type.STRING, description: "When the AI agent should apply this skill (e.g., 'Apply when working with React components')" },
|
||||
principles: {
|
||||
type: Type.ARRAY,
|
||||
items: {
|
||||
type: Type.OBJECT,
|
||||
properties: {
|
||||
title: { type: Type.STRING },
|
||||
description: { type: Type.STRING, description: "Detailed instruction for the AI agent" },
|
||||
priority: { type: Type.STRING, description: "must, should, or may" }
|
||||
},
|
||||
required: ["title", "description", "priority"]
|
||||
},
|
||||
description: "Core principles and guidelines (5-8 items)"
|
||||
},
|
||||
patterns: {
|
||||
type: Type.ARRAY,
|
||||
items: {
|
||||
type: Type.OBJECT,
|
||||
properties: {
|
||||
name: { type: Type.STRING },
|
||||
description: { type: Type.STRING },
|
||||
example: { type: Type.STRING, description: "Code example demonstrating the pattern" },
|
||||
language: { type: Type.STRING, description: "Programming language for syntax highlighting" }
|
||||
},
|
||||
required: ["name", "description", "example"]
|
||||
},
|
||||
description: "Code patterns with examples (3-5 items)"
|
||||
},
|
||||
antiPatterns: {
|
||||
type: Type.ARRAY,
|
||||
items: {
|
||||
type: Type.OBJECT,
|
||||
properties: {
|
||||
name: { type: Type.STRING },
|
||||
description: { type: Type.STRING },
|
||||
badExample: { type: Type.STRING, description: "Code showing what NOT to do" },
|
||||
goodExample: { type: Type.STRING, description: "Code showing the correct approach" }
|
||||
},
|
||||
required: ["name", "description"]
|
||||
},
|
||||
description: "Anti-patterns to avoid (2-4 items)"
|
||||
},
|
||||
filePatterns: {
|
||||
type: Type.ARRAY,
|
||||
items: { type: Type.STRING },
|
||||
description: "Glob patterns for files this skill applies to (e.g., '*.tsx', 'src/components/**')"
|
||||
},
|
||||
references: {
|
||||
type: Type.ARRAY,
|
||||
items: { type: Type.STRING },
|
||||
description: "Links to official documentation or resources"
|
||||
}
|
||||
},
|
||||
required: ["name", "title", "description", "version", "tags", "applicability", "principles", "patterns", "antiPatterns"]
|
||||
};
|
||||
|
||||
export async function POST(request: NextRequest): Promise<NextResponse> {
|
||||
const rateLimitKey = getRateLimitKey(request);
|
||||
const { allowed, remaining } = checkRateLimit(rateLimitKey);
|
||||
|
||||
if (!allowed) {
|
||||
return NextResponse.json(
|
||||
{ error: "Rate limit exceeded. Please try again later." },
|
||||
{
|
||||
status: 429,
|
||||
headers: {
|
||||
"X-RateLimit-Remaining": "0",
|
||||
"Retry-After": "60",
|
||||
},
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
let body: unknown;
|
||||
try {
|
||||
body = await request.json();
|
||||
} catch {
|
||||
return NextResponse.json({ error: "Invalid JSON body" }, { status: 400 });
|
||||
}
|
||||
|
||||
if (typeof body !== "object" || body === null) {
|
||||
return NextResponse.json({ error: "Invalid request body" }, { status: 400 });
|
||||
}
|
||||
|
||||
const { topic } = body as { topic?: unknown };
|
||||
|
||||
if (typeof topic !== "string") {
|
||||
return NextResponse.json({ error: "Topic is required and must be a string" }, { status: 400 });
|
||||
}
|
||||
|
||||
const sanitizedTopic = topic.trim().slice(0, 500);
|
||||
if (!sanitizedTopic) {
|
||||
return NextResponse.json({ error: "Topic cannot be empty" }, { status: 400 });
|
||||
}
|
||||
|
||||
const apiKey = process.env.GEMINI_API_KEY;
|
||||
if (!apiKey) {
|
||||
return NextResponse.json({ error: "Gemini API key not configured" }, { status: 500 });
|
||||
}
|
||||
|
||||
try {
|
||||
const ai = new GoogleGenAI({ apiKey });
|
||||
const response = await ai.models.generateContent({
|
||||
model: "gemini-2.0-flash",
|
||||
contents: `Create a comprehensive AI coding agent skill for: "${sanitizedTopic}"
|
||||
|
||||
This skill will be used by AI coding assistants (like Claude Code, Cursor, GitHub Copilot) to provide better code suggestions and follow best practices.
|
||||
|
||||
The skill should include:
|
||||
1. Clear principles that tell the AI WHAT to do and WHEN
|
||||
2. Code patterns with REAL, WORKING examples (not pseudocode)
|
||||
3. Anti-patterns showing common mistakes and how to fix them
|
||||
4. Specific file patterns where this skill applies
|
||||
|
||||
Make the instructions actionable and specific. The AI agent should be able to directly apply these guidelines when writing code.
|
||||
|
||||
Focus on practical, production-ready patterns used in modern development.`,
|
||||
config: {
|
||||
responseMimeType: "application/json",
|
||||
responseSchema: agentSkillSchema,
|
||||
systemInstruction: `You are an expert software architect creating AI agent skills.
|
||||
Your skills are used by AI coding assistants to write better code.
|
||||
|
||||
Guidelines:
|
||||
- Write instructions as commands to the AI (e.g., "Always use...", "Never...", "Prefer...")
|
||||
- Include REAL code examples, not pseudocode
|
||||
- Be specific and actionable
|
||||
- Focus on modern best practices (2024+)
|
||||
- Include edge cases and error handling patterns
|
||||
- Make principles enforceable and testable`
|
||||
}
|
||||
});
|
||||
|
||||
if (!response.text) {
|
||||
return NextResponse.json({ error: "No response from Gemini" }, { status: 500 });
|
||||
}
|
||||
|
||||
const data = JSON.parse(response.text);
|
||||
return NextResponse.json(data, {
|
||||
headers: {
|
||||
"X-RateLimit-Remaining": String(remaining),
|
||||
},
|
||||
});
|
||||
} catch (error) {
|
||||
console.error("Gemini API Error:", error);
|
||||
return NextResponse.json({ error: "Failed to generate skill" }, { status: 500 });
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,42 @@
|
||||
import { source } from '@/lib/source'
|
||||
import { DocsBody, DocsDescription, DocsPage, DocsTitle } from 'fumadocs-ui/layouts/docs/page'
|
||||
import { notFound } from 'next/navigation'
|
||||
import { getMDXComponents } from '@/mdx-components'
|
||||
import type { Metadata } from 'next'
|
||||
|
||||
interface PageProps {
|
||||
params: Promise<{ slug?: string[] }>
|
||||
}
|
||||
|
||||
export default async function Page(props: PageProps) {
|
||||
const params = await props.params
|
||||
const page = source.getPage(params.slug ?? [])
|
||||
if (!page) notFound()
|
||||
|
||||
const MDX = page.data.body
|
||||
|
||||
return (
|
||||
<DocsPage toc={page.data.toc} full={page.data.full} tableOfContent={{ style: 'clerk' }}>
|
||||
<DocsTitle>{page.data.title}</DocsTitle>
|
||||
<DocsDescription>{page.data.description}</DocsDescription>
|
||||
<DocsBody>
|
||||
<MDX components={getMDXComponents({})} />
|
||||
</DocsBody>
|
||||
</DocsPage>
|
||||
)
|
||||
}
|
||||
|
||||
export async function generateStaticParams() {
|
||||
return source.generateParams()
|
||||
}
|
||||
|
||||
export async function generateMetadata(props: PageProps): Promise<Metadata> {
|
||||
const params = await props.params
|
||||
const page = source.getPage(params.slug ?? [])
|
||||
if (!page) notFound()
|
||||
|
||||
return {
|
||||
title: page.data.title,
|
||||
description: page.data.description,
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,17 @@
|
||||
import { baseOptions } from '@/lib/layout.shared'
|
||||
import { source } from '@/lib/source'
|
||||
import { DocsLayout } from 'fumadocs-ui/layouts/docs'
|
||||
|
||||
export default function Layout({ children }: { children: React.ReactNode }) {
|
||||
return (
|
||||
<DocsLayout
|
||||
tree={source.pageTree}
|
||||
{...baseOptions()}
|
||||
sidebar={{
|
||||
collapsible: true,
|
||||
}}
|
||||
>
|
||||
{children}
|
||||
</DocsLayout>
|
||||
)
|
||||
}
|
||||
@@ -0,0 +1,160 @@
|
||||
@import 'tailwindcss';
|
||||
@import 'fumadocs-ui/css/neutral.css';
|
||||
@import 'fumadocs-ui/css/preset.css';
|
||||
|
||||
@theme {
|
||||
--font-sans: "Inter", ui-sans-serif, system-ui, sans-serif;
|
||||
|
||||
--color-skillkit-black: #000000;
|
||||
--color-skillkit-dark: #18181b;
|
||||
--color-skillkit-medium: #71717a;
|
||||
--color-skillkit-light: #fafafa;
|
||||
--color-skillkit-blue: #3b82f6;
|
||||
|
||||
/* Light mode defaults */
|
||||
--color-fd-background: #ffffff;
|
||||
--color-fd-foreground: var(--color-skillkit-black);
|
||||
--color-fd-muted: #f4f4f5;
|
||||
--color-fd-muted-foreground: var(--color-skillkit-medium);
|
||||
--color-fd-popover: #ffffff;
|
||||
--color-fd-popover-foreground: var(--color-skillkit-black);
|
||||
--color-fd-card: #ffffff;
|
||||
--color-fd-card-foreground: var(--color-skillkit-black);
|
||||
--color-fd-border: #e4e4e7;
|
||||
--color-fd-primary: var(--color-skillkit-blue);
|
||||
--color-fd-primary-foreground: #ffffff;
|
||||
--color-fd-secondary: #f4f4f5;
|
||||
--color-fd-secondary-foreground: var(--color-skillkit-black);
|
||||
--color-fd-accent: #f4f4f5;
|
||||
--color-fd-accent-foreground: var(--color-skillkit-black);
|
||||
--color-fd-ring: var(--color-skillkit-blue);
|
||||
}
|
||||
|
||||
/* Dark mode */
|
||||
:root.dark {
|
||||
--color-fd-background: var(--color-skillkit-black);
|
||||
--color-fd-foreground: var(--color-skillkit-light);
|
||||
--color-fd-muted: var(--color-skillkit-dark);
|
||||
--color-fd-muted-foreground: #a1a1aa;
|
||||
--color-fd-popover: var(--color-skillkit-dark);
|
||||
--color-fd-popover-foreground: var(--color-skillkit-light);
|
||||
--color-fd-card: var(--color-skillkit-dark);
|
||||
--color-fd-card-foreground: var(--color-skillkit-light);
|
||||
--color-fd-border: #27272a;
|
||||
--color-fd-primary: var(--color-skillkit-blue);
|
||||
--color-fd-primary-foreground: #ffffff;
|
||||
--color-fd-secondary: var(--color-skillkit-dark);
|
||||
--color-fd-secondary-foreground: var(--color-skillkit-light);
|
||||
--color-fd-accent: var(--color-skillkit-dark);
|
||||
--color-fd-accent-foreground: var(--color-skillkit-light);
|
||||
--color-fd-ring: var(--color-skillkit-blue);
|
||||
}
|
||||
|
||||
body {
|
||||
background-color: var(--color-fd-background);
|
||||
color: var(--color-fd-foreground);
|
||||
}
|
||||
|
||||
::selection {
|
||||
background-color: var(--color-skillkit-blue);
|
||||
color: #ffffff;
|
||||
}
|
||||
|
||||
/* Light mode code blocks */
|
||||
pre {
|
||||
background-color: #f8f8f8 !important;
|
||||
border: 1px solid #e4e4e7;
|
||||
}
|
||||
|
||||
code {
|
||||
background-color: #f4f4f5;
|
||||
color: var(--color-skillkit-black);
|
||||
padding: 0.2em 0.4em;
|
||||
border-radius: 4px;
|
||||
font-size: 0.875em;
|
||||
}
|
||||
|
||||
pre code {
|
||||
background-color: transparent;
|
||||
color: inherit;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
/* Dark mode code blocks */
|
||||
:root.dark pre {
|
||||
background-color: #0d0d0d !important;
|
||||
border: 1px solid #27272a;
|
||||
}
|
||||
|
||||
:root.dark code {
|
||||
background-color: #27272a;
|
||||
color: #e4e4e7;
|
||||
}
|
||||
|
||||
:root.dark pre code {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
/* Inline code in paragraphs */
|
||||
p code, li code, td code {
|
||||
font-weight: 500;
|
||||
}
|
||||
|
||||
/* Tables */
|
||||
table {
|
||||
width: 100%;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
|
||||
th, td {
|
||||
padding: 0.75rem 1rem;
|
||||
text-align: left;
|
||||
border-bottom: 1px solid var(--color-fd-border);
|
||||
}
|
||||
|
||||
th {
|
||||
font-weight: 600;
|
||||
background-color: var(--color-fd-muted);
|
||||
}
|
||||
|
||||
/* Lists */
|
||||
ul, ol {
|
||||
padding-left: 1.5rem;
|
||||
}
|
||||
|
||||
li {
|
||||
margin: 0.5rem 0;
|
||||
}
|
||||
|
||||
/* Landing page animations */
|
||||
@keyframes scroll {
|
||||
0% { transform: translateX(0); }
|
||||
100% { transform: translateX(-50%); }
|
||||
}
|
||||
|
||||
.animate-scroll {
|
||||
animation: scroll 35s linear infinite;
|
||||
}
|
||||
|
||||
@keyframes fade-in {
|
||||
from { opacity: 0; transform: translateY(10px); }
|
||||
to { opacity: 1; transform: translateY(0); }
|
||||
}
|
||||
|
||||
.animate-fade-in {
|
||||
animation: fade-in 0.6s ease-out forwards;
|
||||
}
|
||||
|
||||
.animate-fade-in-delay {
|
||||
animation: fade-in 0.6s ease-out 0.2s forwards;
|
||||
opacity: 0;
|
||||
}
|
||||
|
||||
/* Landing page specific styles */
|
||||
.bg-background {
|
||||
background-color: #000000;
|
||||
}
|
||||
|
||||
.bg-surface {
|
||||
background-color: rgba(24, 24, 27, 0.5);
|
||||
}
|
||||
@@ -0,0 +1,48 @@
|
||||
import { RootProvider } from 'fumadocs-ui/provider/next'
|
||||
import './global.css'
|
||||
import { Inter } from 'next/font/google'
|
||||
import type { Metadata } from 'next'
|
||||
|
||||
const inter = Inter({
|
||||
subsets: ['latin'],
|
||||
weight: ['400', '500', '600', '700'],
|
||||
})
|
||||
|
||||
export const metadata: Metadata = {
|
||||
title: {
|
||||
default: 'SkillKit - Universal Skills for AI Coding Agents',
|
||||
template: '%s | SkillKit',
|
||||
},
|
||||
description: 'One CLI to install, sync, and manage skills across Claude Code, Cursor, Windsurf, Copilot, and 28 more agents. 15,000+ skills ready to use.',
|
||||
icons: {
|
||||
icon: [
|
||||
{ url: '/favicon.svg', type: 'image/svg+xml' },
|
||||
{ url: '/favicon-32.png', sizes: '32x32', type: 'image/png' },
|
||||
],
|
||||
apple: '/apple-touch-icon.png',
|
||||
},
|
||||
openGraph: {
|
||||
title: 'SkillKit - Universal Skills for AI Coding Agents',
|
||||
description: 'One CLI to install, sync, and manage skills across Claude Code, Cursor, Windsurf, Copilot, and 28 more agents.',
|
||||
url: 'https://agenstskills.com',
|
||||
siteName: 'SkillKit',
|
||||
images: [{ url: '/og-image.png', width: 1200, height: 630 }],
|
||||
type: 'website',
|
||||
},
|
||||
twitter: {
|
||||
card: 'summary_large_image',
|
||||
title: 'SkillKit - Universal Skills for AI Coding Agents',
|
||||
description: 'One CLI to install, sync, and manage skills across Claude Code, Cursor, Windsurf, Copilot, and 28 more agents.',
|
||||
images: ['/og-image.png'],
|
||||
},
|
||||
}
|
||||
|
||||
export default function Layout({ children }: { children: React.ReactNode }) {
|
||||
return (
|
||||
<html lang="en" className={inter.className} suppressHydrationWarning>
|
||||
<body className="flex flex-col min-h-screen">
|
||||
<RootProvider>{children}</RootProvider>
|
||||
</body>
|
||||
</html>
|
||||
)
|
||||
}
|
||||
@@ -0,0 +1,55 @@
|
||||
import React from 'react';
|
||||
|
||||
interface ButtonProps extends React.ButtonHTMLAttributes<HTMLButtonElement> {
|
||||
variant?: 'primary' | 'secondary' | 'outline' | 'ghost';
|
||||
fullWidth?: boolean;
|
||||
isLoading?: boolean;
|
||||
}
|
||||
|
||||
const BASE_STYLES = "inline-flex items-center justify-center px-6 py-3 text-sm font-medium transition-all duration-200 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-offset-black disabled:opacity-50 font-mono tracking-tight";
|
||||
|
||||
const VARIANT_STYLES = {
|
||||
primary: "bg-white text-black hover:bg-zinc-200 border border-white",
|
||||
secondary: "bg-zinc-900 text-zinc-100 hover:bg-zinc-800 border border-zinc-800",
|
||||
outline: "bg-transparent text-zinc-300 border border-zinc-700 hover:border-zinc-500 hover:text-white",
|
||||
ghost: "bg-transparent text-zinc-400 hover:text-white hover:bg-zinc-900"
|
||||
} as const;
|
||||
|
||||
export function Button({
|
||||
children,
|
||||
variant = 'primary',
|
||||
className = '',
|
||||
fullWidth = false,
|
||||
isLoading = false,
|
||||
disabled,
|
||||
type = 'button',
|
||||
...props
|
||||
}: ButtonProps): React.ReactElement {
|
||||
const widthClass = fullWidth ? 'w-full' : '';
|
||||
|
||||
const classes = [
|
||||
BASE_STYLES,
|
||||
VARIANT_STYLES[variant],
|
||||
widthClass,
|
||||
className,
|
||||
].filter(Boolean).join(' ');
|
||||
|
||||
return (
|
||||
<button
|
||||
className={classes}
|
||||
type={type}
|
||||
disabled={disabled || isLoading}
|
||||
{...props}
|
||||
>
|
||||
{isLoading ? (
|
||||
<>
|
||||
<svg className="animate-spin -ml-1 mr-2 h-4 w-4" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24">
|
||||
<circle className="opacity-25" cx="12" cy="12" r="10" stroke="currentColor" strokeWidth="4"></circle>
|
||||
<path className="opacity-75" fill="currentColor" d="M4 12a8 8 0 018-8V0C5.373 0 0 5.373 0 12h4zm2 5.291A7.962 7.962 0 014 12H0c0 3.042 1.135 5.824 3 7.938l3-2.647z"></path>
|
||||
</svg>
|
||||
PROCESSING
|
||||
</>
|
||||
) : children}
|
||||
</button>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,49 @@
|
||||
import React from 'react';
|
||||
|
||||
interface CardProps {
|
||||
children: React.ReactNode;
|
||||
className?: string;
|
||||
noPadding?: boolean;
|
||||
onClick?: () => void;
|
||||
onDragOver?: (e: React.DragEvent) => void;
|
||||
onDragLeave?: (e: React.DragEvent) => void;
|
||||
onDrop?: (e: React.DragEvent) => void;
|
||||
}
|
||||
|
||||
export function Card({
|
||||
children,
|
||||
className = '',
|
||||
noPadding = false,
|
||||
onClick,
|
||||
onDragOver,
|
||||
onDragLeave,
|
||||
onDrop
|
||||
}: CardProps): React.ReactElement {
|
||||
const paddingClass = noPadding ? '' : 'p-6';
|
||||
const clickableClass = onClick ? 'cursor-pointer' : '';
|
||||
|
||||
function handleKeyDown(e: React.KeyboardEvent): void {
|
||||
if (!onClick) return;
|
||||
if (e.key === 'Enter' || e.key === ' ') {
|
||||
if (e.key === ' ') {
|
||||
e.preventDefault();
|
||||
}
|
||||
onClick();
|
||||
}
|
||||
}
|
||||
|
||||
return (
|
||||
<div
|
||||
className={`relative bg-black border border-zinc-800 transition-colors duration-300 ${paddingClass} ${clickableClass} ${className}`}
|
||||
onClick={onClick}
|
||||
role={onClick ? 'button' : undefined}
|
||||
tabIndex={onClick ? 0 : undefined}
|
||||
onKeyDown={onClick ? handleKeyDown : undefined}
|
||||
onDragOver={onDragOver}
|
||||
onDragLeave={onDragLeave}
|
||||
onDrop={onDrop}
|
||||
>
|
||||
{children}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,112 @@
|
||||
import React, { useState } from 'react';
|
||||
|
||||
interface CommandGroup {
|
||||
name: string;
|
||||
commands: Array<{ cmd: string; desc: string }>;
|
||||
}
|
||||
|
||||
const COMMAND_GROUPS: CommandGroup[] = [
|
||||
{
|
||||
name: 'Core',
|
||||
commands: [
|
||||
{ cmd: 'install', desc: 'Install from GitHub/GitLab/local' },
|
||||
{ cmd: 'sync', desc: 'Sync skills across agents' },
|
||||
{ cmd: 'translate', desc: 'Convert between agent formats' },
|
||||
{ cmd: 'update', desc: 'Update installed skills' },
|
||||
],
|
||||
},
|
||||
{
|
||||
name: 'Discovery',
|
||||
commands: [
|
||||
{ cmd: 'find', desc: 'Search marketplace (15K+ skills)' },
|
||||
{ cmd: 'recommend', desc: 'AI-powered suggestions' },
|
||||
{ cmd: 'check', desc: 'Dry-run update check' },
|
||||
{ cmd: 'list', desc: 'View installed skills' },
|
||||
],
|
||||
},
|
||||
{
|
||||
name: 'Team',
|
||||
commands: [
|
||||
{ cmd: 'manifest init', desc: 'Create .skills file' },
|
||||
{ cmd: 'manifest install', desc: 'Install from manifest' },
|
||||
{ cmd: 'team share', desc: 'Share skills via Git' },
|
||||
{ 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: [
|
||||
{ cmd: 'ui', desc: 'Launch terminal UI' },
|
||||
{ cmd: 'workflow run', desc: 'Execute skill pipelines' },
|
||||
{ cmd: 'command generate', desc: 'Create /slash commands' },
|
||||
{ cmd: 'cicd init', desc: 'Generate CI templates' },
|
||||
],
|
||||
},
|
||||
];
|
||||
|
||||
export function Commands(): React.ReactElement {
|
||||
const [activeGroup, setActiveGroup] = useState(0);
|
||||
const group = COMMAND_GROUPS[activeGroup];
|
||||
|
||||
return (
|
||||
<section className="py-12 border-b border-zinc-800">
|
||||
<div className="mx-auto max-w-5xl px-4 sm:px-6 lg:px-8">
|
||||
<div className="text-center mb-8">
|
||||
<h2 className="text-xl font-bold text-white mb-2 font-mono">40+ Commands</h2>
|
||||
<p className="text-zinc-500 font-mono text-sm">
|
||||
Everything you need from the terminal.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div className="flex justify-center gap-2 mb-6">
|
||||
{COMMAND_GROUPS.map((g, i) => {
|
||||
const isActive = i === activeGroup;
|
||||
const buttonClass = isActive
|
||||
? 'border-white text-white bg-zinc-900'
|
||||
: 'border-zinc-800 text-zinc-500 hover:border-zinc-600 hover:text-zinc-300';
|
||||
return (
|
||||
<button
|
||||
key={g.name}
|
||||
onClick={() => setActiveGroup(i)}
|
||||
className={`px-3 py-1.5 text-xs font-mono border transition-colors ${buttonClass}`}
|
||||
>
|
||||
{g.name}
|
||||
</button>
|
||||
);
|
||||
})}
|
||||
</div>
|
||||
|
||||
<div className="border border-zinc-800 bg-black/50 p-4 font-mono text-xs">
|
||||
<div className="grid grid-cols-1 sm:grid-cols-2 gap-2">
|
||||
{group.commands.map((c) => (
|
||||
<div
|
||||
key={c.cmd}
|
||||
className="flex items-center gap-3 p-2 hover:bg-zinc-900/50 transition-colors rounded"
|
||||
>
|
||||
<span className="text-zinc-600">$</span>
|
||||
<span className="text-white">skillkit {c.cmd}</span>
|
||||
<span className="text-zinc-600 hidden sm:inline">→</span>
|
||||
<span className="text-zinc-500 hidden sm:inline truncate">{c.desc}</span>
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div className="mt-4 text-center">
|
||||
<span className="text-zinc-600 text-xs font-mono">
|
||||
Run <span className="text-zinc-400">skillkit --help</span> for all commands
|
||||
</span>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,498 @@
|
||||
'use client'
|
||||
|
||||
import React, { useState } from 'react';
|
||||
|
||||
interface DocSection {
|
||||
id: string;
|
||||
title: string;
|
||||
content: React.ReactNode;
|
||||
}
|
||||
|
||||
const CodeBlock = ({ children, language = 'bash' }: { children: string; language?: string }) => (
|
||||
<pre className="bg-zinc-900 border border-zinc-800 rounded-lg p-4 overflow-x-auto text-sm font-mono">
|
||||
<code className="text-zinc-300">{children}</code>
|
||||
</pre>
|
||||
);
|
||||
|
||||
const Table = ({ headers, rows }: { headers: string[]; rows: string[][] }) => (
|
||||
<div className="overflow-x-auto">
|
||||
<table className="w-full text-sm border-collapse">
|
||||
<thead>
|
||||
<tr className="border-b border-zinc-700">
|
||||
{headers.map((h, i) => (
|
||||
<th key={i} className="text-left py-2 px-3 text-zinc-300 font-mono font-semibold">{h}</th>
|
||||
))}
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
{rows.map((row, i) => (
|
||||
<tr key={i} className="border-b border-zinc-800 hover:bg-zinc-900/50">
|
||||
{row.map((cell, j) => (
|
||||
<td key={j} className="py-2 px-3 text-zinc-400 font-mono">{cell}</td>
|
||||
))}
|
||||
</tr>
|
||||
))}
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
);
|
||||
|
||||
const sections: DocSection[] = [
|
||||
{
|
||||
id: 'overview',
|
||||
title: 'Overview',
|
||||
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.
|
||||
</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">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">Team Collaboration</span> - Share skills via .skills manifest files and publish to marketplace</li>
|
||||
</ul>
|
||||
</div>
|
||||
),
|
||||
},
|
||||
{
|
||||
id: 'installation',
|
||||
title: 'Installation',
|
||||
content: (
|
||||
<div className="space-y-4">
|
||||
<h3 className="text-lg font-semibold text-white">Quick Start</h3>
|
||||
<CodeBlock>{`# Install globally via npm
|
||||
npm install -g skillkit
|
||||
|
||||
# Or use npx directly
|
||||
npx skillkit --help
|
||||
|
||||
# Or install via pnpm
|
||||
pnpm add -g skillkit`}</CodeBlock>
|
||||
|
||||
<h3 className="text-lg font-semibold text-white mt-6">Verify Installation</h3>
|
||||
<CodeBlock>{`skillkit --version
|
||||
skillkit --help`}</CodeBlock>
|
||||
|
||||
<h3 className="text-lg font-semibold text-white mt-6">First Steps</h3>
|
||||
<CodeBlock>{`# Initialize SkillKit in your project
|
||||
skillkit init
|
||||
|
||||
# Browse available skills
|
||||
skillkit marketplace
|
||||
|
||||
# Get AI-powered recommendations
|
||||
skillkit recommend
|
||||
|
||||
# Install skills from a source
|
||||
skillkit install anthropics/skills`}</CodeBlock>
|
||||
</div>
|
||||
),
|
||||
},
|
||||
{
|
||||
id: 'architecture',
|
||||
title: 'Architecture',
|
||||
content: (
|
||||
<div className="space-y-4">
|
||||
<p className="text-zinc-300">
|
||||
SkillKit employs a three-tier design with clean separation of concerns:
|
||||
</p>
|
||||
|
||||
<h3 className="text-lg font-semibold text-white mt-6">System Tiers</h3>
|
||||
<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>
|
||||
</ul>
|
||||
|
||||
<h3 className="text-lg font-semibold text-white mt-6">Monorepo Structure</h3>
|
||||
<CodeBlock language="text">{`skillkit-monorepo (pnpm workspace + Turbo)
|
||||
├── apps/skillkit/ → Main CLI application (bin: skillkit, sk)
|
||||
├── packages/core/ → Core business logic (no internal dependencies)
|
||||
├── packages/agents/ → Agent adapters (depends on core)
|
||||
├── packages/cli/ → Command implementations (depends on core, agents, tui)
|
||||
├── packages/tui/ → Terminal UI (depends on core, agents)
|
||||
└── docs/skillkit/ → Documentation website`}</CodeBlock>
|
||||
|
||||
<h3 className="text-lg font-semibold text-white mt-6">Dependency Hierarchy</h3>
|
||||
<ul className="list-disc list-inside space-y-2 text-zinc-400">
|
||||
<li><code className="text-emerald-400">@skillkit/core</code> → Foundation (no SkillKit dependencies)</li>
|
||||
<li><code className="text-emerald-400">@skillkit/agents</code> → Adapters (depends on core)</li>
|
||||
<li><code className="text-emerald-400">@skillkit/cli</code>, <code className="text-emerald-400">@skillkit/tui</code> → UIs (depend on core and agents)</li>
|
||||
<li><code className="text-emerald-400">skillkit</code> app → Orchestrates all packages</li>
|
||||
</ul>
|
||||
</div>
|
||||
),
|
||||
},
|
||||
{
|
||||
id: 'agents',
|
||||
title: 'Supported Agents',
|
||||
content: (
|
||||
<div className="space-y-4">
|
||||
<p className="text-zinc-300">
|
||||
SkillKit supports 32 AI coding agents with automatic format translation:
|
||||
</p>
|
||||
|
||||
<Table
|
||||
headers={['Agent', 'Directory', 'Format']}
|
||||
rows={[
|
||||
['Claude Code', '.claude/skills/', 'SKILL.md'],
|
||||
['Cursor', '.cursor/skills/', '.mdc'],
|
||||
['GitHub Copilot', '.github/skills/', 'Markdown'],
|
||||
['Gemini CLI', '.gemini/skills/', 'SKILL.md'],
|
||||
['Windsurf', '.windsurf/skills/', 'Markdown'],
|
||||
['Codex', '.codex/skills/', 'SKILL.md'],
|
||||
['OpenCode', '.opencode/skills/', 'SKILL.md'],
|
||||
['Antigravity', '.antigravity/skills/', 'SKILL.md'],
|
||||
['Amp', '.amp/skills/', 'SKILL.md'],
|
||||
['Clawdbot', '.clawdbot/skills/', 'SKILL.md'],
|
||||
['Cline', '.cline/skills/', 'SKILL.md'],
|
||||
['CodeBuddy', '.codebuddy/skills/', 'SKILL.md'],
|
||||
['CommandCode', '.commandcode/skills/', 'SKILL.md'],
|
||||
['Continue', '.continue/skills/', 'SKILL.md'],
|
||||
['Crush', '.crush/skills/', 'SKILL.md'],
|
||||
['Droid', '.factory/skills/', 'SKILL.md'],
|
||||
['Factory', '.factory/skills/', 'SKILL.md'],
|
||||
['Goose', '.goose/skills/', 'SKILL.md'],
|
||||
['Kilo', '.kilocode/skills/', 'SKILL.md'],
|
||||
['Kiro CLI', '.kiro/skills/', 'SKILL.md'],
|
||||
['MCPJam', '.mcpjam/skills/', 'SKILL.md'],
|
||||
['Mux', '.mux/skills/', 'SKILL.md'],
|
||||
['Neovate', '.neovate/skills/', 'SKILL.md'],
|
||||
['OpenHands', '.openhands/skills/', 'SKILL.md'],
|
||||
['Pi', '.pi/skills/', 'SKILL.md'],
|
||||
['Qoder', '.qoder/skills/', 'SKILL.md'],
|
||||
['Qwen', '.qwen/skills/', 'SKILL.md'],
|
||||
['Roo', '.roo/skills/', 'SKILL.md'],
|
||||
['Trae', '.trae/skills/', 'SKILL.md'],
|
||||
['Vercel', '.vercel/skills/', 'SKILL.md'],
|
||||
['Zencoder', '.zencoder/skills/', 'SKILL.md'],
|
||||
['Universal', 'skills/', 'SKILL.md'],
|
||||
]}
|
||||
/>
|
||||
</div>
|
||||
),
|
||||
},
|
||||
{
|
||||
id: 'commands',
|
||||
title: 'CLI Commands',
|
||||
content: (
|
||||
<div className="space-y-4">
|
||||
<h3 className="text-lg font-semibold text-white">Skill Management</h3>
|
||||
<CodeBlock>{`skillkit install <source> # Install skills from source
|
||||
skillkit remove <skill> # Remove installed skill
|
||||
skillkit update [skill] # Update skills
|
||||
skillkit list # List installed skills
|
||||
skillkit sync # Sync skills across agents
|
||||
skillkit enable <skill> # Enable a skill
|
||||
skillkit disable <skill> # Disable a skill`}</CodeBlock>
|
||||
|
||||
<h3 className="text-lg font-semibold text-white mt-6">Discovery</h3>
|
||||
<CodeBlock>{`skillkit recommend # AI-powered skill recommendations
|
||||
skillkit marketplace # Browse marketplace skills
|
||||
skillkit find <query> # Search for skills
|
||||
skillkit search <term> # Search skill content`}</CodeBlock>
|
||||
|
||||
<h3 className="text-lg font-semibold text-white mt-6">Translation</h3>
|
||||
<CodeBlock>{`skillkit translate --from claude --to cursor <skill>
|
||||
skillkit agent translate <skill> --target cursor
|
||||
skillkit context sync # Sync context across agents`}</CodeBlock>
|
||||
|
||||
<h3 className="text-lg font-semibold text-white mt-6">Team Collaboration</h3>
|
||||
<CodeBlock>{`skillkit manifest init # Initialize .skills manifest
|
||||
skillkit manifest add <source> # Add source to manifest
|
||||
skillkit manifest install # Install from manifest
|
||||
skillkit publish # Publish skill to marketplace
|
||||
skillkit cicd init # Setup CI/CD integration`}</CodeBlock>
|
||||
|
||||
<h3 className="text-lg font-semibold text-white mt-6">Advanced</h3>
|
||||
<CodeBlock>{`skillkit ui # Launch Terminal UI
|
||||
skillkit workflow # Manage workflows
|
||||
skillkit memory compress # Compress memory
|
||||
skillkit memory export # Export memory
|
||||
skillkit test # Run skill tests
|
||||
skillkit validate # Validate skill format & quality`}</CodeBlock>
|
||||
</div>
|
||||
),
|
||||
},
|
||||
{
|
||||
id: 'configuration',
|
||||
title: 'Configuration',
|
||||
content: (
|
||||
<div className="space-y-4">
|
||||
<h3 className="text-lg font-semibold text-white">Project Configuration (skillkit.yaml)</h3>
|
||||
<CodeBlock language="yaml">{`version: 1
|
||||
agent: cursor
|
||||
autoSync: true
|
||||
enabledSkills:
|
||||
- pdf
|
||||
- xlsx
|
||||
disabledSkills:
|
||||
- deprecated-skill`}</CodeBlock>
|
||||
|
||||
<h3 className="text-lg font-semibold text-white mt-6">Team Manifest (.skills)</h3>
|
||||
<CodeBlock>{`# Team-wide skill sources
|
||||
anthropics/skills
|
||||
vercel-labs/agent-skills
|
||||
./local-skills
|
||||
owner/repo@v1.2.3`}</CodeBlock>
|
||||
|
||||
<h3 className="text-lg font-semibold text-white mt-6">User Preferences (~/.skillkit/preferences.json)</h3>
|
||||
<CodeBlock language="json">{`{
|
||||
"lastSelectedAgents": ["claude", "cursor"],
|
||||
"autoSync": true,
|
||||
"marketplace": {
|
||||
"lastRefresh": "2024-01-01T00:00:00Z"
|
||||
}
|
||||
}`}</CodeBlock>
|
||||
|
||||
<h3 className="text-lg font-semibold text-white mt-6">File System Layout</h3>
|
||||
<CodeBlock language="text">{`project/
|
||||
├── .skillkit/ # Project config & memory
|
||||
├── .claude/skills/ # Claude Code skills
|
||||
├── .cursor/skills/ # Cursor AI skills
|
||||
├── .github/skills/ # GitHub Copilot skills
|
||||
├── skills/ # Universal format
|
||||
└── .skills # Team manifest file
|
||||
|
||||
~/.skillkit/ # Global user config
|
||||
├── preferences.json
|
||||
├── memory/
|
||||
└── cache/`}</CodeBlock>
|
||||
</div>
|
||||
),
|
||||
},
|
||||
{
|
||||
id: 'api',
|
||||
title: 'API Reference',
|
||||
content: (
|
||||
<div className="space-y-4">
|
||||
<h3 className="text-lg font-semibold text-white">Package Exports</h3>
|
||||
<p className="text-zinc-300">@skillkit/core provides multiple entry points for programmatic use:</p>
|
||||
|
||||
<CodeBlock language="typescript">{`import { findAllSkills, findSkill } from '@skillkit/core/discovery';
|
||||
import { parseSkillFile } from '@skillkit/core/parser';
|
||||
import { translateSkill } from '@skillkit/core/translator';
|
||||
import { syncContext } from '@skillkit/core/context';
|
||||
import { getRecommendations } from '@skillkit/core/recommend';
|
||||
import { evaluateSkillContent, getQualityGrade } from '@skillkit/core/quality';`}</CodeBlock>
|
||||
|
||||
<h3 className="text-lg font-semibold text-white mt-6">Core Functions</h3>
|
||||
<CodeBlock language="typescript">{`// Discovery
|
||||
findAllSkills(searchDirs: string[]): SkillInfo[]
|
||||
findSkill(name: string, searchDirs: string[]): SkillInfo | null
|
||||
|
||||
// Parsing
|
||||
parseSkillFile(filePath: string): ParsedSkill
|
||||
parseSkillContent(content: string): ParsedSkill
|
||||
|
||||
// Translation
|
||||
translateSkill(skill: ParsedSkill, targetAgent: AgentType): string
|
||||
getAgentAdapter(agent: AgentType): AgentAdapter
|
||||
|
||||
// Quality Evaluation
|
||||
evaluateSkillContent(content: string): QualityScore
|
||||
evaluateSkillFile(filePath: string): QualityScore
|
||||
getQualityGrade(score: number): 'A' | 'B' | 'C' | 'D' | 'F'
|
||||
isHighQuality(score: QualityScore): boolean
|
||||
|
||||
// Recommendations
|
||||
getRecommendations(context: ProjectContext): Recommendation[]`}</CodeBlock>
|
||||
|
||||
<h3 className="text-lg font-semibold text-white mt-6">Type Definitions</h3>
|
||||
<CodeBlock language="typescript">{`interface SkillInfo {
|
||||
name: string;
|
||||
path: string;
|
||||
agent: AgentType;
|
||||
enabled: boolean;
|
||||
}
|
||||
|
||||
interface ParsedSkill {
|
||||
name: string;
|
||||
description?: string;
|
||||
globs?: string[];
|
||||
triggers?: string[];
|
||||
content: string;
|
||||
frontmatter: Record<string, unknown>;
|
||||
}
|
||||
|
||||
interface QualityScore {
|
||||
overall: number;
|
||||
structure: StructureScore;
|
||||
clarity: ClarityScore;
|
||||
specificity: SpecificityScore;
|
||||
advanced: AdvancedScore;
|
||||
warnings: string[];
|
||||
suggestions: string[];
|
||||
}
|
||||
|
||||
type AgentType =
|
||||
| 'claude-code' | 'cursor' | 'codex' | 'gemini-cli'
|
||||
| 'opencode' | 'antigravity' | 'amp' | 'clawdbot'
|
||||
| 'droid' | 'github-copilot' | 'goose' | 'kilo'
|
||||
| 'kiro-cli' | 'roo' | 'trae' | 'windsurf' | 'universal';`}</CodeBlock>
|
||||
</div>
|
||||
),
|
||||
},
|
||||
{
|
||||
id: 'skill-format',
|
||||
title: 'Skill Format',
|
||||
content: (
|
||||
<div className="space-y-4">
|
||||
<h3 className="text-lg font-semibold text-white">SKILL.md Structure</h3>
|
||||
<p className="text-zinc-300">Skills use YAML frontmatter followed by markdown content:</p>
|
||||
|
||||
<CodeBlock language="markdown">{`---
|
||||
name: my-skill
|
||||
description: A helpful skill for coding tasks
|
||||
globs:
|
||||
- "**/*.ts"
|
||||
- "**/*.tsx"
|
||||
triggers:
|
||||
- "when working with TypeScript"
|
||||
- "when creating React components"
|
||||
---
|
||||
|
||||
# My Skill
|
||||
|
||||
## When to Use
|
||||
|
||||
Use this skill when:
|
||||
- Working with TypeScript files
|
||||
- Creating React components
|
||||
|
||||
## Instructions
|
||||
|
||||
Follow these guidelines:
|
||||
|
||||
1. Always use TypeScript strict mode
|
||||
2. Prefer functional components
|
||||
|
||||
\`\`\`typescript
|
||||
function Example(): JSX.Element {
|
||||
return <div>Hello</div>;
|
||||
}
|
||||
\`\`\`
|
||||
|
||||
## Boundaries
|
||||
|
||||
This skill should NOT:
|
||||
- Modify configuration files without asking
|
||||
- Delete existing code without confirmation`}</CodeBlock>
|
||||
|
||||
<h3 className="text-lg font-semibold text-white mt-6">Quality Scoring</h3>
|
||||
<p className="text-zinc-300">Skills are evaluated on four dimensions:</p>
|
||||
<Table
|
||||
headers={['Dimension', 'Weight', 'Criteria']}
|
||||
rows={[
|
||||
['Structure', '35%', 'Metadata, description, triggers, examples, boundaries'],
|
||||
['Clarity', '25%', 'Line count, token count, headers, readability'],
|
||||
['Specificity', '25%', 'Concrete commands, file patterns, code examples'],
|
||||
['Advanced', '15%', 'No deprecated patterns, security issues, completeness'],
|
||||
]}
|
||||
/>
|
||||
|
||||
<h3 className="text-lg font-semibold text-white mt-6">Grade Scale</h3>
|
||||
<Table
|
||||
headers={['Grade', 'Score Range', 'Description']}
|
||||
rows={[
|
||||
['A', '90-100', 'Excellent - Production ready'],
|
||||
['B', '80-89', 'Good - Minor improvements possible'],
|
||||
['C', '70-79', 'Acceptable - Some issues to address'],
|
||||
['D', '60-69', 'Poor - Significant improvements needed'],
|
||||
['F', '0-59', 'Failing - Major revision required'],
|
||||
]}
|
||||
/>
|
||||
</div>
|
||||
),
|
||||
},
|
||||
{
|
||||
id: 'tech-stack',
|
||||
title: 'Technology Stack',
|
||||
content: (
|
||||
<div className="space-y-4">
|
||||
<Table
|
||||
headers={['Layer', 'Technology']}
|
||||
rows={[
|
||||
['CLI Framework', 'Clipanion v4'],
|
||||
['TUI Framework', '@opentui/react v0.1.75'],
|
||||
['Validation', 'Zod v3.24'],
|
||||
['YAML Parsing', 'yaml v2.6'],
|
||||
['Git Operations', 'isomorphic-git v1.27'],
|
||||
['HTTP Client', 'got v14.4'],
|
||||
['Build System', 'Turbo v2.3, tsup v8.3, pnpm v9.0'],
|
||||
['Testing', 'Vitest v2.1'],
|
||||
['Runtime', 'Node.js 18+, Bun 1.2+ (for TUI)'],
|
||||
]}
|
||||
/>
|
||||
|
||||
<h3 className="text-lg font-semibold text-white mt-6">Build Commands</h3>
|
||||
<CodeBlock>{`pnpm build # Build all packages via Turbo
|
||||
pnpm dev # Watch mode development
|
||||
pnpm test # Unit tests via Vitest
|
||||
pnpm test:e2e # End-to-end tests
|
||||
pnpm typecheck # Type checking
|
||||
pnpm clean # Remove build artifacts`}</CodeBlock>
|
||||
</div>
|
||||
),
|
||||
},
|
||||
];
|
||||
|
||||
export function Documentation(): React.ReactElement {
|
||||
const [activeSection, setActiveSection] = useState('overview');
|
||||
|
||||
const currentSection = sections.find(s => s.id === activeSection) || sections[0];
|
||||
|
||||
return (
|
||||
<div className="mx-auto max-w-5xl px-4 sm:px-6 lg:px-8">
|
||||
<div className="text-center mb-8">
|
||||
<h2 className="text-2xl font-bold text-white mb-2 font-mono">Documentation</h2>
|
||||
<p className="text-zinc-400 font-mono text-sm">
|
||||
Complete guide to using SkillKit
|
||||
</p>
|
||||
<a
|
||||
href="https://deepwiki.com/rohitg00/skillkit"
|
||||
target="_blank"
|
||||
rel="noreferrer noopener"
|
||||
className="inline-flex items-center gap-2 mt-2 text-xs text-zinc-500 hover:text-zinc-300 transition-colors"
|
||||
>
|
||||
<span>Powered by DeepWiki</span>
|
||||
<svg className="w-3 h-3" fill="none" stroke="currentColor" viewBox="0 0 24 24">
|
||||
<path strokeLinecap="round" strokeLinejoin="round" strokeWidth={2} d="M10 6H6a2 2 0 00-2 2v10a2 2 0 002 2h10a2 2 0 002-2v-4M14 4h6m0 0v6m0-6L10 14" />
|
||||
</svg>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div className="flex flex-col lg:flex-row gap-8">
|
||||
<nav className="lg:w-48 flex-shrink-0" aria-label="Documentation sections">
|
||||
<div className="sticky top-20 space-y-1">
|
||||
{sections.map(section => (
|
||||
<button
|
||||
key={section.id}
|
||||
type="button"
|
||||
aria-current={activeSection === section.id ? 'page' : undefined}
|
||||
onClick={() => setActiveSection(section.id)}
|
||||
className={`w-full text-left px-3 py-2 text-sm font-mono rounded transition-colors ${
|
||||
activeSection === section.id
|
||||
? 'bg-white text-black'
|
||||
: 'text-zinc-400 hover:text-white hover:bg-zinc-800'
|
||||
}`}
|
||||
>
|
||||
{section.title}
|
||||
</button>
|
||||
))}
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<div className="flex-1 min-w-0">
|
||||
<div className="bg-surface border border-zinc-800 rounded-lg p-6">
|
||||
<h2 className="text-xl font-bold text-white mb-6 font-mono">{currentSection.title}</h2>
|
||||
<div className="prose prose-invert prose-zinc max-w-none">
|
||||
{currentSection.content}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,145 @@
|
||||
import React from 'react';
|
||||
|
||||
interface Feature {
|
||||
title: string;
|
||||
description: string;
|
||||
icon: React.ReactNode;
|
||||
}
|
||||
|
||||
const FEATURES: Feature[] = [
|
||||
{
|
||||
title: 'Multi-Agent',
|
||||
description: 'Deploy to 32 AI coding agents with one command.',
|
||||
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="M19 11H5m14 0a2 2 0 012 2v6a2 2 0 01-2 2H5a2 2 0 01-2-2v-6a2 2 0 012-2m14 0V9a2 2 0 00-2-2M5 11V9a2 2 0 012-2m0 0V5a2 2 0 012-2h6a2 2 0 012 2v2M7 7h10" />
|
||||
</svg>
|
||||
)
|
||||
},
|
||||
{
|
||||
title: 'Terminal UI',
|
||||
description: 'Beautiful interactive TUI for browsing & installing.',
|
||||
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 9l3 3-3 3m5 0h3M5 20h14a2 2 0 002-2V6a2 2 0 00-2-2H5a2 2 0 00-2 2v12a2 2 0 002 2z" />
|
||||
</svg>
|
||||
)
|
||||
},
|
||||
{
|
||||
title: 'Plugins',
|
||||
description: 'Extend with custom plugins & hooks.',
|
||||
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="M17 14v6m-3-3h6M6 10h2a2 2 0 002-2V6a2 2 0 00-2-2H6a2 2 0 00-2 2v2a2 2 0 002 2zm10 0h2a2 2 0 002-2V6a2 2 0 00-2-2h-2a2 2 0 00-2 2v2a2 2 0 002 2zM6 20h2a2 2 0 002-2v-2a2 2 0 00-2-2H6a2 2 0 00-2 2v2a2 2 0 002 2z" />
|
||||
</svg>
|
||||
)
|
||||
},
|
||||
{
|
||||
title: 'Manifest',
|
||||
description: '.skills file for team-wide consistency.',
|
||||
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 12h6m-6 4h6m2 5H7a2 2 0 01-2-2V5a2 2 0 012-2h5.586a1 1 0 01.707.293l5.414 5.414a1 1 0 01.293.707V19a2 2 0 01-2 2z" />
|
||||
</svg>
|
||||
)
|
||||
},
|
||||
{
|
||||
title: 'CI/CD',
|
||||
description: 'GitHub, GitLab, CircleCI templates included.',
|
||||
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="M4 4v5h.582m15.356 2A8.001 8.001 0 004.582 9m0 0H9m11 11v-5h-.581m0 0a8.003 8.003 0 01-15.357-2m15.357 2H15" />
|
||||
</svg>
|
||||
)
|
||||
},
|
||||
{
|
||||
title: 'Slash Commands',
|
||||
description: 'Generate /commands for Claude, Cursor & more.',
|
||||
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="M7 20l4-16m2 16l4-16M6 9h14M4 15h14" />
|
||||
</svg>
|
||||
)
|
||||
}
|
||||
];
|
||||
|
||||
const COMPARISONS = [
|
||||
['Agents', '1', '32'],
|
||||
['Translation', 'Manual', 'Auto'],
|
||||
['Sharing', 'Copy/paste', '.skills manifest'],
|
||||
['Discovery', 'Forums', 'CLI + AI'],
|
||||
['CI/CD', 'Custom', 'Templates'],
|
||||
] as const;
|
||||
|
||||
export function Features(): React.ReactElement {
|
||||
return (
|
||||
<section id="features" className="py-12 border-b border-zinc-800 bg-surface">
|
||||
<div className="mx-auto max-w-5xl px-4 sm:px-6 lg:px-8">
|
||||
<div className="grid grid-cols-1 lg:grid-cols-5 gap-6 lg:gap-8 mb-10">
|
||||
<div className="lg:col-span-2">
|
||||
<h2 className="text-xl font-bold text-white mb-2 font-mono">Why SkillKit?</h2>
|
||||
<p className="text-zinc-500 font-mono text-sm mb-6">
|
||||
Universal bridge for AI coding agents.
|
||||
</p>
|
||||
<div className="flex gap-6 sm:gap-8">
|
||||
<div>
|
||||
<div className="text-2xl sm:text-3xl font-bold text-white font-mono">32</div>
|
||||
<div className="text-zinc-600 text-[10px] sm:text-xs font-mono">Agents</div>
|
||||
</div>
|
||||
<div>
|
||||
<div className="text-2xl sm:text-3xl font-bold text-white font-mono">40+</div>
|
||||
<div className="text-zinc-600 text-[10px] sm:text-xs font-mono">Commands</div>
|
||||
</div>
|
||||
<div>
|
||||
<div className="text-2xl sm:text-3xl font-bold text-white font-mono">15K</div>
|
||||
<div className="text-zinc-600 text-[10px] sm:text-xs font-mono">Skills</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div className="lg:col-span-3 border border-zinc-800 bg-black/50 p-4 font-mono text-xs backdrop-blur-sm">
|
||||
<div className="grid grid-cols-3 gap-2 border-b border-zinc-800 pb-2 mb-3 text-zinc-500 uppercase tracking-wider text-[10px]">
|
||||
<div>Feature</div>
|
||||
<div className="text-center">Without</div>
|
||||
<div className="text-right">SkillKit</div>
|
||||
</div>
|
||||
<div className="space-y-1">
|
||||
{COMPARISONS.map(([feature, without, withSkillKit], index) => (
|
||||
<div
|
||||
key={feature}
|
||||
className="grid grid-cols-3 gap-2 items-center py-1.5 hover:bg-zinc-900/50 transition-colors -mx-2 px-2 rounded"
|
||||
style={{ animationDelay: `${index * 100}ms` }}
|
||||
>
|
||||
<div className="text-zinc-300">{feature}</div>
|
||||
<div className="text-center text-zinc-600">{without}</div>
|
||||
<div className="text-right text-white font-medium">{withSkillKit}</div>
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div className="grid grid-cols-1 xs:grid-cols-2 md:grid-cols-3 lg:grid-cols-6 gap-3">
|
||||
{FEATURES.map((feature, index) => (
|
||||
<div
|
||||
key={feature.title}
|
||||
className="group relative p-4 border border-zinc-800 bg-zinc-900/30 hover:bg-zinc-900/80 hover:border-zinc-700 transition-all duration-300 cursor-default"
|
||||
style={{ animationDelay: `${index * 50}ms` }}
|
||||
>
|
||||
<div className="absolute inset-0 bg-gradient-to-b from-zinc-800/0 to-zinc-800/20 opacity-0 group-hover:opacity-100 transition-opacity"></div>
|
||||
<div className="relative">
|
||||
<div className="text-zinc-500 group-hover:text-white transition-colors mb-2">
|
||||
{feature.icon}
|
||||
</div>
|
||||
<h4 className="text-xs font-bold text-white mb-1 font-mono">{feature.title}</h4>
|
||||
<p className="text-zinc-600 text-[10px] leading-relaxed font-mono group-hover:text-zinc-400 transition-colors">
|
||||
{feature.description}
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,41 @@
|
||||
import React from 'react';
|
||||
|
||||
const GITHUB_ICON = (
|
||||
<svg className="w-5 h-5" 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>
|
||||
);
|
||||
|
||||
export function Footer(): React.ReactElement {
|
||||
const currentYear = new Date().getFullYear();
|
||||
|
||||
return (
|
||||
<footer className="border-t border-border py-6 bg-black">
|
||||
<div className="mx-auto max-w-5xl px-4 sm:px-6 lg:px-8 flex flex-col sm:flex-row justify-between items-center gap-3">
|
||||
<div className="flex flex-col sm:flex-row items-center gap-2 sm:gap-4 text-center sm:text-left">
|
||||
<p className="text-zinc-500 text-xs font-mono">
|
||||
© {currentYear} SKILLKIT
|
||||
</p>
|
||||
<span className="hidden sm:inline text-zinc-700">•</span>
|
||||
<a
|
||||
href="https://agenstskills.com"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
className="text-zinc-600 hover:text-zinc-400 text-xs font-mono transition-colors"
|
||||
>
|
||||
Agent Skills standard
|
||||
</a>
|
||||
</div>
|
||||
<a
|
||||
href="https://github.com/rohitg00/skillkit"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
aria-label="SkillKit on GitHub"
|
||||
className="text-zinc-500 hover:text-white transition-colors"
|
||||
>
|
||||
{GITHUB_ICON}
|
||||
</a>
|
||||
</div>
|
||||
</footer>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,212 @@
|
||||
import React, { useState, useEffect } from 'react';
|
||||
import { Button } from './Button';
|
||||
|
||||
const ASCII_LOGO = `
|
||||
____ _ __ _ _ _ _ __ _ _____
|
||||
/ ___|| |/ /| || | | | | |/ /| ||_ _|
|
||||
\\___ \\| ' / | || | | | | ' / | | | |
|
||||
___) | . \\ | || |___ | |___ | . \\ | | | |
|
||||
|____/|_|\\_\\|_||_____||_____||_|\\_\\|_| |_|
|
||||
`.trim();
|
||||
|
||||
interface TerminalLine {
|
||||
type: 'cmd' | 'out';
|
||||
text: string;
|
||||
}
|
||||
|
||||
const TERMINAL_LINES: TerminalLine[] = [
|
||||
{ type: 'cmd', text: 'skillkit find react' },
|
||||
{ type: 'out', text: ' ■ react-patterns ★★★★★' },
|
||||
{ type: 'out', text: ' ■ react-testing ★★★★☆' },
|
||||
{ type: 'cmd', text: 'skillkit install anthropics/skills' },
|
||||
{ type: 'out', text: '→ 3 skills → 5 agents' },
|
||||
{ type: 'cmd', text: 'skillkit ui' },
|
||||
{ type: 'out', text: '→ Launching TUI...' },
|
||||
{ type: 'cmd', text: 'skillkit check' },
|
||||
{ type: 'out', text: ' ✓ All skills up to date' },
|
||||
{ type: 'cmd', text: 'skillkit manifest install' },
|
||||
{ type: 'out', text: '→ 12 skills from .skills' },
|
||||
];
|
||||
|
||||
const FADE_ANIMATION_STYLES = `
|
||||
@keyframes fade-in {
|
||||
from { opacity: 0; transform: translateY(10px); }
|
||||
to { opacity: 1; transform: translateY(0); }
|
||||
}
|
||||
.animate-fade-in {
|
||||
animation: fade-in 0.6s ease-out forwards;
|
||||
}
|
||||
.animate-fade-in-delay {
|
||||
animation: fade-in 0.6s ease-out 0.2s forwards;
|
||||
opacity: 0;
|
||||
}
|
||||
`;
|
||||
|
||||
const CHECK_ICON = (
|
||||
<svg className="w-4 h-4 text-white" fill="none" viewBox="0 0 24 24" stroke="currentColor">
|
||||
<path strokeLinecap="round" strokeLinejoin="round" strokeWidth={2} d="M5 13l4 4L19 7" />
|
||||
</svg>
|
||||
);
|
||||
|
||||
const COPY_ICON = (
|
||||
<svg className="w-4 h-4" fill="none" viewBox="0 0 24 24" stroke="currentColor">
|
||||
<path strokeLinecap="round" strokeLinejoin="round" strokeWidth={2} d="M8 5H6a2 2 0 00-2 2v12a2 2 0 002 2h10a2 2 0 002-2v-1M8 5a2 2 0 002 2h2a2 2 0 002-2M8 5a2 2 0 012-2h2a2 2 0 012 2m-6 9l2 2 4-4" />
|
||||
</svg>
|
||||
);
|
||||
|
||||
export function Hero(): React.ReactElement {
|
||||
const [copied, setCopied] = useState(false);
|
||||
const [visibleLines, setVisibleLines] = useState(0);
|
||||
const [typingIndex, setTypingIndex] = useState(0);
|
||||
const [currentText, setCurrentText] = useState('');
|
||||
|
||||
useEffect(() => {
|
||||
if (visibleLines >= TERMINAL_LINES.length) {
|
||||
const resetTimer = setTimeout(() => {
|
||||
setVisibleLines(0);
|
||||
setTypingIndex(0);
|
||||
setCurrentText('');
|
||||
}, 3000);
|
||||
return () => clearTimeout(resetTimer);
|
||||
}
|
||||
|
||||
const line = TERMINAL_LINES[visibleLines];
|
||||
if (line.type === 'cmd') {
|
||||
if (typingIndex < line.text.length) {
|
||||
const timer = setTimeout(() => {
|
||||
setCurrentText(line.text.slice(0, typingIndex + 1));
|
||||
setTypingIndex(typingIndex + 1);
|
||||
}, 40);
|
||||
return () => clearTimeout(timer);
|
||||
}
|
||||
const timer = setTimeout(() => {
|
||||
setVisibleLines(visibleLines + 1);
|
||||
setTypingIndex(0);
|
||||
setCurrentText('');
|
||||
}, 200);
|
||||
return () => clearTimeout(timer);
|
||||
}
|
||||
|
||||
const timer = setTimeout(() => {
|
||||
setVisibleLines(visibleLines + 1);
|
||||
}, 150);
|
||||
return () => clearTimeout(timer);
|
||||
}, [visibleLines, typingIndex]);
|
||||
|
||||
async function copyInstall(): Promise<void> {
|
||||
try {
|
||||
await navigator.clipboard.writeText('npx skillkit@latest');
|
||||
setCopied(true);
|
||||
setTimeout(() => setCopied(false), 2000);
|
||||
} catch {
|
||||
// Clipboard API failed, silently ignore
|
||||
}
|
||||
}
|
||||
|
||||
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;
|
||||
|
||||
return (
|
||||
<div className="relative border-b border-zinc-800 overflow-hidden">
|
||||
<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-500 text-[11px] leading-tight font-mono select-none whitespace-pre">
|
||||
{ASCII_LOGO}
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div className="grid grid-cols-1 lg:grid-cols-2 gap-6 lg:gap-8 items-start">
|
||||
<div className="animate-fade-in">
|
||||
<div className="inline-flex items-center space-x-2 border border-zinc-800 bg-zinc-900/50 px-2 py-0.5 mb-3 backdrop-blur-sm">
|
||||
<span className="flex h-1.5 w-1.5 bg-white rounded-full"></span>
|
||||
<span className="text-xs font-mono text-zinc-400">v1.7.5</span>
|
||||
</div>
|
||||
|
||||
<h1 className="text-2xl sm:text-3xl lg:text-4xl font-bold tracking-tight text-white mb-3 font-mono">
|
||||
Universal Skills for<br />
|
||||
<span className="text-zinc-500">AI Coding Agents</span>
|
||||
</h1>
|
||||
|
||||
<p className="text-sm text-zinc-400 mb-5 max-w-lg font-mono leading-relaxed">
|
||||
One CLI to install, sync, and manage skills across Claude Code, Cursor,
|
||||
Windsurf, Copilot, and 28 more agents. 15,000+ skills ready to use.
|
||||
</p>
|
||||
|
||||
<div className="flex flex-wrap items-center gap-3 mb-4">
|
||||
<button
|
||||
onClick={copyInstall}
|
||||
className="inline-flex items-center bg-black border border-zinc-700 px-3 py-2 hover:border-zinc-500 transition-colors"
|
||||
>
|
||||
<span className="text-zinc-500 mr-2 select-none">$</span>
|
||||
<span className="font-mono text-zinc-100 text-sm">npx skillkit@latest</span>
|
||||
<span className="ml-2 text-zinc-500 hover:text-white transition-colors flex items-center gap-1">
|
||||
{copied ? (
|
||||
<>
|
||||
{CHECK_ICON}
|
||||
<span className="text-xs text-green-400">Copied!</span>
|
||||
</>
|
||||
) : (
|
||||
COPY_ICON
|
||||
)}
|
||||
</span>
|
||||
</button>
|
||||
<Button variant="outline" onClick={openGitHub}>
|
||||
GITHUB
|
||||
</Button>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div className="hidden lg:block relative animate-fade-in-delay w-full">
|
||||
<div className="absolute -inset-1 bg-gradient-to-r from-zinc-800 via-zinc-700 to-zinc-800 rounded-lg opacity-20 blur-lg"></div>
|
||||
<div className="relative border border-zinc-800 bg-black rounded-lg overflow-hidden">
|
||||
<div className="flex items-center gap-1.5 px-3 py-2 border-b border-zinc-800 bg-zinc-900/50">
|
||||
<div className="w-2.5 h-2.5 rounded-full bg-zinc-700"></div>
|
||||
<div className="w-2.5 h-2.5 rounded-full bg-zinc-700"></div>
|
||||
<div className="w-2.5 h-2.5 rounded-full bg-zinc-700"></div>
|
||||
<span className="ml-2 text-zinc-500 text-xs font-mono">skillkit</span>
|
||||
</div>
|
||||
<div className="p-4 font-mono text-xs min-h-[200px] max-h-[280px]">
|
||||
{TERMINAL_LINES.slice(0, visibleLines).map((line, index) => (
|
||||
<div key={index} className="mb-1">
|
||||
{line.type === 'cmd' ? (
|
||||
<div className="flex items-center">
|
||||
<span className="text-zinc-600 mr-2">$</span>
|
||||
<span className="text-zinc-100">{line.text}</span>
|
||||
</div>
|
||||
) : (
|
||||
<div className="pl-4 text-zinc-500">
|
||||
<span className="text-zinc-400">{line.text.slice(0, 1)}</span>
|
||||
{line.text.slice(1)}
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
))}
|
||||
{isTyping && (
|
||||
<div className="flex items-center">
|
||||
<span className="text-zinc-600 mr-2">$</span>
|
||||
<span className="text-zinc-100">{currentText}</span>
|
||||
<span className="w-2 h-4 bg-zinc-400 ml-0.5 animate-pulse"></span>
|
||||
</div>
|
||||
)}
|
||||
{isComplete && (
|
||||
<div className="flex items-center mt-1">
|
||||
<span className="text-zinc-600 mr-2">$</span>
|
||||
<span className="w-2 h-4 bg-zinc-600 animate-pulse"></span>
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<style>{FADE_ANIMATION_STYLES}</style>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,687 @@
|
||||
'use client';
|
||||
|
||||
import React, { useState, useRef, useEffect } from 'react';
|
||||
import { Button } from './Button';
|
||||
import { Card } from './Card';
|
||||
import { generateAgentSkill } from '../services/geminiService';
|
||||
import { searchSkills, IndexedSkill } from '../data/skills-index';
|
||||
import { AgentSkill, LoadingState } from '../types';
|
||||
|
||||
interface PriorityBadgeProps {
|
||||
priority: string;
|
||||
}
|
||||
|
||||
type ViewMode = 'search' | 'marketplace' | 'generated' | 'content';
|
||||
|
||||
const PRIORITY_COLORS = {
|
||||
must: 'bg-red-900/50 text-red-300 border-red-800',
|
||||
should: 'bg-yellow-900/50 text-yellow-300 border-yellow-800',
|
||||
may: 'bg-blue-900/50 text-blue-300 border-blue-800',
|
||||
} as const;
|
||||
|
||||
function escapeYamlString(str: string): string {
|
||||
if (!str) return '';
|
||||
return str
|
||||
.replace(/\\/g, '\\\\')
|
||||
.replace(/"/g, '\\"')
|
||||
.replace(/\n/g, '\\n')
|
||||
.replace(/\r/g, '\\r')
|
||||
.replace(/\t/g, '\\t');
|
||||
}
|
||||
|
||||
function PriorityBadge({ priority }: PriorityBadgeProps): React.ReactElement {
|
||||
const colorClass = PRIORITY_COLORS[priority as keyof typeof PRIORITY_COLORS] || PRIORITY_COLORS.may;
|
||||
return (
|
||||
<span className={`text-xs px-2 py-0.5 border font-mono uppercase ${colorClass}`}>
|
||||
{priority}
|
||||
</span>
|
||||
);
|
||||
}
|
||||
|
||||
function generateSkillMd(skill: AgentSkill): string {
|
||||
const escapedTags = skill.tags.length > 0
|
||||
? skill.tags.map(t => `"${escapeYamlString(t)}"`).join(', ')
|
||||
: '';
|
||||
const escapedGlobs = skill.filePatterns?.length
|
||||
? skill.filePatterns.map(p => `"${escapeYamlString(p)}"`).join(', ')
|
||||
: '';
|
||||
|
||||
const frontmatter = `---
|
||||
name: "${escapeYamlString(skill.name)}"
|
||||
description: "${escapeYamlString(skill.description)}"
|
||||
version: "${escapeYamlString(skill.version)}"
|
||||
tags: [${escapedTags}]
|
||||
${escapedGlobs ? `globs: [${escapedGlobs}]` : ''}
|
||||
---`;
|
||||
|
||||
const principlesSection = skill.principles.map(p =>
|
||||
`### ${p.priority.toUpperCase()}: ${p.title}\n\n${p.description}`
|
||||
).join('\n\n');
|
||||
|
||||
const patternsSection = skill.patterns.map(p =>
|
||||
`### ${p.name}\n\n${p.description}\n\n\`\`\`${p.language || 'typescript'}\n${p.example}\n\`\`\``
|
||||
).join('\n\n');
|
||||
|
||||
const antiPatternsSection = skill.antiPatterns.map(ap => {
|
||||
let content = `### ${ap.name}\n\n${ap.description}`;
|
||||
if (ap.badExample) {
|
||||
content += `\n\n**Bad:**\n\`\`\`typescript\n${ap.badExample}\n\`\`\``;
|
||||
}
|
||||
if (ap.goodExample) {
|
||||
content += `\n\n**Good:**\n\`\`\`typescript\n${ap.goodExample}\n\`\`\``;
|
||||
}
|
||||
return content;
|
||||
}).join('\n\n');
|
||||
|
||||
const content = `# ${skill.title}
|
||||
|
||||
${skill.description}
|
||||
|
||||
## When to Apply
|
||||
|
||||
${skill.applicability}
|
||||
|
||||
${skill.filePatterns?.length ? `**File patterns:** ${skill.filePatterns.map(p => `\`${p}\``).join(', ')}` : ''}
|
||||
|
||||
## Principles
|
||||
|
||||
${principlesSection}
|
||||
|
||||
## Patterns
|
||||
|
||||
${patternsSection}
|
||||
|
||||
## Anti-Patterns
|
||||
|
||||
${antiPatternsSection}
|
||||
|
||||
${skill.references?.length ? `## References\n\n${skill.references.map(r => `- ${r}`).join('\n')}` : ''}
|
||||
`;
|
||||
|
||||
return `${frontmatter}\n\n${content}`;
|
||||
}
|
||||
|
||||
function downloadContent(content: string, filename: string): void {
|
||||
const blob = new Blob([content], { type: 'text/markdown' });
|
||||
const url = URL.createObjectURL(blob);
|
||||
const a = document.createElement('a');
|
||||
a.href = url;
|
||||
a.download = filename;
|
||||
document.body.appendChild(a);
|
||||
a.click();
|
||||
document.body.removeChild(a);
|
||||
URL.revokeObjectURL(url);
|
||||
}
|
||||
|
||||
function isValidUrl(str: string): boolean {
|
||||
try {
|
||||
new URL(str);
|
||||
return true;
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
// localStorage cache for AI-generated skills
|
||||
const CACHE_KEY = 'skillkit_ai_cache';
|
||||
const CACHE_VERSION = 1;
|
||||
const MAX_CACHE_ENTRIES = 50;
|
||||
const CACHE_TTL_MS = 7 * 24 * 60 * 60 * 1000; // 7 days
|
||||
|
||||
interface CachedSkill {
|
||||
skill: AgentSkill;
|
||||
query: string;
|
||||
timestamp: number;
|
||||
}
|
||||
|
||||
interface SkillCache {
|
||||
version: number;
|
||||
skills: Record<string, CachedSkill>;
|
||||
}
|
||||
|
||||
function normalizeQuery(query: string): string {
|
||||
return query.toLowerCase().trim().replace(/\s+/g, ' ');
|
||||
}
|
||||
|
||||
function getSkillCache(): SkillCache {
|
||||
try {
|
||||
const cached = localStorage.getItem(CACHE_KEY);
|
||||
if (cached) {
|
||||
const parsed = JSON.parse(cached) as SkillCache;
|
||||
if (parsed.version === CACHE_VERSION) {
|
||||
// Prune expired entries
|
||||
const now = Date.now();
|
||||
let mutated = false;
|
||||
for (const [key, value] of Object.entries(parsed.skills)) {
|
||||
if (!value?.timestamp || now - value.timestamp >= CACHE_TTL_MS) {
|
||||
delete parsed.skills[key];
|
||||
mutated = true;
|
||||
}
|
||||
}
|
||||
if (mutated) {
|
||||
localStorage.setItem(CACHE_KEY, JSON.stringify(parsed));
|
||||
}
|
||||
return parsed;
|
||||
}
|
||||
}
|
||||
} catch {
|
||||
// Ignore parse errors
|
||||
}
|
||||
return { version: CACHE_VERSION, skills: {} };
|
||||
}
|
||||
|
||||
function getCachedSkill(query: string): AgentSkill | null {
|
||||
const cache = getSkillCache();
|
||||
const key = normalizeQuery(query);
|
||||
const cached = cache.skills[key];
|
||||
if (cached && Date.now() - cached.timestamp < CACHE_TTL_MS) {
|
||||
return cached.skill;
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
function setCachedSkill(query: string, skill: AgentSkill): void {
|
||||
try {
|
||||
const cache = getSkillCache();
|
||||
const key = normalizeQuery(query);
|
||||
cache.skills[key] = {
|
||||
skill,
|
||||
query: key,
|
||||
timestamp: Date.now(),
|
||||
};
|
||||
// Enforce max entries limit
|
||||
const entries = Object.entries(cache.skills);
|
||||
if (entries.length > MAX_CACHE_ENTRIES) {
|
||||
entries
|
||||
.sort((a, b) => a[1].timestamp - b[1].timestamp)
|
||||
.slice(0, entries.length - MAX_CACHE_ENTRIES)
|
||||
.forEach(([k]) => delete cache.skills[k]);
|
||||
}
|
||||
localStorage.setItem(CACHE_KEY, JSON.stringify(cache));
|
||||
} catch {
|
||||
// Ignore storage errors (quota exceeded, etc.)
|
||||
}
|
||||
}
|
||||
|
||||
export function SkillGenerator(): React.ReactElement {
|
||||
const [input, setInput] = useState('');
|
||||
const [status, setStatus] = useState<LoadingState>(LoadingState.IDLE);
|
||||
const [viewMode, setViewMode] = useState<ViewMode>('search');
|
||||
|
||||
const [marketplaceResults, setMarketplaceResults] = useState<IndexedSkill[]>([]);
|
||||
const [selectedSkill, setSelectedSkill] = useState<IndexedSkill | null>(null);
|
||||
const [skillContent, setSkillContent] = useState<string | null>(null);
|
||||
const [generatedSkill, setGeneratedSkill] = useState<AgentSkill | null>(null);
|
||||
const [isFromCache, setIsFromCache] = useState(false);
|
||||
const [activeTab, setActiveTab] = useState<'principles' | 'patterns' | 'antipatterns'>('principles');
|
||||
|
||||
const [error, setError] = useState<string | null>(null);
|
||||
const inputRef = useRef<HTMLInputElement>(null);
|
||||
|
||||
function handleSearch(e: React.FormEvent): void {
|
||||
e.preventDefault();
|
||||
if (!input.trim()) return;
|
||||
|
||||
setError(null);
|
||||
setSelectedSkill(null);
|
||||
setSkillContent(null);
|
||||
setGeneratedSkill(null);
|
||||
|
||||
const results = searchSkills(input);
|
||||
setMarketplaceResults(results);
|
||||
setViewMode(results.length > 0 ? 'marketplace' : 'search');
|
||||
setStatus(LoadingState.SUCCESS);
|
||||
}
|
||||
|
||||
async function handleViewSkill(skill: IndexedSkill): Promise<void> {
|
||||
setSelectedSkill(skill);
|
||||
setSkillContent(null);
|
||||
setViewMode('content');
|
||||
|
||||
if (skill.rawUrl) {
|
||||
setStatus(LoadingState.LOADING);
|
||||
try {
|
||||
const response = await fetch(skill.rawUrl);
|
||||
if (response.ok) {
|
||||
const content = await response.text();
|
||||
setSkillContent(content);
|
||||
}
|
||||
} catch {
|
||||
// Silently handle fetch errors
|
||||
}
|
||||
setStatus(LoadingState.SUCCESS);
|
||||
}
|
||||
}
|
||||
|
||||
async function handleGenerateWithAI(): Promise<void> {
|
||||
setError(null);
|
||||
|
||||
// Check cache first
|
||||
const cached = getCachedSkill(input);
|
||||
if (cached) {
|
||||
setGeneratedSkill(cached);
|
||||
setIsFromCache(true);
|
||||
setViewMode('generated');
|
||||
setStatus(LoadingState.SUCCESS);
|
||||
return;
|
||||
}
|
||||
|
||||
setStatus(LoadingState.LOADING);
|
||||
setIsFromCache(false);
|
||||
|
||||
try {
|
||||
const result = await generateAgentSkill(input);
|
||||
setGeneratedSkill(result);
|
||||
setCachedSkill(input, result); // Cache the result
|
||||
setViewMode('generated');
|
||||
setStatus(LoadingState.SUCCESS);
|
||||
} catch {
|
||||
setError("Failed to generate skill. Please try again.");
|
||||
setStatus(LoadingState.ERROR);
|
||||
}
|
||||
}
|
||||
|
||||
function submitToMarketplace(): void {
|
||||
if (!generatedSkill) return;
|
||||
|
||||
const slug = generatedSkill.name.toLowerCase().replace(/\s+/g, '-').replace(/[^a-z0-9-]/g, '');
|
||||
const skillContent = generateSkillMd(generatedSkill);
|
||||
|
||||
const body = `## 📤 AI-Generated Skill: ${generatedSkill.title}
|
||||
|
||||
### Skill Details
|
||||
- **Name:** ${generatedSkill.name}
|
||||
- **Description:** ${generatedSkill.description}
|
||||
- **Tags:** ${generatedSkill.tags.join(', ')}
|
||||
- **Version:** ${generatedSkill.version}
|
||||
|
||||
### SKILL.md Content
|
||||
|
||||
<details>
|
||||
<summary>Click to expand</summary>
|
||||
|
||||
\`\`\`markdown
|
||||
${skillContent.slice(0, 4000)}${skillContent.length > 4000 ? '\n...(truncated)' : ''}
|
||||
\`\`\`
|
||||
|
||||
</details>
|
||||
|
||||
### Checklist for Maintainer
|
||||
- [ ] Review skill content for quality
|
||||
- [ ] Add to \`marketplace/skills.json\`
|
||||
|
||||
---
|
||||
**Generated via:** AI Skill Generator
|
||||
**Search query:** "${input}"`;
|
||||
|
||||
const title = encodeURIComponent(`[AI Skill] ${generatedSkill.title}`);
|
||||
const encodedBody = encodeURIComponent(body);
|
||||
const url = `https://github.com/rohitg00/skillkit/issues/new?title=${title}&body=${encodedBody}&labels=ai-generated,skill-submission`;
|
||||
|
||||
window.open(url, '_blank', 'noopener,noreferrer');
|
||||
}
|
||||
|
||||
function handleBack(): void {
|
||||
switch (viewMode) {
|
||||
case 'content':
|
||||
setViewMode('marketplace');
|
||||
setSelectedSkill(null);
|
||||
setSkillContent(null);
|
||||
break;
|
||||
case 'generated':
|
||||
setViewMode(marketplaceResults.length > 0 ? 'marketplace' : 'search');
|
||||
setGeneratedSkill(null);
|
||||
break;
|
||||
default:
|
||||
setViewMode('search');
|
||||
setMarketplaceResults([]);
|
||||
}
|
||||
}
|
||||
|
||||
function downloadSkillMd(): void {
|
||||
if (skillContent) {
|
||||
downloadContent(skillContent, 'SKILL.md');
|
||||
}
|
||||
}
|
||||
|
||||
function downloadGeneratedSkillMd(): void {
|
||||
if (generatedSkill) {
|
||||
downloadContent(generateSkillMd(generatedSkill), 'SKILL.md');
|
||||
}
|
||||
}
|
||||
|
||||
// Focus input only after user interaction, not on initial page load
|
||||
useEffect(() => {
|
||||
if (status === LoadingState.SUCCESS && inputRef.current) {
|
||||
inputRef.current.focus({ preventScroll: true });
|
||||
}
|
||||
}, [status]);
|
||||
|
||||
return (
|
||||
<div className="mx-auto max-w-5xl px-4 sm:px-6 lg:px-8 py-8">
|
||||
<div className="mb-6">
|
||||
<h2 className="text-xl font-bold text-white mb-1 font-sans">Skill Finder</h2>
|
||||
<p className="text-zinc-400 font-mono text-xs">
|
||||
Search the marketplace or generate new skills with AI.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<form onSubmit={handleSearch} className="mb-6">
|
||||
<div className="flex flex-col sm:flex-row gap-3">
|
||||
<input
|
||||
ref={inputRef}
|
||||
type="text"
|
||||
value={input}
|
||||
onChange={(e) => setInput(e.target.value)}
|
||||
placeholder="e.g., React hooks, TypeScript, Next.js..."
|
||||
className="flex-1 bg-surface border border-zinc-700 text-white px-4 py-3 focus:ring-2 focus:ring-white focus:border-transparent outline-none font-mono text-sm placeholder-zinc-600"
|
||||
disabled={status === LoadingState.LOADING}
|
||||
/>
|
||||
<Button type="submit" isLoading={status === LoadingState.LOADING} className="sm:w-auto w-full">
|
||||
SEARCH
|
||||
</Button>
|
||||
</div>
|
||||
{error && <p className="mt-2 text-red-400 font-mono text-xs">{error}</p>}
|
||||
</form>
|
||||
|
||||
{viewMode !== 'search' && status !== LoadingState.LOADING && (
|
||||
<button
|
||||
onClick={handleBack}
|
||||
className="mb-6 text-zinc-400 hover:text-white font-mono text-sm flex items-center gap-2 transition-colors"
|
||||
>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" className="h-4 w-4" fill="none" viewBox="0 0 24 24" stroke="currentColor">
|
||||
<path strokeLinecap="round" strokeLinejoin="round" strokeWidth={2} d="M15 19l-7-7 7-7" />
|
||||
</svg>
|
||||
Back
|
||||
</button>
|
||||
)}
|
||||
|
||||
{viewMode === 'marketplace' && status === LoadingState.SUCCESS && (
|
||||
<div className="animate-fade-in-up">
|
||||
<div className="flex items-center justify-between mb-6">
|
||||
<h3 className="text-lg font-mono text-zinc-300">
|
||||
Found {marketplaceResults.length} skill{marketplaceResults.length !== 1 ? 's' : ''} in marketplace
|
||||
</h3>
|
||||
</div>
|
||||
|
||||
<div className="space-y-3 mb-8">
|
||||
{marketplaceResults.map((skill) => (
|
||||
<Card
|
||||
key={skill.id}
|
||||
className="hover:border-zinc-500 cursor-pointer transition-all"
|
||||
onClick={() => handleViewSkill(skill)}
|
||||
>
|
||||
<div className="flex items-start justify-between">
|
||||
<div className="flex-1">
|
||||
<h4 className="text-lg font-semibold text-white mb-1">{skill.name}</h4>
|
||||
<p className="text-zinc-400 text-sm mb-2">{skill.description || 'No description'}</p>
|
||||
<div className="flex items-center gap-2 text-xs text-zinc-500 font-mono">
|
||||
<span>{skill.source}</span>
|
||||
</div>
|
||||
</div>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" className="h-5 w-5 text-zinc-600" fill="none" viewBox="0 0 24 24" stroke="currentColor">
|
||||
<path strokeLinecap="round" strokeLinejoin="round" strokeWidth={2} d="M9 5l7 7-7 7" />
|
||||
</svg>
|
||||
</div>
|
||||
{skill.tags.length > 0 && (
|
||||
<div className="flex flex-wrap gap-1 mt-3">
|
||||
{skill.tags.slice(0, 5).map((tag, idx) => (
|
||||
<span key={idx} className="text-xs bg-zinc-900 text-zinc-500 px-2 py-0.5 border border-zinc-800">
|
||||
{tag}
|
||||
</span>
|
||||
))}
|
||||
</div>
|
||||
)}
|
||||
</Card>
|
||||
))}
|
||||
</div>
|
||||
|
||||
<div className="border-t border-zinc-800 pt-6">
|
||||
<p className="text-zinc-500 font-mono text-sm mb-4">
|
||||
Don't see what you need? Generate a custom skill with AI.
|
||||
</p>
|
||||
<Button onClick={handleGenerateWithAI}>
|
||||
GENERATE WITH AI
|
||||
</Button>
|
||||
</div>
|
||||
</div>
|
||||
)}
|
||||
|
||||
{viewMode === 'search' && status === LoadingState.SUCCESS && marketplaceResults.length === 0 && input && (
|
||||
<div className="animate-fade-in-up text-center py-4">
|
||||
<div className="text-zinc-500 font-mono text-sm mb-4">
|
||||
No skills found for "{input}" in the marketplace.
|
||||
</div>
|
||||
<Button onClick={handleGenerateWithAI}>
|
||||
GENERATE WITH AI
|
||||
</Button>
|
||||
</div>
|
||||
)}
|
||||
|
||||
{viewMode === 'content' && selectedSkill && (
|
||||
<div className="animate-fade-in-up">
|
||||
<div className="flex items-start justify-between mb-6 border-b border-zinc-800 pb-6">
|
||||
<div>
|
||||
<h3 className="text-2xl font-bold text-white mb-2">{selectedSkill.name}</h3>
|
||||
<p className="text-zinc-400 font-mono text-sm mb-2">{selectedSkill.description}</p>
|
||||
<div className="flex items-center gap-2 text-xs text-zinc-500 font-mono">
|
||||
<span>{selectedSkill.source}</span>
|
||||
{selectedSkill.sourceUrl && (
|
||||
<>
|
||||
<span>•</span>
|
||||
<a href={selectedSkill.sourceUrl} target="_blank" rel="noopener noreferrer" className="hover:text-white">
|
||||
View on GitHub
|
||||
</a>
|
||||
</>
|
||||
)}
|
||||
</div>
|
||||
</div>
|
||||
{skillContent && (
|
||||
<button
|
||||
onClick={downloadSkillMd}
|
||||
className="flex items-center gap-2 bg-white text-black px-4 py-2 font-mono text-sm hover:bg-zinc-200 transition-colors shrink-0 ml-4"
|
||||
>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" className="h-4 w-4" 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>
|
||||
DOWNLOAD
|
||||
</button>
|
||||
)}
|
||||
</div>
|
||||
|
||||
{status === LoadingState.LOADING ? (
|
||||
<div className="text-zinc-500 font-mono text-sm">Loading content...</div>
|
||||
) : skillContent ? (
|
||||
<pre className="bg-zinc-900 border border-zinc-700 p-6 overflow-x-auto text-sm max-h-[600px] overflow-y-auto">
|
||||
<code className="text-zinc-100 font-mono whitespace-pre-wrap">{skillContent}</code>
|
||||
</pre>
|
||||
) : (
|
||||
<div className="bg-zinc-950 border border-zinc-800 p-6">
|
||||
<p className="text-zinc-400 font-mono text-sm mb-4">
|
||||
Skill content not available for direct preview.
|
||||
</p>
|
||||
<a
|
||||
href={selectedSkill.sourceUrl}
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
className="inline-flex items-center gap-2 bg-zinc-800 text-white px-4 py-2 font-mono text-sm hover:bg-zinc-700 transition-colors"
|
||||
>
|
||||
View on GitHub
|
||||
<svg xmlns="http://www.w3.org/2000/svg" className="h-4 w-4" fill="none" viewBox="0 0 24 24" stroke="currentColor">
|
||||
<path strokeLinecap="round" strokeLinejoin="round" strokeWidth={2} d="M10 6H6a2 2 0 00-2 2v10a2 2 0 002 2h10a2 2 0 002-2v-4M14 4h6m0 0v6m0-6L10 14" />
|
||||
</svg>
|
||||
</a>
|
||||
</div>
|
||||
)}
|
||||
|
||||
<div className="mt-6 pt-6 border-t border-zinc-800">
|
||||
<p className="text-zinc-500 font-mono text-sm mb-3">Install with SkillKit:</p>
|
||||
<pre className="bg-zinc-950 border border-zinc-800 p-4 text-sm overflow-x-auto">
|
||||
<code className="text-zinc-300 font-mono text-xs sm:text-sm whitespace-nowrap">
|
||||
npx skillkit install {selectedSkill.id.split('/').slice(0, 2).join('/')}
|
||||
</code>
|
||||
</pre>
|
||||
</div>
|
||||
</div>
|
||||
)}
|
||||
|
||||
{viewMode === 'generated' && generatedSkill && (
|
||||
<div className="animate-fade-in-up">
|
||||
<div className="mb-8 border-b border-zinc-800 pb-6">
|
||||
<div className="flex flex-col sm:flex-row sm:items-start sm:justify-between gap-4">
|
||||
<div className="flex-1 min-w-0">
|
||||
<div className="flex flex-wrap items-center gap-2 mb-2">
|
||||
<h3 className="text-lg sm:text-xl md:text-2xl font-bold text-white">{generatedSkill.title}</h3>
|
||||
<span className="text-xs font-mono text-zinc-500 bg-zinc-900 px-2 py-1 border border-zinc-800">
|
||||
v{generatedSkill.version}
|
||||
</span>
|
||||
<span className="text-xs font-mono text-purple-400 bg-purple-900/30 px-2 py-1 border border-purple-800/50">
|
||||
AI Generated
|
||||
</span>
|
||||
{isFromCache && (
|
||||
<span className="text-xs font-mono text-green-400 bg-green-900/30 px-2 py-1 border border-green-800/50">
|
||||
Cached
|
||||
</span>
|
||||
)}
|
||||
</div>
|
||||
<p className="text-zinc-400 font-mono text-xs sm:text-sm mb-4">{generatedSkill.description}</p>
|
||||
<div className="flex flex-wrap gap-2">
|
||||
{generatedSkill.tags.map((tag, idx) => (
|
||||
<span key={idx} className="text-xs bg-zinc-900 text-zinc-400 px-2 py-1 border border-zinc-800">
|
||||
{tag}
|
||||
</span>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
<div className="flex flex-row gap-2 shrink-0">
|
||||
<button
|
||||
type="button"
|
||||
onClick={downloadGeneratedSkillMd}
|
||||
className="flex items-center justify-center gap-2 bg-white text-black px-3 sm:px-4 py-2 font-mono text-xs sm:text-sm hover:bg-zinc-200 transition-colors"
|
||||
>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" className="h-4 w-4" 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="hidden sm:inline">DOWNLOAD</span>
|
||||
</button>
|
||||
<button
|
||||
type="button"
|
||||
onClick={submitToMarketplace}
|
||||
className="flex items-center justify-center gap-2 bg-purple-600 text-white px-3 sm:px-4 py-2 font-mono text-xs sm:text-sm hover:bg-purple-500 transition-colors"
|
||||
>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" className="h-4 w-4" fill="none" viewBox="0 0 24 24" stroke="currentColor">
|
||||
<path strokeLinecap="round" strokeLinejoin="round" strokeWidth={2} d="M7 16a4 4 0 01-.88-7.903A5 5 0 1115.9 6L16 6a5 5 0 011 9.9M15 13l-3-3m0 0l-3 3m3-3v12" />
|
||||
</svg>
|
||||
<span className="hidden sm:inline">SUBMIT</span>
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<Card className="mb-6">
|
||||
<h4 className="text-sm font-mono text-zinc-500 uppercase tracking-wider mb-2">When to Apply</h4>
|
||||
<p className="text-zinc-300">{generatedSkill.applicability}</p>
|
||||
{generatedSkill.filePatterns && generatedSkill.filePatterns.length > 0 && (
|
||||
<div className="mt-3 flex flex-wrap gap-2">
|
||||
{generatedSkill.filePatterns.map((pattern, idx) => (
|
||||
<code key={idx} className="text-xs bg-zinc-900 text-zinc-300 px-2 py-1 border border-zinc-800">
|
||||
{pattern}
|
||||
</code>
|
||||
))}
|
||||
</div>
|
||||
)}
|
||||
</Card>
|
||||
|
||||
<div className="flex overflow-x-auto border-b border-zinc-800 mb-6 -mx-4 px-4 sm:mx-0 sm:px-0">
|
||||
{(['principles', 'patterns', 'antipatterns'] as const).map((tab) => (
|
||||
<button
|
||||
key={tab}
|
||||
type="button"
|
||||
onClick={() => setActiveTab(tab)}
|
||||
className={`px-3 sm:px-6 py-3 font-mono text-xs sm:text-sm uppercase tracking-wider transition-colors whitespace-nowrap flex-shrink-0 ${
|
||||
activeTab === tab
|
||||
? 'text-white border-b-2 border-white -mb-px'
|
||||
: 'text-zinc-500 hover:text-zinc-300'
|
||||
}`}
|
||||
>
|
||||
{tab === 'antipatterns' ? 'Anti-Patterns' : tab}
|
||||
<span className="ml-1 sm:ml-2 text-xs text-zinc-600">
|
||||
({tab === 'principles' ? generatedSkill.principles.length : tab === 'patterns' ? generatedSkill.patterns.length : generatedSkill.antiPatterns.length})
|
||||
</span>
|
||||
</button>
|
||||
))}
|
||||
</div>
|
||||
|
||||
<div className="space-y-4">
|
||||
{activeTab === 'principles' && generatedSkill.principles.map((principle, idx) => (
|
||||
<Card key={idx} className="hover:border-zinc-600 transition-colors">
|
||||
<div className="flex items-start justify-between gap-4 mb-2">
|
||||
<h4 className="text-lg font-semibold text-white">{principle.title}</h4>
|
||||
<PriorityBadge priority={principle.priority} />
|
||||
</div>
|
||||
<p className="text-zinc-400 leading-relaxed">{principle.description}</p>
|
||||
</Card>
|
||||
))}
|
||||
|
||||
{activeTab === 'patterns' && generatedSkill.patterns.map((pattern, idx) => (
|
||||
<Card key={idx} className="hover:border-zinc-600 transition-colors">
|
||||
<h4 className="text-lg font-semibold text-white mb-2">{pattern.name}</h4>
|
||||
<p className="text-zinc-400 mb-4">{pattern.description}</p>
|
||||
<pre className="bg-zinc-900 border border-zinc-700 p-4 overflow-x-auto text-sm">
|
||||
<code className="text-zinc-100 font-mono">{pattern.example}</code>
|
||||
</pre>
|
||||
</Card>
|
||||
))}
|
||||
|
||||
{activeTab === 'antipatterns' && generatedSkill.antiPatterns.map((ap, idx) => (
|
||||
<Card key={idx} className="hover:border-zinc-600 transition-colors border-red-900/30">
|
||||
<h4 className="text-lg font-semibold text-white mb-2">{ap.name}</h4>
|
||||
<p className="text-zinc-400 mb-4">{ap.description}</p>
|
||||
{ap.badExample && (
|
||||
<div className="mb-4">
|
||||
<div className="text-xs font-mono text-red-400 mb-1 uppercase">Bad</div>
|
||||
<pre className="bg-red-950/50 border border-red-800/50 p-4 overflow-x-auto text-sm">
|
||||
<code className="text-red-100 font-mono">{ap.badExample}</code>
|
||||
</pre>
|
||||
</div>
|
||||
)}
|
||||
{ap.goodExample && (
|
||||
<div>
|
||||
<div className="text-xs font-mono text-green-400 mb-1 uppercase">Good</div>
|
||||
<pre className="bg-green-950/30 border border-green-800/50 p-4 overflow-x-auto text-sm">
|
||||
<code className="text-green-100 font-mono">{ap.goodExample}</code>
|
||||
</pre>
|
||||
</div>
|
||||
)}
|
||||
</Card>
|
||||
))}
|
||||
</div>
|
||||
|
||||
{generatedSkill.references && generatedSkill.references.length > 0 && (
|
||||
<div className="mt-8 pt-6 border-t border-zinc-800">
|
||||
<h4 className="text-sm font-mono text-zinc-500 uppercase tracking-wider mb-3">References</h4>
|
||||
<ul className="space-y-1">
|
||||
{generatedSkill.references.map((ref, idx) => (
|
||||
<li key={idx}>
|
||||
{isValidUrl(ref) ? (
|
||||
<a
|
||||
href={ref}
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
className="text-zinc-400 hover:text-white font-mono text-sm transition-colors"
|
||||
>
|
||||
{ref}
|
||||
</a>
|
||||
) : (
|
||||
<span className="text-zinc-400 font-mono text-sm">{ref}</span>
|
||||
)}
|
||||
</li>
|
||||
))}
|
||||
</ul>
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,554 @@
|
||||
import React, { useState, useCallback } from 'react';
|
||||
import { Card } from './Card';
|
||||
|
||||
type Mode = 'upload' | 'import';
|
||||
|
||||
interface SkillFormData {
|
||||
slug: string;
|
||||
displayName: string;
|
||||
description: string;
|
||||
version: string;
|
||||
tags: string;
|
||||
repoOwner: string;
|
||||
repoName: string;
|
||||
skillPath: string;
|
||||
authorGithub: string;
|
||||
skillContent: string;
|
||||
}
|
||||
|
||||
const INITIAL_FORM: SkillFormData = {
|
||||
slug: '',
|
||||
displayName: '',
|
||||
description: '',
|
||||
version: '1.0.0',
|
||||
tags: '',
|
||||
repoOwner: '',
|
||||
repoName: '',
|
||||
skillPath: '',
|
||||
authorGithub: '',
|
||||
skillContent: '',
|
||||
};
|
||||
|
||||
const TAG_SUGGESTIONS = [
|
||||
'react', 'typescript', 'nextjs', 'python', 'rust', 'go',
|
||||
'testing', 'api', 'database', 'devops', 'security', 'mobile',
|
||||
] as const;
|
||||
|
||||
const GITHUB_ICON = (
|
||||
<svg className="w-5 h-5" 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>
|
||||
);
|
||||
|
||||
export function SkillSubmitForm(): React.ReactElement {
|
||||
const [mode, setMode] = useState<Mode>('import');
|
||||
const [form, setForm] = useState<SkillFormData>(INITIAL_FORM);
|
||||
const [isDragging, setIsDragging] = useState(false);
|
||||
const [fileName, setFileName] = useState<string | null>(null);
|
||||
const [githubUrl, setGithubUrl] = useState('');
|
||||
const [isDetecting, setIsDetecting] = useState(false);
|
||||
const [detectError, setDetectError] = useState<string | null>(null);
|
||||
|
||||
function updateField(field: keyof SkillFormData, value: string): void {
|
||||
setForm(prev => {
|
||||
const updated = { ...prev, [field]: value };
|
||||
if (field === 'displayName' && !prev.slug) {
|
||||
updated.slug = value.toLowerCase().replace(/\s+/g, '-').replace(/[^a-z0-9-]/g, '');
|
||||
}
|
||||
return updated;
|
||||
});
|
||||
}
|
||||
|
||||
function addTag(tag: string): void {
|
||||
const currentTags = form.tags.split(',').map(t => t.trim()).filter(Boolean);
|
||||
if (!currentTags.includes(tag)) {
|
||||
updateField('tags', [...currentTags, tag].join(', '));
|
||||
}
|
||||
}
|
||||
|
||||
const parseSkillContent = useCallback(function(content: string): void {
|
||||
const frontmatterMatch = content.match(/^---\n([\s\S]*?)\n---/);
|
||||
if (frontmatterMatch) {
|
||||
const fm = frontmatterMatch[1];
|
||||
const nameMatch = fm.match(/name:\s*["']?([^"'\n]+)["']?/);
|
||||
const descMatch = fm.match(/description:\s*["']?([^"'\n]+)["']?/);
|
||||
const tagsMatch = fm.match(/tags:\s*\[([^\]]+)\]/);
|
||||
const versionMatch = fm.match(/version:\s*["']?([^"'\n]+)["']?/);
|
||||
|
||||
if (nameMatch) updateField('displayName', nameMatch[1].trim());
|
||||
if (descMatch) updateField('description', descMatch[1].trim());
|
||||
if (versionMatch) updateField('version', versionMatch[1].trim());
|
||||
if (tagsMatch) {
|
||||
const tags = tagsMatch[1].replace(/["']/g, '').split(',').map(t => t.trim()).join(', ');
|
||||
updateField('tags', tags);
|
||||
}
|
||||
}
|
||||
updateField('skillContent', content);
|
||||
}, []);
|
||||
|
||||
async function handleDetect(): Promise<void> {
|
||||
if (!githubUrl) return;
|
||||
|
||||
setIsDetecting(true);
|
||||
setDetectError(null);
|
||||
|
||||
try {
|
||||
const urlMatch = githubUrl.match(/github\.com\/([^\/]+)\/([^\/]+)(?:\/(?:tree|blob)\/[^\/]+\/(.+))?/);
|
||||
|
||||
if (!urlMatch) {
|
||||
throw new Error('Invalid GitHub URL');
|
||||
}
|
||||
|
||||
const [, owner, repo, path = ''] = urlMatch;
|
||||
|
||||
const apiUrl = `https://api.github.com/repos/${owner}/${repo}`;
|
||||
const response = await fetch(apiUrl);
|
||||
|
||||
if (!response.ok) {
|
||||
throw new Error('Repository not found or not public');
|
||||
}
|
||||
|
||||
const repoData = await response.json();
|
||||
|
||||
updateField('repoOwner', owner);
|
||||
updateField('repoName', repo);
|
||||
updateField('authorGithub', owner);
|
||||
updateField('displayName', repoData.name.replace(/-/g, ' ').replace(/\b\w/g, (c: string) => c.toUpperCase()));
|
||||
updateField('description', repoData.description || '');
|
||||
|
||||
const slug = path ? path.split('/').filter(Boolean).pop() || repo : repo;
|
||||
updateField('slug', slug.toLowerCase().replace(/[^a-z0-9-]/g, '-'));
|
||||
|
||||
if (repoData.topics && repoData.topics.length > 0) {
|
||||
updateField('tags', repoData.topics.slice(0, 5).join(', '));
|
||||
} else {
|
||||
const inferredTags: string[] = [];
|
||||
const nameLC = (repo + ' ' + (repoData.description || '')).toLowerCase();
|
||||
if (nameLC.includes('react')) inferredTags.push('react');
|
||||
if (nameLC.includes('typescript') || nameLC.includes('ts')) inferredTags.push('typescript');
|
||||
if (nameLC.includes('python')) inferredTags.push('python');
|
||||
if (nameLC.includes('skill')) inferredTags.push('skills');
|
||||
if (inferredTags.length > 0) {
|
||||
updateField('tags', inferredTags.join(', '));
|
||||
}
|
||||
}
|
||||
|
||||
updateField('skillContent', `[Linked from GitHub: ${owner}/${repo}]`);
|
||||
updateField('skillPath', path || '/');
|
||||
|
||||
} catch (err) {
|
||||
setDetectError(err instanceof Error ? err.message : 'Detection failed');
|
||||
} finally {
|
||||
setIsDetecting(false);
|
||||
}
|
||||
}
|
||||
|
||||
const handleDragOver = useCallback(function(e: React.DragEvent): void {
|
||||
e.preventDefault();
|
||||
setIsDragging(true);
|
||||
}, []);
|
||||
|
||||
const handleDragLeave = useCallback(function(e: React.DragEvent): void {
|
||||
e.preventDefault();
|
||||
setIsDragging(false);
|
||||
}, []);
|
||||
|
||||
const processMarkdownFile = useCallback(function(file: File): void {
|
||||
setFileName(file.name);
|
||||
const reader = new FileReader();
|
||||
reader.onload = (event) => {
|
||||
const content = event.target?.result;
|
||||
if (typeof content === 'string') {
|
||||
parseSkillContent(content);
|
||||
}
|
||||
};
|
||||
reader.readAsText(file);
|
||||
}, [parseSkillContent]);
|
||||
|
||||
const handleDrop = useCallback(function(e: React.DragEvent): void {
|
||||
e.preventDefault();
|
||||
setIsDragging(false);
|
||||
|
||||
const files = Array.from(e.dataTransfer.files);
|
||||
const mdFile = files.find(f => f.name.endsWith('.md'));
|
||||
|
||||
if (mdFile) {
|
||||
processMarkdownFile(mdFile);
|
||||
}
|
||||
}, [processMarkdownFile]);
|
||||
|
||||
function handleFileSelect(e: React.ChangeEvent<HTMLInputElement>): void {
|
||||
const file = e.target.files?.[0];
|
||||
if (file && file.name.endsWith('.md')) {
|
||||
processMarkdownFile(file);
|
||||
}
|
||||
}
|
||||
|
||||
const validation = {
|
||||
slug: !form.slug ? 'Slug is required.' : null,
|
||||
displayName: !form.displayName ? 'Display name is required.' : null,
|
||||
content: mode === 'upload' && !form.skillContent ? 'Upload a SKILL.md file.' : null,
|
||||
repo: mode === 'import' && (!form.repoOwner || !form.repoName) ? 'Click Detect to import repo.' : null,
|
||||
tags: !form.tags ? 'Add at least one tag.' : null,
|
||||
};
|
||||
|
||||
const isImported = mode === 'import' && form.repoOwner && form.repoName;
|
||||
const errors = Object.values(validation).filter(Boolean);
|
||||
const isValid = errors.length === 0;
|
||||
const tagsArray = form.tags.split(',').map(t => t.trim()).filter(Boolean);
|
||||
|
||||
function generateIssueUrl(): string {
|
||||
const skillId = form.repoOwner && form.repoName
|
||||
? `${form.repoOwner}/${form.repoName}/${form.slug}`
|
||||
: `community/${form.authorGithub || 'anonymous'}/${form.slug}`;
|
||||
|
||||
const jsonEntry = JSON.stringify({
|
||||
id: skillId,
|
||||
name: form.displayName,
|
||||
description: form.description || '',
|
||||
source: `${form.repoOwner}/${form.repoName}`,
|
||||
tags: tagsArray,
|
||||
author: form.authorGithub || form.repoOwner
|
||||
}, null, 2);
|
||||
|
||||
const title = isImported
|
||||
? encodeURIComponent(`[Import] ${form.repoOwner}/${form.repoName}`)
|
||||
: encodeURIComponent(`[Skill] ${form.displayName}`);
|
||||
|
||||
const bodyContent = isImported
|
||||
? `## 📦 Import Request: ${form.repoOwner}/${form.repoName}
|
||||
|
||||
### Repository
|
||||
🔗 https://github.com/${form.repoOwner}/${form.repoName}
|
||||
|
||||
### Add to \`marketplace/skills.json\`
|
||||
|
||||
\`\`\`json
|
||||
${jsonEntry}
|
||||
\`\`\`
|
||||
|
||||
### Checklist for Maintainer
|
||||
- [ ] Verify repository is public
|
||||
- [ ] Add JSON entry to \`marketplace/skills.json\`
|
||||
|
||||
---
|
||||
**Submitted by:** @${form.authorGithub || 'anonymous'}
|
||||
**Owner:** @${form.repoOwner} (retains all rights)`
|
||||
: `## 📤 Skill Upload: ${form.displayName}
|
||||
|
||||
### Add to \`marketplace/skills.json\`
|
||||
|
||||
\`\`\`json
|
||||
${jsonEntry}
|
||||
\`\`\`
|
||||
|
||||
### SKILL.md Content
|
||||
|
||||
<details>
|
||||
<summary>Click to expand</summary>
|
||||
|
||||
\`\`\`markdown
|
||||
${form.skillContent.slice(0, 4000)}${form.skillContent.length > 4000 ? '\n...(truncated)' : ''}
|
||||
\`\`\`
|
||||
|
||||
</details>
|
||||
|
||||
### Checklist for Maintainer
|
||||
- [ ] Review SKILL.md content
|
||||
- [ ] Add JSON entry to \`marketplace/skills.json\`
|
||||
|
||||
---
|
||||
**Author:** @${form.authorGithub || 'anonymous'}`;
|
||||
|
||||
const body = encodeURIComponent(bodyContent);
|
||||
const labels = isImported ? 'skill-import' : 'skill-submission';
|
||||
return `https://github.com/rohitg00/skillkit/issues/new?title=${title}&body=${body}&labels=${labels}`;
|
||||
}
|
||||
|
||||
function handleSubmitClick(e: React.MouseEvent): void {
|
||||
e.preventDefault();
|
||||
if (isValid) {
|
||||
const url = generateIssueUrl();
|
||||
window.open(url, '_blank', 'noopener,noreferrer');
|
||||
}
|
||||
}
|
||||
|
||||
return (
|
||||
<div className="space-y-6">
|
||||
<div className="flex border-b border-zinc-800">
|
||||
<button
|
||||
onClick={() => setMode('import')}
|
||||
className={`px-6 py-3 font-mono text-sm transition-colors ${
|
||||
mode === 'import'
|
||||
? 'text-white border-b-2 border-white -mb-px'
|
||||
: 'text-zinc-500 hover:text-zinc-300'
|
||||
}`}
|
||||
>
|
||||
Import from GitHub
|
||||
</button>
|
||||
<button
|
||||
onClick={() => setMode('upload')}
|
||||
className={`px-6 py-3 font-mono text-sm transition-colors ${
|
||||
mode === 'upload'
|
||||
? 'text-white border-b-2 border-white -mb-px'
|
||||
: 'text-zinc-500 hover:text-zinc-300'
|
||||
}`}
|
||||
>
|
||||
Upload File
|
||||
</button>
|
||||
</div>
|
||||
|
||||
<div className="grid grid-cols-1 lg:grid-cols-2 gap-6">
|
||||
<div className="space-y-6">
|
||||
{mode === 'import' && (
|
||||
<Card>
|
||||
<div className="flex items-center justify-between mb-1">
|
||||
<label className="text-sm text-zinc-400">GitHub URL</label>
|
||||
<span className="text-xs text-zinc-600">Repo, tree path, or blob</span>
|
||||
</div>
|
||||
<div className="flex gap-3 mt-2">
|
||||
<input
|
||||
type="text"
|
||||
value={githubUrl}
|
||||
onChange={(e) => setGithubUrl(e.target.value)}
|
||||
placeholder="https://github.com/owner/repo"
|
||||
className="flex-1 bg-zinc-900 border border-zinc-700 text-white px-4 py-2.5 font-mono text-sm focus:ring-1 focus:ring-white focus:border-white outline-none placeholder-zinc-600"
|
||||
/>
|
||||
<button
|
||||
onClick={handleDetect}
|
||||
disabled={isDetecting || !githubUrl}
|
||||
className={`px-5 py-2.5 font-mono text-sm transition-colors ${
|
||||
isDetecting || !githubUrl
|
||||
? 'bg-zinc-800 text-zinc-600 cursor-not-allowed'
|
||||
: 'bg-white text-black hover:bg-zinc-200'
|
||||
}`}
|
||||
>
|
||||
{isDetecting ? 'Detecting...' : 'Detect'}
|
||||
</button>
|
||||
</div>
|
||||
{detectError && (
|
||||
<p className="text-red-400 text-xs mt-2 font-mono">{detectError}</p>
|
||||
)}
|
||||
{isImported && (
|
||||
<p className="text-zinc-300 text-xs mt-2 font-mono flex items-center gap-1">
|
||||
<svg className="w-3 h-3" fill="none" viewBox="0 0 24 24" stroke="currentColor">
|
||||
<path strokeLinecap="round" strokeLinejoin="round" strokeWidth={2} d="M5 13l4 4L19 7" />
|
||||
</svg>
|
||||
Repository detected - {form.repoOwner}/{form.repoName}
|
||||
</p>
|
||||
)}
|
||||
<p className="text-zinc-600 text-xs mt-3">
|
||||
Public repos only. We link to the original - owner retains all rights.
|
||||
</p>
|
||||
</Card>
|
||||
)}
|
||||
|
||||
{mode === 'upload' && (
|
||||
<Card
|
||||
className={`transition-colors ${isDragging ? 'border-white bg-zinc-900' : ''}`}
|
||||
onDragOver={handleDragOver}
|
||||
onDragLeave={handleDragLeave}
|
||||
onDrop={handleDrop}
|
||||
>
|
||||
<div className="text-center py-6">
|
||||
<div className="mb-3">
|
||||
<svg className="w-8 h-8 mx-auto text-zinc-600" fill="none" viewBox="0 0 24 24" stroke="currentColor">
|
||||
<path strokeLinecap="round" strokeLinejoin="round" strokeWidth={1.5} d="M7 16a4 4 0 01-.88-7.903A5 5 0 1115.9 6L16 6a5 5 0 011 9.9M15 13l-3-3m0 0l-3 3m3-3v12" />
|
||||
</svg>
|
||||
</div>
|
||||
<p className="text-zinc-400 text-sm mb-1">
|
||||
{fileName ? (
|
||||
<span className="text-white">{fileName}</span>
|
||||
) : (
|
||||
'Drop SKILL.md here'
|
||||
)}
|
||||
</p>
|
||||
<p className="text-zinc-600 text-xs mb-3">or</p>
|
||||
<label className="inline-block cursor-pointer">
|
||||
<span className="bg-zinc-800 hover:bg-zinc-700 text-white px-4 py-2 text-sm font-mono transition-colors">
|
||||
Choose file
|
||||
</span>
|
||||
<input
|
||||
type="file"
|
||||
accept=".md"
|
||||
onChange={handleFileSelect}
|
||||
className="hidden"
|
||||
/>
|
||||
</label>
|
||||
</div>
|
||||
</Card>
|
||||
)}
|
||||
|
||||
<Card>
|
||||
<div className="space-y-4">
|
||||
<div className="grid grid-cols-2 gap-4">
|
||||
<div>
|
||||
<label className="block text-sm text-zinc-400 mb-1.5">Slug</label>
|
||||
<input
|
||||
type="text"
|
||||
value={form.slug}
|
||||
onChange={(e) => updateField('slug', e.target.value.toLowerCase().replace(/[^a-z0-9-]/g, ''))}
|
||||
placeholder="my-skill"
|
||||
className="w-full bg-zinc-900 border border-zinc-700 text-white px-3 py-2 font-mono text-sm focus:ring-1 focus:ring-white focus:border-white outline-none placeholder-zinc-600"
|
||||
/>
|
||||
</div>
|
||||
<div>
|
||||
<label className="block text-sm text-zinc-400 mb-1.5">Display name</label>
|
||||
<input
|
||||
type="text"
|
||||
value={form.displayName}
|
||||
onChange={(e) => updateField('displayName', e.target.value)}
|
||||
placeholder="My Skill"
|
||||
className="w-full bg-zinc-900 border border-zinc-700 text-white px-3 py-2 font-mono text-sm focus:ring-1 focus:ring-white focus:border-white outline-none placeholder-zinc-600"
|
||||
/>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div className="grid grid-cols-2 gap-4">
|
||||
<div>
|
||||
<label className="block text-sm text-zinc-400 mb-1.5">Version</label>
|
||||
<input
|
||||
type="text"
|
||||
value={form.version}
|
||||
onChange={(e) => updateField('version', e.target.value)}
|
||||
placeholder="1.0.0"
|
||||
className="w-full bg-zinc-900 border border-zinc-700 text-white px-3 py-2 font-mono text-sm focus:ring-1 focus:ring-white focus:border-white outline-none placeholder-zinc-600"
|
||||
/>
|
||||
</div>
|
||||
<div>
|
||||
<label className="block text-sm text-zinc-400 mb-1.5">Tags</label>
|
||||
<input
|
||||
type="text"
|
||||
value={form.tags}
|
||||
onChange={(e) => updateField('tags', e.target.value)}
|
||||
placeholder="react, typescript"
|
||||
className="w-full bg-zinc-900 border border-zinc-700 text-white px-3 py-2 font-mono text-sm focus:ring-1 focus:ring-white focus:border-white outline-none placeholder-zinc-600"
|
||||
/>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div className="flex flex-wrap gap-1.5">
|
||||
{TAG_SUGGESTIONS.map((tag) => (
|
||||
<button
|
||||
key={tag}
|
||||
type="button"
|
||||
onClick={() => addTag(tag)}
|
||||
className="text-xs text-zinc-500 hover:text-zinc-300 hover:bg-zinc-800 px-2 py-0.5 border border-zinc-800 transition-colors"
|
||||
>
|
||||
+{tag}
|
||||
</button>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
</Card>
|
||||
</div>
|
||||
|
||||
<div className="space-y-6">
|
||||
<Card>
|
||||
<h4 className="text-sm text-zinc-400 mb-4">Preview</h4>
|
||||
<div className="bg-zinc-950 border border-zinc-800 p-4">
|
||||
<div className="flex items-start justify-between mb-3">
|
||||
<div>
|
||||
<h5 className="text-white font-semibold">
|
||||
{form.displayName || 'Skill Name'}
|
||||
</h5>
|
||||
<p className="text-zinc-500 text-sm mt-1">
|
||||
{form.description || 'No description'}
|
||||
</p>
|
||||
</div>
|
||||
<span className="text-xs font-mono text-zinc-600 bg-zinc-900 px-2 py-1">
|
||||
v{form.version}
|
||||
</span>
|
||||
</div>
|
||||
{(form.repoOwner || form.authorGithub) && (
|
||||
<div className="flex items-center gap-2 text-xs text-zinc-600 font-mono mb-3">
|
||||
{form.repoOwner && form.repoName && <span>{form.repoOwner}/{form.repoName}</span>}
|
||||
{form.authorGithub && (
|
||||
<>
|
||||
{form.repoOwner && <span>•</span>}
|
||||
<span>@{form.authorGithub}</span>
|
||||
</>
|
||||
)}
|
||||
</div>
|
||||
)}
|
||||
{tagsArray.length > 0 && (
|
||||
<div className="flex flex-wrap gap-1.5">
|
||||
{tagsArray.map((tag, i) => (
|
||||
<span key={i} className="text-xs bg-zinc-900 text-zinc-500 px-2 py-0.5 border border-zinc-800">
|
||||
{tag}
|
||||
</span>
|
||||
))}
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
</Card>
|
||||
|
||||
{isImported ? (
|
||||
<Card className="border-blue-900/50">
|
||||
<div className="flex items-center gap-3 mb-3">
|
||||
<div className="w-8 h-8 bg-blue-900/30 border border-blue-800 flex items-center justify-center">
|
||||
<svg className="w-4 h-4 text-blue-400" fill="none" viewBox="0 0 24 24" stroke="currentColor">
|
||||
<path strokeLinecap="round" strokeLinejoin="round" strokeWidth={2} d="M13.828 10.172a4 4 0 00-5.656 0l-4 4a4 4 0 105.656 5.656l1.102-1.101m-.758-4.899a4 4 0 005.656 0l4-4a4 4 0 00-5.656-5.656l-1.1 1.1" />
|
||||
</svg>
|
||||
</div>
|
||||
<div>
|
||||
<h4 className="text-sm text-white font-medium">Linked Repository</h4>
|
||||
<p className="text-xs text-zinc-500">Skills hosted by @{form.repoOwner}</p>
|
||||
</div>
|
||||
</div>
|
||||
<a
|
||||
href={`https://github.com/${form.repoOwner}/${form.repoName}`}
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
className="text-sm text-blue-400 hover:text-blue-300 font-mono flex items-center gap-2"
|
||||
>
|
||||
github.com/{form.repoOwner}/{form.repoName}
|
||||
<svg className="w-3 h-3" fill="none" viewBox="0 0 24 24" stroke="currentColor">
|
||||
<path strokeLinecap="round" strokeLinejoin="round" strokeWidth={2} d="M10 6H6a2 2 0 00-2 2v10a2 2 0 002 2h10a2 2 0 002-2v-4M14 4h6m0 0v6m0-6L10 14" />
|
||||
</svg>
|
||||
</a>
|
||||
</Card>
|
||||
) : form.skillContent && !form.skillContent.startsWith('[Linked') ? (
|
||||
<Card>
|
||||
<h4 className="text-sm text-zinc-400 mb-3">SKILL.md</h4>
|
||||
<pre className="bg-zinc-950 border border-zinc-800 p-3 text-xs font-mono text-zinc-400 max-h-48 overflow-auto">
|
||||
{form.skillContent.slice(0, 1000)}
|
||||
{form.skillContent.length > 1000 && '\n...'}
|
||||
</pre>
|
||||
</Card>
|
||||
) : null}
|
||||
|
||||
{errors.length > 0 && (
|
||||
<div className="space-y-1 text-xs font-mono text-yellow-500">
|
||||
{errors.map((error, i) => (
|
||||
<div key={i} className="flex items-center gap-1">
|
||||
<span className="text-yellow-600">•</span> {error}
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
)}
|
||||
|
||||
<button
|
||||
type="button"
|
||||
onClick={handleSubmitClick}
|
||||
disabled={!isValid}
|
||||
className={`flex items-center justify-center gap-3 w-full py-4 font-mono text-sm transition-all ${
|
||||
isValid
|
||||
? 'bg-white text-black hover:bg-zinc-200'
|
||||
: 'bg-zinc-800 text-zinc-600 cursor-not-allowed'
|
||||
}`}
|
||||
>
|
||||
{GITHUB_ICON}
|
||||
{isImported ? 'Import to marketplace' : 'Publish skill'}
|
||||
</button>
|
||||
|
||||
<p className="text-xs text-zinc-600 text-center font-mono">
|
||||
{isImported
|
||||
? 'Links to original repo → Owner retains rights'
|
||||
: 'Opens GitHub issue → We review → Added to marketplace'}
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,56 @@
|
||||
import React from 'react';
|
||||
|
||||
interface TerminalProps {
|
||||
title?: string;
|
||||
children: React.ReactNode;
|
||||
className?: string;
|
||||
}
|
||||
|
||||
interface CodeBlockProps {
|
||||
code: string;
|
||||
language?: string;
|
||||
}
|
||||
|
||||
interface CommandProps {
|
||||
cmd: string;
|
||||
comment?: string;
|
||||
}
|
||||
|
||||
export function Terminal({ title = 'bash', children, className = '' }: TerminalProps): React.ReactElement {
|
||||
return (
|
||||
<div className={`rounded-lg overflow-hidden border border-zinc-800 bg-[#09090b] shadow-2xl ${className}`}>
|
||||
<div className="flex items-center justify-between px-4 py-2 border-b border-zinc-800 bg-zinc-900/50">
|
||||
<div className="flex space-x-2">
|
||||
<div className="w-3 h-3 rounded-full bg-zinc-700"></div>
|
||||
<div className="w-3 h-3 rounded-full bg-zinc-700"></div>
|
||||
<div className="w-3 h-3 rounded-full bg-zinc-700"></div>
|
||||
</div>
|
||||
<div className="text-xs text-zinc-500 font-mono">{title}</div>
|
||||
<div className="w-10"></div>
|
||||
</div>
|
||||
<div className="p-4 font-mono text-sm overflow-x-auto">
|
||||
{children}
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
export function CodeBlock({ code }: CodeBlockProps): React.ReactElement {
|
||||
return (
|
||||
<pre className="text-zinc-300 font-mono text-sm leading-relaxed whitespace-pre-wrap">
|
||||
{code}
|
||||
</pre>
|
||||
);
|
||||
}
|
||||
|
||||
export function Command({ cmd, comment }: CommandProps): React.ReactElement {
|
||||
return (
|
||||
<div className="mb-2">
|
||||
<div className="flex text-zinc-100">
|
||||
<span className="text-zinc-500 mr-2">$</span>
|
||||
<span>{cmd}</span>
|
||||
</div>
|
||||
{comment && <div className="text-zinc-500 text-xs mt-1 ml-4"># {comment}</div>}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,99 @@
|
||||
{
|
||||
"$schema": "http://json-schema.org/draft-07/schema#",
|
||||
"title": "SkillKit Marketplace",
|
||||
"description": "Schema for SkillKit marketplace skills index",
|
||||
"type": "object",
|
||||
"required": ["version", "skills"],
|
||||
"properties": {
|
||||
"version": {
|
||||
"type": "integer",
|
||||
"description": "Schema version number"
|
||||
},
|
||||
"updatedAt": {
|
||||
"type": "string",
|
||||
"format": "date",
|
||||
"description": "Last update date (YYYY-MM-DD)"
|
||||
},
|
||||
"skills": {
|
||||
"type": "array",
|
||||
"description": "List of skills in the marketplace",
|
||||
"items": {
|
||||
"$ref": "#/definitions/Skill"
|
||||
}
|
||||
}
|
||||
},
|
||||
"definitions": {
|
||||
"Skill": {
|
||||
"type": "object",
|
||||
"required": ["id", "name", "source", "tags"],
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"pattern": "^[a-zA-Z0-9_-]+/[a-zA-Z0-9_.-]+/[a-zA-Z0-9_-]+$",
|
||||
"description": "Unique identifier: owner/repo/skill-name"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"minLength": 1,
|
||||
"maxLength": 100,
|
||||
"description": "Human-readable skill name"
|
||||
},
|
||||
"description": {
|
||||
"type": "string",
|
||||
"maxLength": 500,
|
||||
"description": "Brief description of the skill"
|
||||
},
|
||||
"source": {
|
||||
"type": "string",
|
||||
"pattern": "^[a-zA-Z0-9_-]+/[a-zA-Z0-9_.-]+$",
|
||||
"description": "GitHub repository: owner/repo"
|
||||
},
|
||||
"tags": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string",
|
||||
"pattern": "^[a-z0-9-]+$"
|
||||
},
|
||||
"minItems": 1,
|
||||
"maxItems": 10,
|
||||
"description": "Tags for categorization (lowercase, hyphenated)"
|
||||
},
|
||||
"author": {
|
||||
"type": "string",
|
||||
"description": "Skill author name or GitHub username"
|
||||
},
|
||||
"version": {
|
||||
"type": "string",
|
||||
"pattern": "^\\d+\\.\\d+\\.\\d+$",
|
||||
"description": "Semantic version (e.g., 1.0.0)"
|
||||
},
|
||||
"agents": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"claude-code",
|
||||
"cursor",
|
||||
"codex",
|
||||
"gemini-cli",
|
||||
"opencode",
|
||||
"antigravity",
|
||||
"amp",
|
||||
"clawdbot",
|
||||
"droid",
|
||||
"github-copilot",
|
||||
"goose",
|
||||
"kilo",
|
||||
"kiro-cli",
|
||||
"roo",
|
||||
"trae",
|
||||
"windsurf",
|
||||
"universal"
|
||||
]
|
||||
},
|
||||
"description": "Compatible AI agents (omit for universal compatibility)"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,58 @@
|
||||
// Single source of truth: marketplace/skills.json
|
||||
import skillsData from '../../../../marketplace/skills.json';
|
||||
|
||||
export interface IndexedSkill {
|
||||
id: string;
|
||||
name: string;
|
||||
description: string;
|
||||
source: string;
|
||||
sourceUrl: string;
|
||||
rawUrl: string;
|
||||
tags: string[];
|
||||
}
|
||||
|
||||
function buildSkillIndex(): IndexedSkill[] {
|
||||
return skillsData.skills.map(skill => {
|
||||
const sourceParts = skill.source?.split('/') || [];
|
||||
const owner = sourceParts[0] || 'unknown';
|
||||
const repo = sourceParts[1] || 'unknown';
|
||||
const skillSlug = skill.id.split('/').pop() || skill.name.toLowerCase().replace(/\s+/g, '-');
|
||||
|
||||
return {
|
||||
id: skill.id,
|
||||
name: skill.name,
|
||||
description: skill.description || '',
|
||||
source: skill.source || '',
|
||||
sourceUrl: owner !== 'unknown' ? `https://github.com/${skill.source}` : '',
|
||||
rawUrl: owner !== 'unknown' && repo !== 'unknown'
|
||||
? `https://raw.githubusercontent.com/${owner}/${repo}/main/skills/${skillSlug}/SKILL.md`
|
||||
: '',
|
||||
tags: skill.tags || [],
|
||||
};
|
||||
});
|
||||
}
|
||||
|
||||
export const SKILLS_INDEX: IndexedSkill[] = buildSkillIndex();
|
||||
|
||||
export function searchSkills(query: string): IndexedSkill[] {
|
||||
const q = query.toLowerCase().trim();
|
||||
if (!q) return [];
|
||||
|
||||
return SKILLS_INDEX.filter(skill =>
|
||||
skill.name.toLowerCase().includes(q) ||
|
||||
skill.description.toLowerCase().includes(q) ||
|
||||
skill.tags.some(tag => tag.toLowerCase().includes(q))
|
||||
).slice(0, 20);
|
||||
}
|
||||
|
||||
export function getSkillsByTag(tag: string): IndexedSkill[] {
|
||||
return SKILLS_INDEX.filter(skill =>
|
||||
skill.tags.some(t => t.toLowerCase() === tag.toLowerCase())
|
||||
);
|
||||
}
|
||||
|
||||
export function getAllTags(): string[] {
|
||||
const tags = new Set<string>();
|
||||
SKILLS_INDEX.forEach(skill => skill.tags.forEach(tag => tags.add(tag)));
|
||||
return Array.from(tags).sort();
|
||||
}
|
||||
@@ -0,0 +1,35 @@
|
||||
import Link from 'next/link'
|
||||
import React, { type PropsWithChildren } from 'react'
|
||||
import { cn } from '../utils'
|
||||
import * as Icons from 'lucide-react'
|
||||
import type { LucideIcon } from 'lucide-react'
|
||||
|
||||
type CardProps = PropsWithChildren<{
|
||||
title: string
|
||||
description: string
|
||||
href: string
|
||||
icon?: string
|
||||
horizontal?: boolean
|
||||
}>
|
||||
|
||||
export const Card: React.FC<CardProps> = ({ title, description, href, icon, children, horizontal = false }) => {
|
||||
const IconComponent = icon ? (Icons as unknown as Record<string, LucideIcon>)[icon] : null
|
||||
|
||||
return (
|
||||
<Link href={href} className="no-underline flex">
|
||||
<div
|
||||
className={cn(
|
||||
'flex w-full flex-1 border border-border hover:border-foreground bg-muted-background rounded-lg p-4 hover:bg-muted-foreground/10 transition-colors',
|
||||
horizontal ? 'flex-row gap-4 items-center' : 'flex-col gap-1',
|
||||
)}
|
||||
>
|
||||
{IconComponent && <IconComponent className={cn('size-6', horizontal ? 'mt-1' : 'mb-2')} />}
|
||||
<div className="flex flex-col gap-1">
|
||||
<h3 className="text-lg m-0! font-semibold">{title}</h3>
|
||||
{description && <div className="text-sm text-muted-foreground">{description}</div>}
|
||||
{children}
|
||||
</div>
|
||||
</div>
|
||||
</Link>
|
||||
)
|
||||
}
|
||||
@@ -0,0 +1,23 @@
|
||||
import React, { type PropsWithChildren } from 'react'
|
||||
import { cn } from '../utils'
|
||||
|
||||
type ColumnsProps = PropsWithChildren<{
|
||||
cols?: number
|
||||
className?: string
|
||||
}>
|
||||
|
||||
export const Columns: React.FC<ColumnsProps> = ({ cols = 2, className = '', children }) => {
|
||||
return (
|
||||
<div
|
||||
className={cn(
|
||||
'grid gap-4 md:gap-6 grid-cols-1 auto-rows-min md:auto-cols-min',
|
||||
cols === 2 && 'md:grid-cols-2',
|
||||
cols === 3 && 'md:grid-cols-3',
|
||||
cols === 4 && 'md:grid-cols-4',
|
||||
className,
|
||||
)}
|
||||
>
|
||||
{children}
|
||||
</div>
|
||||
)
|
||||
}
|
||||
@@ -0,0 +1,26 @@
|
||||
import type { BaseLayoutProps } from 'fumadocs-ui/layouts/shared'
|
||||
|
||||
export function baseOptions(): BaseLayoutProps {
|
||||
return {
|
||||
nav: {
|
||||
title: 'SkillKit',
|
||||
},
|
||||
links: [
|
||||
{
|
||||
text: 'DeepWiki',
|
||||
url: 'https://deepwiki.com/rohitg00/skillkit',
|
||||
external: true,
|
||||
},
|
||||
{
|
||||
text: 'GitHub',
|
||||
url: 'https://github.com/rohitg00/skillkit',
|
||||
external: true,
|
||||
},
|
||||
{
|
||||
text: 'npm',
|
||||
url: 'https://www.npmjs.com/package/skillkit',
|
||||
external: true,
|
||||
},
|
||||
],
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,26 @@
|
||||
import { docs } from 'fumadocs-mdx:collections/server'
|
||||
import { type InferPageType, loader } from 'fumadocs-core/source'
|
||||
import { lucideIconsPlugin } from 'fumadocs-core/source/lucide-icons'
|
||||
|
||||
export const source = loader({
|
||||
baseUrl: '/docs',
|
||||
source: docs.toFumadocsSource(),
|
||||
plugins: [lucideIconsPlugin()],
|
||||
})
|
||||
|
||||
export function getPageImage(page: InferPageType<typeof source>) {
|
||||
const segments = [...page.slugs, 'image.png']
|
||||
|
||||
return {
|
||||
segments,
|
||||
url: `/og/docs/${segments.join('/')}`,
|
||||
}
|
||||
}
|
||||
|
||||
export async function getLLMText(page: InferPageType<typeof source>) {
|
||||
const processed = await page.data.getText('processed')
|
||||
|
||||
return `# ${page.data.title}
|
||||
|
||||
${processed}`
|
||||
}
|
||||
@@ -0,0 +1,6 @@
|
||||
import { type ClassValue, clsx } from 'clsx'
|
||||
import { twMerge } from 'tailwind-merge'
|
||||
|
||||
export function cn(...inputs: ClassValue[]) {
|
||||
return twMerge(clsx(inputs))
|
||||
}
|
||||
@@ -0,0 +1,14 @@
|
||||
import defaultMdxComponents from 'fumadocs-ui/mdx'
|
||||
import type { MDXComponents } from 'mdx/types'
|
||||
import { Card } from '@/lib/components/Card'
|
||||
import { Columns } from './lib/components/Columns'
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
export function getMDXComponents(components?: MDXComponents): any {
|
||||
return {
|
||||
...defaultMdxComponents,
|
||||
...components,
|
||||
Card,
|
||||
Columns,
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,23 @@
|
||||
import { AgentSkill } from "../types";
|
||||
|
||||
export async function generateAgentSkill(topic: string): Promise<AgentSkill> {
|
||||
const sanitizedTopic = topic?.trim().slice(0, 500) || '';
|
||||
if (!sanitizedTopic) {
|
||||
throw new Error("Topic is required");
|
||||
}
|
||||
|
||||
const response = await fetch('/api/generate-skill', {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({ topic: sanitizedTopic }),
|
||||
});
|
||||
|
||||
if (!response.ok) {
|
||||
const error = await response.json().catch(() => ({ error: 'Unknown error' }));
|
||||
throw new Error(error.error || 'Failed to generate skill');
|
||||
}
|
||||
|
||||
return response.json();
|
||||
}
|
||||
|
||||
export const generateLearningPath: (topic: string) => Promise<AgentSkill> = generateAgentSkill;
|
||||
@@ -0,0 +1,57 @@
|
||||
export interface LearningStep {
|
||||
title: string;
|
||||
description: string;
|
||||
duration: string;
|
||||
keyConcepts: string[];
|
||||
}
|
||||
|
||||
export interface LearningPath {
|
||||
skill: string;
|
||||
description: string;
|
||||
steps: LearningStep[];
|
||||
}
|
||||
|
||||
export interface GenerateSkillResponse {
|
||||
learningPath: LearningPath;
|
||||
}
|
||||
|
||||
export enum LoadingState {
|
||||
IDLE = 'IDLE',
|
||||
LOADING = 'LOADING',
|
||||
SUCCESS = 'SUCCESS',
|
||||
ERROR = 'ERROR'
|
||||
}
|
||||
|
||||
export interface AgentSkill {
|
||||
name: string;
|
||||
title: string;
|
||||
description: string;
|
||||
version: string;
|
||||
tags: string[];
|
||||
applicability: string;
|
||||
principles: SkillPrinciple[];
|
||||
patterns: SkillPattern[];
|
||||
antiPatterns: SkillAntiPattern[];
|
||||
filePatterns?: string[];
|
||||
references?: string[];
|
||||
}
|
||||
|
||||
export interface SkillPrinciple {
|
||||
title: string;
|
||||
description: string;
|
||||
priority: 'must' | 'should' | 'may';
|
||||
}
|
||||
|
||||
export interface SkillPattern {
|
||||
name: string;
|
||||
description: string;
|
||||
example: string;
|
||||
language?: string;
|
||||
}
|
||||
|
||||
export interface SkillAntiPattern {
|
||||
name: string;
|
||||
description: string;
|
||||
badExample?: string;
|
||||
goodExample?: string;
|
||||
}
|
||||
@@ -0,0 +1,46 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"target": "ES2017",
|
||||
"lib": [
|
||||
"dom",
|
||||
"dom.iterable",
|
||||
"esnext"
|
||||
],
|
||||
"allowJs": true,
|
||||
"skipLibCheck": true,
|
||||
"strict": true,
|
||||
"noEmit": true,
|
||||
"esModuleInterop": true,
|
||||
"module": "esnext",
|
||||
"moduleResolution": "bundler",
|
||||
"resolveJsonModule": true,
|
||||
"isolatedModules": true,
|
||||
"jsx": "react-jsx",
|
||||
"incremental": true,
|
||||
"plugins": [
|
||||
{
|
||||
"name": "next"
|
||||
}
|
||||
],
|
||||
"baseUrl": ".",
|
||||
"paths": {
|
||||
"@/*": [
|
||||
"./src/*"
|
||||
],
|
||||
"fumadocs-mdx:collections/*": [
|
||||
".source/*"
|
||||
]
|
||||
}
|
||||
},
|
||||
"include": [
|
||||
"next-env.d.ts",
|
||||
"**/*.ts",
|
||||
"**/*.tsx",
|
||||
".next/types/**/*.ts",
|
||||
".source/**/*.ts",
|
||||
".next/dev/types/**/*.ts"
|
||||
],
|
||||
"exclude": [
|
||||
"node_modules"
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,7 @@
|
||||
{
|
||||
"$schema": "https://openapi.vercel.sh/vercel.json",
|
||||
"buildCommand": "next build",
|
||||
"installCommand": "npm install",
|
||||
"outputDirectory": ".next",
|
||||
"framework": "nextjs"
|
||||
}
|
||||
@@ -0,0 +1,57 @@
|
||||
<svg width="1200" height="400" viewBox="0 0 1200 400" 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"/>
|
||||
<stop offset="50%" style="stop-color:#111111"/>
|
||||
<stop offset="100%" style="stop-color:#0a0a0a"/>
|
||||
</linearGradient>
|
||||
<linearGradient id="border" x1="0%" y1="0%" x2="100%" y2="0%">
|
||||
<stop offset="0%" style="stop-color:#333"/>
|
||||
<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>
|
||||
</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"/>
|
||||
|
||||
<line x1="60" y1="340" x2="1140" y2="340" stroke="#1a1a1a" stroke-width="1"/>
|
||||
|
||||
<g transform="translate(60, 80)">
|
||||
<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="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>
|
||||
|
||||
<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>
|
||||
|
||||
<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>
|
||||
|
||||
<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>
|
||||
|
||||
<g transform="translate(60, 355)">
|
||||
<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>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 3.0 KiB |
|
After Width: | Height: | Size: 99 KiB |
|
After Width: | Height: | Size: 46 KiB |
@@ -0,0 +1,24 @@
|
||||
# Logs
|
||||
logs
|
||||
*.log
|
||||
npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
pnpm-debug.log*
|
||||
lerna-debug.log*
|
||||
|
||||
node_modules
|
||||
dist
|
||||
dist-ssr
|
||||
*.local
|
||||
|
||||
# Editor directories and files
|
||||
.vscode/*
|
||||
!.vscode/extensions.json
|
||||
.idea
|
||||
.DS_Store
|
||||
*.suo
|
||||
*.ntvs*
|
||||
*.njsproj
|
||||
*.sln
|
||||
*.sw?
|
||||
@@ -0,0 +1,261 @@
|
||||
import React from 'react';
|
||||
import { Hero } from './components/Hero';
|
||||
import { Features } from './components/Features';
|
||||
import { Agents } from './components/Agents';
|
||||
import { Footer } from './components/Footer';
|
||||
import { SkillGenerator } from './components/SkillGenerator';
|
||||
import { SkillSubmitForm } from './components/SkillSubmitForm';
|
||||
import { Commands } from './components/Commands';
|
||||
import { StackBuilder } from './components/StackBuilder';
|
||||
import { TrendingSkills } from './components/TrendingSkills';
|
||||
import { Attribution } from './components/Attribution';
|
||||
import { AdvancedFeatures } from './components/AdvancedFeatures';
|
||||
import { UseCases } from './components/UseCases';
|
||||
import { TeamEnterprise } from './components/TeamEnterprise';
|
||||
import { BadgeGenerator } from './components/BadgeGenerator';
|
||||
import { CompatibilityMatrix } from './components/CompatibilityMatrix';
|
||||
import { useStats } from './hooks/useStats';
|
||||
|
||||
const GITHUB_ICON = (
|
||||
<svg className="w-5 h-5" 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>
|
||||
);
|
||||
|
||||
function scrollToTop(e: React.MouseEvent): void {
|
||||
e.preventDefault();
|
||||
window.scrollTo({ top: 0, behavior: 'smooth' });
|
||||
}
|
||||
|
||||
function scrollToSection(e: React.MouseEvent, sectionId: string): void {
|
||||
e.preventDefault();
|
||||
const element = document.getElementById(sectionId);
|
||||
if (element) {
|
||||
element.scrollIntoView({ behavior: 'smooth' });
|
||||
history.replaceState(null, '', `#${sectionId}`);
|
||||
}
|
||||
}
|
||||
|
||||
export default function App(): React.ReactElement {
|
||||
const stats = useStats();
|
||||
|
||||
return (
|
||||
<div className="min-h-screen text-zinc-100 font-sans selection:bg-white selection:text-black" style={{ backgroundColor: '#000000' }}>
|
||||
<nav className="fixed top-0 left-0 right-0 z-50 border-b border-zinc-800 backdrop-blur-md" style={{ backgroundColor: 'rgba(0,0,0,0.9)' }}>
|
||||
<div className="mx-auto max-w-5xl px-4 sm:px-6 lg:px-8">
|
||||
<div className="flex h-14 items-center justify-between gap-2">
|
||||
<a href="#" onClick={scrollToTop} className="flex items-center gap-2 cursor-pointer">
|
||||
<div className="w-4 h-4 bg-white"></div>
|
||||
<span className="text-base font-bold tracking-tight text-white font-mono">SKILLKIT</span>
|
||||
</a>
|
||||
<div className="hidden sm:flex items-center gap-4 text-xs font-mono">
|
||||
<a
|
||||
href="#trending"
|
||||
onClick={(e) => scrollToSection(e, 'trending')}
|
||||
className="text-zinc-500 hover:text-white transition-colors"
|
||||
>
|
||||
Trending
|
||||
</a>
|
||||
<a
|
||||
href="#stack"
|
||||
onClick={(e) => scrollToSection(e, 'stack')}
|
||||
className="text-zinc-500 hover:text-white transition-colors"
|
||||
>
|
||||
Stack
|
||||
</a>
|
||||
<a
|
||||
href="#matrix"
|
||||
onClick={(e) => scrollToSection(e, 'matrix')}
|
||||
className="text-zinc-500 hover:text-white transition-colors"
|
||||
>
|
||||
Matrix
|
||||
</a>
|
||||
<a
|
||||
href="#badge"
|
||||
onClick={(e) => scrollToSection(e, 'badge')}
|
||||
className="text-zinc-500 hover:text-white transition-colors"
|
||||
>
|
||||
Badge
|
||||
</a>
|
||||
<a
|
||||
href="#advanced"
|
||||
onClick={(e) => scrollToSection(e, 'advanced')}
|
||||
className="text-zinc-500 hover:text-white transition-colors"
|
||||
>
|
||||
Features
|
||||
</a>
|
||||
<a
|
||||
href="#use-cases"
|
||||
onClick={(e) => scrollToSection(e, 'use-cases')}
|
||||
className="text-zinc-500 hover:text-white transition-colors"
|
||||
>
|
||||
Use Cases
|
||||
</a>
|
||||
<a
|
||||
href="#skills"
|
||||
onClick={(e) => scrollToSection(e, 'skills')}
|
||||
className="text-zinc-500 hover:text-white transition-colors"
|
||||
>
|
||||
Generator
|
||||
</a>
|
||||
</div>
|
||||
<div className="flex items-center gap-3 sm:gap-4">
|
||||
<a
|
||||
href="/api"
|
||||
className="text-zinc-400 hover:text-white transition-colors text-xs sm:text-sm font-mono"
|
||||
>
|
||||
API
|
||||
</a>
|
||||
<a
|
||||
href="https://agenstskills.com/docs"
|
||||
className="text-zinc-400 hover:text-white transition-colors text-xs sm:text-sm font-mono"
|
||||
>
|
||||
Docs
|
||||
</a>
|
||||
<a
|
||||
href="https://github.com/rohitg00/skillkit"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
className="inline-flex items-center gap-1.5 border border-zinc-700 hover:border-zinc-500 px-2 py-1 transition-colors group"
|
||||
aria-label="GitHub Stars"
|
||||
>
|
||||
{GITHUB_ICON}
|
||||
<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>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main className="pt-14">
|
||||
<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">
|
||||
<div className="flex items-center justify-center gap-4 sm:gap-6 text-xs font-mono">
|
||||
<a
|
||||
href="https://www.npmjs.com/package/skillkit"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
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>
|
||||
</a>
|
||||
<span className="text-zinc-800">·</span>
|
||||
<a
|
||||
href="https://www.npmjs.com/package/skillkit"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
className="flex items-center gap-1.5 text-zinc-500 hover:text-white transition-colors group"
|
||||
>
|
||||
<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>
|
||||
</a>
|
||||
<span className="text-zinc-800">·</span>
|
||||
<a
|
||||
href="https://github.com/rohitg00/skillkit"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
className="flex items-center gap-1.5 text-zinc-500 hover:text-white transition-colors group"
|
||||
>
|
||||
<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' }}
|
||||
/>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{/* Agent Support - Quick visual proof */}
|
||||
<Agents />
|
||||
|
||||
{/* Core Features & Comparison - Value prop at a glance */}
|
||||
<Features />
|
||||
|
||||
{/* Trending Skills - Social proof, what's popular */}
|
||||
<section id="trending" style={{ scrollMarginTop: '4rem' }}>
|
||||
<TrendingSkills />
|
||||
</section>
|
||||
|
||||
{/* Stack Builder - Interactive, engaging */}
|
||||
<section id="stack" style={{ scrollMarginTop: '4rem' }}>
|
||||
<StackBuilder />
|
||||
</section>
|
||||
|
||||
{/* Compatibility Matrix */}
|
||||
<section id="matrix" style={{ scrollMarginTop: '4rem' }}>
|
||||
<CompatibilityMatrix />
|
||||
</section>
|
||||
|
||||
{/* Badge Generator */}
|
||||
<section id="badge" style={{ scrollMarginTop: '4rem' }}>
|
||||
<BadgeGenerator />
|
||||
</section>
|
||||
|
||||
{/* Advanced Capabilities: Memory, Primer, Mesh, Messaging */}
|
||||
<section id="advanced" style={{ scrollMarginTop: '4rem' }}>
|
||||
<AdvancedFeatures />
|
||||
</section>
|
||||
|
||||
{/* Commands Reference */}
|
||||
<Commands />
|
||||
|
||||
{/* Real-World Use Cases */}
|
||||
<section id="use-cases" style={{ scrollMarginTop: '4rem' }}>
|
||||
<UseCases />
|
||||
</section>
|
||||
|
||||
{/* Team & Enterprise */}
|
||||
<section id="team" style={{ scrollMarginTop: '4rem' }}>
|
||||
<TeamEnterprise />
|
||||
</section>
|
||||
|
||||
{/* Skill Generator */}
|
||||
<section id="skills" className="py-12 border-b border-zinc-800" style={{ scrollMarginTop: '4rem' }}>
|
||||
<SkillGenerator />
|
||||
</section>
|
||||
|
||||
{/* Submit Skill */}
|
||||
<section id="submit" className="py-12 border-b border-zinc-800" style={{ backgroundColor: '#09090b', scrollMarginTop: '4rem' }}>
|
||||
<div className="mx-auto max-w-5xl px-4 sm:px-6 lg:px-8">
|
||||
<div className="text-center mb-8">
|
||||
<h2 className="text-2xl font-bold text-white mb-2 font-mono">Submit Your Skill</h2>
|
||||
<p className="text-zinc-400 font-mono text-sm">
|
||||
Share your AI agent skills with the community.
|
||||
</p>
|
||||
</div>
|
||||
<SkillSubmitForm />
|
||||
</div>
|
||||
</section>
|
||||
|
||||
{/* Attribution & Sources */}
|
||||
<section id="sources" style={{ scrollMarginTop: '4rem' }}>
|
||||
<Attribution />
|
||||
</section>
|
||||
</main>
|
||||
|
||||
<Footer />
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,39 @@
|
||||
# SkillKit Documentation Website
|
||||
|
||||
Landing page for SkillKit - the universal CLI for managing AI agent skills.
|
||||
|
||||
**Live site:** https://rohitg00.github.io/skillkit/
|
||||
|
||||
## Development
|
||||
|
||||
**Prerequisites:** Node.js 20+
|
||||
|
||||
1. Install dependencies:
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
2. (Optional) Set `GEMINI_API_KEY` in `.env.local` for the skill generator feature
|
||||
|
||||
3. Run locally:
|
||||
```bash
|
||||
npm run dev
|
||||
```
|
||||
|
||||
4. Build for production:
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
## Deployment
|
||||
|
||||
The site is automatically deployed to GitHub Pages when changes are pushed to the `main` branch.
|
||||
|
||||
The deployment workflow is defined in `.github/workflows/deploy-docs.yml`.
|
||||
|
||||
## Tech Stack
|
||||
|
||||
- React 19
|
||||
- Vite
|
||||
- Tailwind CSS (via CDN)
|
||||
- TypeScript
|
||||