mirror of
https://github.com/rohitg00/skillkit.git
synced 2026-11-19 02:13:58 +00:00
docs: add README files to all packages
This commit is contained in:
@@ -0,0 +1,41 @@
|
||||
# SkillKit
|
||||
|
||||
Universal skills manager for AI coding agents. Install, manage, and sync skills across 17+ 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 a skill
|
||||
skillkit install github.com/anthropics/courses:prompt-eng/interactive-tutorial
|
||||
|
||||
# List installed skills
|
||||
skillkit list
|
||||
|
||||
# Launch interactive TUI
|
||||
skillkit ui
|
||||
```
|
||||
|
||||
## 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
|
||||
|
||||
## Documentation
|
||||
|
||||
Full documentation: https://github.com/rohitg00/skillkit
|
||||
|
||||
## License
|
||||
|
||||
Apache-2.0
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "skillkit",
|
||||
"version": "1.3.0",
|
||||
"version": "1.3.1",
|
||||
"description": "Universal skills loader for AI coding agents - supports Claude Code, Codex, Cursor, Antigravity, OpenCode, Gemini CLI and more",
|
||||
"type": "module",
|
||||
"bin": {
|
||||
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "skillkit-monorepo",
|
||||
"version": "1.3.0",
|
||||
"version": "1.3.1",
|
||||
"private": true,
|
||||
"description": "Universal skills loader for AI coding agents - Monorepo",
|
||||
"type": "module",
|
||||
|
||||
@@ -0,0 +1,53 @@
|
||||
# @skillkit/agents
|
||||
|
||||
Agent adapters for SkillKit - supports 17+ AI coding agents.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npm install @skillkit/agents
|
||||
```
|
||||
|
||||
## Supported Agents
|
||||
|
||||
| Agent | Config Format | Skills Directory |
|
||||
|-------|--------------|------------------|
|
||||
| Claude Code | SKILL.md | `.claude/skills/` |
|
||||
| Cursor | .cursorrules, .mdc | `.cursor/skills/` |
|
||||
| Codex | SKILL.md | `.codex/skills/` |
|
||||
| Gemini CLI | SKILL.md | `.gemini/skills/` |
|
||||
| Windsurf | .windsurfrules | `.windsurf/skills/` |
|
||||
| GitHub Copilot | Markdown | `.github/copilot-instructions.md` |
|
||||
| OpenCode | SKILL.md | `.opencode/skills/` |
|
||||
| Antigravity | SKILL.md | `.antigravity/skills/` |
|
||||
| Amp | SKILL.md | `.amp/skills/` |
|
||||
| Goose | SKILL.md | `.goose/skills/` |
|
||||
| Kilo | SKILL.md | `.kilocode/skills/` |
|
||||
| Roo | SKILL.md | `.roo/skills/` |
|
||||
| Trae | SKILL.md | `.trae/skills/` |
|
||||
| And more... | | |
|
||||
|
||||
## Usage
|
||||
|
||||
```typescript
|
||||
import { getAdapter, detectAgent, listAdapters } from '@skillkit/agents';
|
||||
|
||||
// Get adapter for specific agent
|
||||
const adapter = getAdapter('claude-code');
|
||||
console.log(adapter.skillsDir); // .claude/skills/
|
||||
|
||||
// Detect installed agents
|
||||
const detected = detectAgent();
|
||||
console.log(detected); // ['claude-code', 'cursor']
|
||||
|
||||
// List all available adapters
|
||||
const adapters = listAdapters();
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
Full documentation: https://github.com/rohitg00/skillkit
|
||||
|
||||
## License
|
||||
|
||||
Apache-2.0
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@skillkit/agents",
|
||||
"version": "1.3.0",
|
||||
"version": "1.3.1",
|
||||
"description": "Agent adapters for SkillKit - supports 17+ AI coding agents",
|
||||
"type": "module",
|
||||
"main": "./dist/index.js",
|
||||
|
||||
@@ -0,0 +1,43 @@
|
||||
# @skillkit/cli
|
||||
|
||||
CLI commands for SkillKit - install, manage, and sync skills across AI agents.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npm install @skillkit/cli
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
```bash
|
||||
skillkit init # Initialize skillkit in project
|
||||
skillkit install <skill> # Install a skill
|
||||
skillkit remove <skill> # Remove a skill
|
||||
skillkit list # List installed skills
|
||||
skillkit update # Update installed skills
|
||||
skillkit sync # Sync skills across agents
|
||||
skillkit translate # Translate skills between formats
|
||||
skillkit recommend # Get skill recommendations
|
||||
skillkit context # Manage project context
|
||||
skillkit ui # Launch interactive TUI
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```typescript
|
||||
import { installCommand, listCommand, syncCommand } from '@skillkit/cli';
|
||||
|
||||
// Programmatic access to CLI commands
|
||||
await installCommand('github.com/owner/repo:skill-name');
|
||||
await listCommand();
|
||||
await syncCommand({ all: true });
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
Full documentation: https://github.com/rohitg00/skillkit
|
||||
|
||||
## License
|
||||
|
||||
Apache-2.0
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@skillkit/cli",
|
||||
"version": "1.3.0",
|
||||
"version": "1.3.1",
|
||||
"description": "CLI commands for SkillKit",
|
||||
"type": "module",
|
||||
"main": "./dist/index.js",
|
||||
|
||||
@@ -0,0 +1,47 @@
|
||||
# @skillkit/core
|
||||
|
||||
Core functionality for SkillKit - skill discovery, parsing, translation, and context management.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npm install @skillkit/core
|
||||
```
|
||||
|
||||
## Features
|
||||
|
||||
- **Skill Discovery**: Find and parse SKILL.md files
|
||||
- **Skill Translation**: Convert between agent formats (Claude Code, Cursor, Windsurf, etc.)
|
||||
- **Project Context Detection**: Analyze project stack and dependencies
|
||||
- **Recommendation Engine**: Smart skill suggestions based on project profile
|
||||
|
||||
## Usage
|
||||
|
||||
```typescript
|
||||
import {
|
||||
loadConfig,
|
||||
getSearchDirs,
|
||||
translateSkill,
|
||||
ProjectDetector,
|
||||
RecommendationEngine
|
||||
} from '@skillkit/core';
|
||||
|
||||
// Load skillkit config
|
||||
const config = loadConfig();
|
||||
|
||||
// Detect project context
|
||||
const detector = new ProjectDetector();
|
||||
const profile = await detector.analyze('./my-project');
|
||||
|
||||
// Get skill recommendations
|
||||
const engine = new RecommendationEngine();
|
||||
const recommendations = await engine.recommend(profile);
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
Full documentation: https://github.com/rohitg00/skillkit
|
||||
|
||||
## License
|
||||
|
||||
Apache-2.0
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@skillkit/core",
|
||||
"version": "1.3.0",
|
||||
"version": "1.3.1",
|
||||
"description": "Core functionality for SkillKit - skill discovery, parsing, and translation",
|
||||
"type": "module",
|
||||
"main": "./dist/index.js",
|
||||
|
||||
@@ -0,0 +1,61 @@
|
||||
# @skillkit/tui
|
||||
|
||||
Interactive terminal UI for SkillKit - browse, install, and manage skills visually.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npm install @skillkit/tui
|
||||
```
|
||||
|
||||
## Features
|
||||
|
||||
- **Browse Skills**: Discover skills from the marketplace
|
||||
- **Smart Recommendations**: Project-aware skill suggestions
|
||||
- **Skill Translation**: Convert between agent formats
|
||||
- **Context Management**: View and sync project context
|
||||
- **Keyboard Navigation**: Fast, intuitive controls
|
||||
|
||||
## Usage
|
||||
|
||||
```typescript
|
||||
import { startTUI } from '@skillkit/tui';
|
||||
|
||||
// Launch the interactive TUI
|
||||
await startTUI();
|
||||
```
|
||||
|
||||
Or via CLI:
|
||||
|
||||
```bash
|
||||
skillkit ui
|
||||
```
|
||||
|
||||
## Screens
|
||||
|
||||
- **Home**: Overview and quick actions
|
||||
- **Browse**: Explore available skills
|
||||
- **Recommend**: Get personalized recommendations
|
||||
- **Translate**: Convert skills between formats
|
||||
- **Context**: Manage project context
|
||||
- **Installed**: View and manage installed skills
|
||||
- **Sync**: Sync skills across agents
|
||||
- **Settings**: Configure skillkit
|
||||
|
||||
## Keyboard Shortcuts
|
||||
|
||||
| Key | Action |
|
||||
|-----|--------|
|
||||
| `↑/↓` | Navigate |
|
||||
| `Enter` | Select |
|
||||
| `Tab` | Switch focus |
|
||||
| `?` | Help |
|
||||
| `q` | Quit |
|
||||
|
||||
## Documentation
|
||||
|
||||
Full documentation: https://github.com/rohitg00/skillkit
|
||||
|
||||
## License
|
||||
|
||||
Apache-2.0
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@skillkit/tui",
|
||||
"version": "1.3.0",
|
||||
"version": "1.3.1",
|
||||
"description": "Terminal UI for SkillKit",
|
||||
"type": "module",
|
||||
"main": "./dist/index.js",
|
||||
|
||||
Reference in New Issue
Block a user