mirror of
https://github.com/rohitg00/skillkit.git
synced 2026-11-20 12:23:29 +00:00
* fix: update docs, TUI help, and website for v1.19.2 gaps - docs/index.mdx: version v1.18.0 → v1.19.2, add skills.sh install source, add methodology packs to next steps - docs/rest-api.mdx: health check example version 1.12.0 → 1.19.2 - docs/methodology.mdx: new page documenting 5 packs with 14 skills - docs/meta.json: add methodology to page ordering - Hero.tsx: show skills.sh install in terminal animation - Help.tsx: fix shortcut conflicts — add Session section (l=Timeline, v=Lineage, f=Handoff), remove stale f=Find/v=Validate mappings * fix: update stale stats across repo, website, TUI, CLI, and docs - Fix agent count: 32 → 44 across package.json, core, TUI READMEs - Fix source count: 31+ → 34+ across website (Hero, Features, WhySkillKit) - Fix skill count: 15K/15,000+ → 400K+ everywhere (SkillKit aggregates from registries like skills.sh 83K+, SkillsMP 351K+, not just bundled) - Add 13 missing agents to carousel (Devin, Aider, Cody, Amazon Q, Augment, Replit, Bolt, Lovable, Tabby, Tabnine, CodeGPT, PlayCode, Universal) — now shows all 44 - Refactor Attribution.tsx to import from marketplace/sources.json (single source of truth, auto-shows all 34 sources) - Fix 8 broken trending skill IDs that didn't resolve in skills.json - Update fumadocs site (Hero, Commands, layout, page, Documentation) - Update CLI generate command hints and API docs description - Increase carousel scroll animation 35s → 45s for more agents - Add resolveJsonModule to website tsconfig.json
341 lines
8.8 KiB
Markdown
341 lines
8.8 KiB
Markdown
# @skillkit/core
|
|
|
|
[](https://www.npmjs.com/package/@skillkit/core)
|
|
[](https://opensource.org/licenses/Apache-2.0)
|
|
|
|
**Core engine for SkillKit** - skill discovery, cross-agent translation, recommendations, session memory, testing, and workflow orchestration.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm install @skillkit/core
|
|
```
|
|
|
|
## Key Features
|
|
|
|
- **Skill Discovery**: Find and parse SKILL.md files from any source
|
|
- **Cross-Agent Translation**: Convert skills between 44 agent formats (Claude Code, Cursor, Windsurf, etc.)
|
|
- **Project Context Detection**: Analyze project stack, dependencies, and configurations
|
|
- **Smart Recommendations**: AI-powered skill suggestions based on project profile
|
|
- **Session Memory**: Capture and persist learnings across AI coding sessions
|
|
- **Skill Testing**: Test framework with assertions for skill validation
|
|
- **Workflow Orchestration**: Compose skills into multi-step workflows
|
|
- **Marketplace Aggregation**: Browse and search curated skill repositories
|
|
- **Team Collaboration**: Share skill bundles with Git-based remote sync
|
|
- **Plugin System**: Extend with custom translators, providers, and commands
|
|
- **Methodologies**: 5 development frameworks (Agile, TDD, DevOps, Design Thinking, Feature Flags)
|
|
- **Multi-Agent Orchestration**: Coordinate teams of AI agents with task assignment
|
|
- **Plan System**: Parse, validate, and execute structured development plans
|
|
- **Hooks & Automation**: Auto-trigger skills on file changes, git events
|
|
|
|
## Usage
|
|
|
|
### Skill Discovery
|
|
|
|
```typescript
|
|
import { findAllSkills, discoverSkills, parseSkill } from '@skillkit/core';
|
|
|
|
// Find all installed skills
|
|
const skills = findAllSkills(['.claude/skills', '.cursor/skills']);
|
|
|
|
// Discover skills from a repository
|
|
const repoSkills = await discoverSkills('anthropics/skills');
|
|
|
|
// Parse a single skill file
|
|
const skill = parseSkill('./my-skill/SKILL.md');
|
|
```
|
|
|
|
### Cross-Agent Translation
|
|
|
|
```typescript
|
|
import { translateSkill, translateSkillFile, TranslatorRegistry } from '@skillkit/core';
|
|
|
|
// Translate skill content to Cursor format
|
|
const result = translateSkill(skillContent, 'cursor');
|
|
console.log(result.content); // MDC format for Cursor
|
|
|
|
// Translate a skill file
|
|
const translated = await translateSkillFile('./skill.md', 'windsurf');
|
|
|
|
// Get available translators
|
|
const registry = new TranslatorRegistry();
|
|
const formats = registry.getSupportedFormats();
|
|
```
|
|
|
|
### Project Context & Recommendations
|
|
|
|
```typescript
|
|
import { ProjectDetector, RecommendationEngine, ContextManager } from '@skillkit/core';
|
|
|
|
// Detect project context
|
|
const detector = new ProjectDetector();
|
|
const profile = await detector.analyze('./my-project');
|
|
// profile.stack includes: languages, frameworks, libraries, testing tools, etc.
|
|
|
|
// Get skill recommendations
|
|
const engine = new RecommendationEngine();
|
|
const recommendations = engine.recommend(profile, availableSkills);
|
|
// Returns skills sorted by match score
|
|
|
|
// Manage project context
|
|
const ctx = new ContextManager('./my-project');
|
|
await ctx.init();
|
|
const context = ctx.getContext();
|
|
```
|
|
|
|
### Session Memory
|
|
|
|
```typescript
|
|
import {
|
|
createMemoryCompressor,
|
|
createMemoryInjector,
|
|
LearningStore,
|
|
ObservationStore,
|
|
} from '@skillkit/core';
|
|
|
|
// Compress observations into learnings
|
|
const compressor = createMemoryCompressor('./my-project');
|
|
const learnings = compressor.compress();
|
|
|
|
// Inject relevant memories into prompts
|
|
const injector = createMemoryInjector('./my-project');
|
|
const memories = injector.search('authentication patterns');
|
|
|
|
// Manage learnings directly
|
|
const store = new LearningStore('./my-project');
|
|
const learning = store.add({
|
|
title: 'React hooks best practices',
|
|
content: 'Always cleanup effects...',
|
|
tags: ['react', 'hooks'],
|
|
});
|
|
```
|
|
|
|
### Skill Testing
|
|
|
|
```typescript
|
|
import { SkillTestRunner, parseTestCases } from '@skillkit/core';
|
|
|
|
// Run skill tests
|
|
const runner = new SkillTestRunner('./my-project');
|
|
const results = await runner.runAll();
|
|
|
|
// Run specific tests
|
|
const result = await runner.run('./my-skill', {
|
|
tags: ['unit'],
|
|
verbose: true,
|
|
});
|
|
|
|
// Parse test cases from skill
|
|
const testCases = parseTestCases(skillContent);
|
|
```
|
|
|
|
### Workflow Orchestration
|
|
|
|
```typescript
|
|
import { WorkflowOrchestrator, parseWorkflow, WorkflowStore } from '@skillkit/core';
|
|
|
|
// Parse and run a workflow
|
|
const workflow = parseWorkflow('./workflow.yaml');
|
|
const orchestrator = new WorkflowOrchestrator(workflow);
|
|
await orchestrator.execute();
|
|
|
|
// Manage workflows
|
|
const store = new WorkflowStore('./my-project');
|
|
const workflows = store.list();
|
|
```
|
|
|
|
### Marketplace
|
|
|
|
```typescript
|
|
import { createMarketplaceAggregator, MarketplaceSource } from '@skillkit/core';
|
|
|
|
// Browse skill marketplace
|
|
const marketplace = createMarketplaceAggregator();
|
|
const results = await marketplace.search({ query: 'react' });
|
|
|
|
// Filter by tags
|
|
const filtered = await marketplace.search({
|
|
query: 'authentication',
|
|
tags: ['security', 'auth'],
|
|
limit: 10,
|
|
});
|
|
```
|
|
|
|
### Team Collaboration
|
|
|
|
```typescript
|
|
import { TeamManager, SkillBundle } from '@skillkit/core';
|
|
|
|
// Initialize team
|
|
const teamManager = new TeamManager('./my-project');
|
|
await teamManager.init('Engineering Team');
|
|
|
|
// Create skill bundle
|
|
const bundle = await teamManager.createBundle('onboarding', {
|
|
skills: ['git-workflow', 'code-review'],
|
|
description: 'New developer onboarding',
|
|
});
|
|
|
|
// Share bundle
|
|
await teamManager.shareBundle(bundle);
|
|
|
|
// Sync with remote registry
|
|
await teamManager.syncWithRemote('https://github.com/myorg/skills');
|
|
```
|
|
|
|
### Plugin System
|
|
|
|
```typescript
|
|
import { PluginManager, TranslatorPlugin } from '@skillkit/core';
|
|
|
|
// Load plugins
|
|
const pluginManager = new PluginManager('./my-project');
|
|
await pluginManager.loadAll();
|
|
|
|
// Install plugin
|
|
await pluginManager.install('custom-translator');
|
|
|
|
// Create custom plugin
|
|
const myPlugin: TranslatorPlugin = {
|
|
name: 'my-agent',
|
|
parse: async (content) => ({ /* canonical skill */ }),
|
|
generate: async (skill) => '/* custom format */',
|
|
};
|
|
```
|
|
|
|
### Methodologies
|
|
|
|
```typescript
|
|
import { MethodologyManager } from '@skillkit/core';
|
|
|
|
// List available methodologies
|
|
const methodologies = await MethodologyManager.list();
|
|
|
|
// Load methodology
|
|
const tdd = await MethodologyManager.load('tdd');
|
|
// Returns: { name: 'TDD', skills: ['red-green-refactor', 'test-first'], ... }
|
|
```
|
|
|
|
### Multi-Agent Orchestration
|
|
|
|
```typescript
|
|
import { TeamOrchestrator, TaskManager } from '@skillkit/core';
|
|
|
|
// Create agent team
|
|
const orchestrator = new TeamOrchestrator();
|
|
const team = await orchestrator.createTeam({
|
|
name: 'feature-dev',
|
|
leader: { id: 'architect', name: 'System Architect' },
|
|
teammates: [
|
|
{ id: 'frontend', name: 'Frontend Dev', capabilities: ['react'] },
|
|
{ id: 'backend', name: 'Backend Dev', capabilities: ['api'] },
|
|
],
|
|
});
|
|
|
|
// Manage tasks
|
|
const taskManager = new TaskManager();
|
|
const task = taskManager.createTask('Build login', 'Create login endpoint', spec);
|
|
await taskManager.assignTask(task.id, 'backend');
|
|
|
|
// Get stats
|
|
const stats = taskManager.getStats();
|
|
```
|
|
|
|
### Plan System
|
|
|
|
```typescript
|
|
import { PlanParser, PlanValidator, PlanExecutor } from '@skillkit/core';
|
|
|
|
// Parse plan from markdown
|
|
const parser = new PlanParser();
|
|
const plan = await parser.parseFile('./plan.md');
|
|
|
|
// Validate plan
|
|
const validator = new PlanValidator();
|
|
const validation = validator.validate(plan);
|
|
|
|
// Execute plan
|
|
const executor = new PlanExecutor();
|
|
const result = await executor.execute(plan, { dryRun: false });
|
|
```
|
|
|
|
### Hooks & Automation
|
|
|
|
```typescript
|
|
import { HookRegistry } from '@skillkit/core';
|
|
|
|
// Register hooks
|
|
const hooks = new HookRegistry('./my-project');
|
|
await hooks.register('pre-commit', {
|
|
event: 'pre-commit',
|
|
skill: 'code-review',
|
|
enabled: true,
|
|
});
|
|
|
|
// Trigger hook
|
|
await hooks.trigger('pre-commit', { files: ['src/index.ts'] });
|
|
```
|
|
|
|
## Supported Agents
|
|
|
|
The translator supports all 32 SkillKit-compatible agents:
|
|
|
|
| Agent | Format |
|
|
|-------|--------|
|
|
| Claude Code | SKILL.md |
|
|
| Cursor | MDC (.mdc) |
|
|
| Codex | SKILL.md |
|
|
| Gemini CLI | SKILL.md |
|
|
| Windsurf | Markdown |
|
|
| GitHub Copilot | Markdown |
|
|
| OpenCode, Antigravity, Amp, Goose, Kilo, Kiro, Roo, Trae | SKILL.md |
|
|
| Universal | SKILL.md |
|
|
|
|
## API Reference
|
|
|
|
### Skill Types
|
|
|
|
```typescript
|
|
interface CanonicalSkill {
|
|
name: string;
|
|
description?: string;
|
|
version?: string;
|
|
author?: string;
|
|
tags?: string[];
|
|
globs?: string[];
|
|
alwaysApply?: boolean;
|
|
content: string;
|
|
metadata?: Record<string, unknown>;
|
|
}
|
|
|
|
interface TranslationResult {
|
|
content: string;
|
|
format: string;
|
|
warnings?: string[];
|
|
}
|
|
```
|
|
|
|
### Context Types
|
|
|
|
```typescript
|
|
interface ProjectProfile {
|
|
name: string;
|
|
type: 'web-app' | 'api' | 'cli' | 'library' | 'unknown';
|
|
stack: {
|
|
languages: Detection[];
|
|
frameworks: Detection[];
|
|
libraries: Detection[];
|
|
testing: Detection[];
|
|
databases: Detection[];
|
|
};
|
|
}
|
|
```
|
|
|
|
## Documentation
|
|
|
|
Full documentation: https://github.com/rohitg00/skillkit
|
|
|
|
## License
|
|
|
|
Apache-2.0
|