mirror of
https://github.com/rohitg00/skillkit.git
synced 2026-11-18 18:04:26 +00:00
docs: update READMEs with Phase 10-18 features
- Root README: add minimal "What's New in v1.5.0" section with 5 bullet points - packages/core: add usage examples for Team, Plugin, Methodology, Orchestration, Plan, Hooks - packages/cli: add command sections for team, plugin, methodology, plan, hook, command - packages/tui: add screen descriptions for Marketplace, Workflow, Execute, Team, Plugins, Methodology, Plan, Memory - apps/skillkit: expand with practical usage examples for all new features All updates are clean, user-focused, and avoid AI marketing fluff.
This commit is contained in:
@@ -13,6 +13,14 @@
|
||||
npm install -g skillkit
|
||||
```
|
||||
|
||||
## What's New in v1.5.0
|
||||
|
||||
- **Team Collaboration**: Share skill bundles with your team via Git
|
||||
- **Plugin System**: Extend SkillKit with custom translators, providers, and commands
|
||||
- **Methodologies**: 5 ready-to-use development frameworks (Agile, TDD, DevOps, etc.)
|
||||
- **Agent Orchestration**: Coordinate multiple AI agents working together
|
||||
- **Hooks & Automation**: Auto-trigger skills on git commits, file changes
|
||||
|
||||
## The Problem
|
||||
|
||||
You've built amazing skills for Claude Code. Now you want to try Cursor. Or your team uses different agents. Your options:
|
||||
@@ -44,6 +52,7 @@ skillkit recommend
|
||||
| Feature | Without SkillKit | With SkillKit |
|
||||
|---------|-----------------|---------------|
|
||||
| **Multi-Agent Support** | Manual rewrite for each agent | One command, all agents |
|
||||
| **Team Collaboration** | Email skills back and forth | Git-based bundles, remote sync |
|
||||
| **Skill Discovery** | Search GitHub manually | Smart recommendations for your stack |
|
||||
| **Format Translation** | Learn each agent's format | Automatic conversion (17 formats) |
|
||||
| **Context Sync** | Configure each agent separately | One config, synced everywhere |
|
||||
|
||||
+170
-10
@@ -14,23 +14,183 @@ npm install -g skillkit
|
||||
# Initialize skillkit in your project
|
||||
skillkit init
|
||||
|
||||
# Install a skill
|
||||
skillkit install github.com/anthropics/courses:prompt-eng/interactive-tutorial
|
||||
# Install skills from GitHub
|
||||
skillkit install anthropics/skills
|
||||
|
||||
# List installed skills
|
||||
skillkit list
|
||||
# Get recommendations for your stack
|
||||
skillkit recommend
|
||||
|
||||
# Launch interactive TUI
|
||||
skillkit ui
|
||||
```
|
||||
|
||||
## Features
|
||||
## Core Features
|
||||
|
||||
- **17+ Agent Support**: Claude Code, Cursor, Codex, Gemini CLI, Windsurf, GitHub Copilot, and more
|
||||
- **Universal Skill Translation**: Convert skills between different agent formats
|
||||
- **Smart Recommendations**: Get skill suggestions based on your project stack
|
||||
- **Project Context Sync**: One config, all agents
|
||||
- **Interactive TUI**: Browse, install, and manage skills visually
|
||||
### 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 (17)
|
||||
|
||||
Claude Code, Cursor, Codex, Gemini CLI, Windsurf, GitHub Copilot, OpenCode, Antigravity, Amp, Clawdbot, Droid, Goose, Kilo, Kiro, Roo, Trae, Universal
|
||||
|
||||
## 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
|
||||
|
||||
|
||||
@@ -101,6 +101,62 @@ skillkit workflow create # Create new workflow
|
||||
skillkit cicd github-action # Generate GitHub Actions
|
||||
skillkit cicd gitlab-ci # Generate GitLab CI
|
||||
skillkit cicd pre-commit # Generate pre-commit hook
|
||||
skillkit cicd init # Initialize CI/CD templates
|
||||
```
|
||||
|
||||
### Team Collaboration
|
||||
|
||||
```bash
|
||||
skillkit team init --name "Team" # Initialize team
|
||||
skillkit team share <bundle> # Share skill bundle
|
||||
skillkit team import <path> # Import bundle
|
||||
skillkit team list # List team bundles
|
||||
skillkit team sync # Sync with remote
|
||||
skillkit team remove <bundle> # Remove bundle
|
||||
skillkit team bundle-create # Create new bundle
|
||||
skillkit team bundle-export <id> # Export bundle
|
||||
skillkit team bundle-list # List all bundles
|
||||
```
|
||||
|
||||
### Plugin System
|
||||
|
||||
```bash
|
||||
skillkit plugin list # List installed plugins
|
||||
skillkit plugin install <name> # Install plugin
|
||||
skillkit plugin uninstall <name> # Uninstall plugin
|
||||
skillkit plugin enable <name> # Enable plugin
|
||||
skillkit plugin disable <name> # Disable plugin
|
||||
skillkit plugin info <name> # Plugin details
|
||||
```
|
||||
|
||||
### Methodologies & Plans
|
||||
|
||||
```bash
|
||||
skillkit methodology list # List methodologies
|
||||
skillkit methodology load <name> # Load methodology
|
||||
skillkit methodology apply <name> # Apply to project
|
||||
|
||||
skillkit plan parse <file> # Parse plan file
|
||||
skillkit plan validate <file> # Validate plan
|
||||
skillkit plan execute <file> # Execute plan
|
||||
skillkit plan status # Plan execution status
|
||||
```
|
||||
|
||||
### Hooks & Automation
|
||||
|
||||
```bash
|
||||
skillkit hook list # List registered hooks
|
||||
skillkit hook register <event> # Register new hook
|
||||
skillkit hook trigger <event> # Trigger hook manually
|
||||
skillkit hook enable <id> # Enable hook
|
||||
skillkit hook disable <id> # Disable hook
|
||||
```
|
||||
|
||||
### Agent Commands
|
||||
|
||||
```bash
|
||||
skillkit command generate <agent> # Generate agent-native commands
|
||||
skillkit command list <agent> # List available commands
|
||||
```
|
||||
|
||||
### Utilities
|
||||
@@ -110,6 +166,8 @@ skillkit init # Initialize in project
|
||||
skillkit init --agent cursor # Initialize for specific agent
|
||||
skillkit validate ./skill # Validate skill format
|
||||
skillkit create my-skill # Create new skill
|
||||
skillkit settings # View all settings
|
||||
skillkit settings --set key=value # Update setting
|
||||
```
|
||||
|
||||
## Install Options
|
||||
|
||||
@@ -21,6 +21,12 @@ npm install @skillkit/core
|
||||
- **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
|
||||
|
||||
@@ -155,6 +161,121 @@ const filtered = await marketplace.search({
|
||||
});
|
||||
```
|
||||
|
||||
### 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 17 SkillKit-compatible agents:
|
||||
|
||||
+68
-5
@@ -32,16 +32,65 @@ skillkit
|
||||
|
||||
## Screens
|
||||
|
||||
### Home
|
||||
### Home (h)
|
||||
Overview of your project and quick actions. Shows detected agents, installed skills count, and navigation hints.
|
||||
|
||||
### Marketplace (m)
|
||||
Browse curated skill marketplace:
|
||||
- Search across 33+ repositories
|
||||
- Filter by tags and categories
|
||||
- View popularity metrics
|
||||
- Install with one key
|
||||
|
||||
### Browse (b)
|
||||
Explore available skills from curated repositories. Features:
|
||||
Explore available skills from curated repositories:
|
||||
- Search skills with `/`
|
||||
- Filter by tags
|
||||
- View skill details
|
||||
- One-key installation
|
||||
|
||||
### Workflow (w)
|
||||
Manage and execute workflows:
|
||||
- List available workflows
|
||||
- View workflow steps
|
||||
- Execute workflows
|
||||
- Monitor progress
|
||||
|
||||
### Execute (x)
|
||||
Execute skills with checkpoints:
|
||||
- Task-based execution
|
||||
- Decision and review checkpoints
|
||||
- Dry-run mode
|
||||
- Git integration
|
||||
|
||||
### Team (a)
|
||||
Team collaboration management:
|
||||
- Create and share skill bundles
|
||||
- Import team bundles
|
||||
- Sync with remote registry
|
||||
- Manage team members
|
||||
|
||||
### Plugins (p)
|
||||
Plugin system management:
|
||||
- List installed plugins
|
||||
- Install new plugins
|
||||
- Enable/disable plugins
|
||||
- View plugin details
|
||||
|
||||
### Methodology (o)
|
||||
Development methodologies:
|
||||
- Browse 5 methodologies (Agile, TDD, DevOps, Design Thinking, Feature Flags)
|
||||
- View methodology skills
|
||||
- Apply to project
|
||||
- Track adoption
|
||||
|
||||
### Plan (n)
|
||||
Structured plan system:
|
||||
- Parse plan files
|
||||
- Validate plan structure
|
||||
- Execute plans step-by-step
|
||||
- Track progress
|
||||
|
||||
### Recommend (r)
|
||||
AI-powered skill suggestions based on your project:
|
||||
- Analyzes your package.json, configs, and file structure
|
||||
@@ -63,7 +112,14 @@ View and manage project context:
|
||||
- Installed agents
|
||||
- Sync context to all agents
|
||||
|
||||
### Installed (l)
|
||||
### Memory (e)
|
||||
Session memory system:
|
||||
- View learnings
|
||||
- Search past sessions
|
||||
- Compress observations
|
||||
- Export as skills
|
||||
|
||||
### Installed (i)
|
||||
Manage your installed skills:
|
||||
- View all installed skills
|
||||
- Enable/disable skills
|
||||
@@ -87,17 +143,24 @@ Configure SkillKit:
|
||||
| Key | Action |
|
||||
|-----|--------|
|
||||
| `h` | Home screen |
|
||||
| `m` | Marketplace |
|
||||
| `b` | Browse skills |
|
||||
| `w` | Workflows |
|
||||
| `x` | Execute |
|
||||
| `a` | Team collaboration |
|
||||
| `p` | Plugins |
|
||||
| `o` | Methodology |
|
||||
| `n` | Plan system |
|
||||
| `r` | Recommendations |
|
||||
| `t` | Translate skills |
|
||||
| `c` | Context management |
|
||||
| `l` | List installed |
|
||||
| `e` | Memory/Learnings |
|
||||
| `i` | Installed skills |
|
||||
| `s` | Sync skills |
|
||||
| `,` | Settings |
|
||||
| `↑/↓` | Navigate lists |
|
||||
| `Enter` | Select / Confirm |
|
||||
| `/` | Search |
|
||||
| `m` | Multi-select mode |
|
||||
| `Tab` | Switch focus |
|
||||
| `Esc` | Go back |
|
||||
| `?` | Help |
|
||||
|
||||
Reference in New Issue
Block a user