Files
skillkit/packages/agents/README.md
Rohit Ghumare d1fcf0355f docs: add comprehensive documentation section to website (#23)
* docs: add comprehensive documentation section to website

- Create Documentation.tsx component with DeepWiki-sourced content
- Add sections: Overview, Installation, Architecture, Agents, Commands
- Add sections: Configuration, API Reference, Skill Format, Tech Stack
- Include interactive sidebar navigation
- Add Docs link to navbar
- Reference DeepWiki as documentation source

Source: https://deepwiki.com/rohitg00/skillkit

* feat(docs): add Fumadocs documentation site and update website

- Add Fumadocs-based documentation site at /docs
  - Complete MDX documentation for all features
  - TUI section with keyboard navigation
  - Installation, quickstart, commands reference
  - API reference and configuration guides

- Update SkillKit website (agentskills.com)
  - Add 15 new agents (32 total): CodeBuddy, Continue, Crush,
    Factory, MCPJam, Mux, Neovate, OpenHands, Pi, Qoder, Qwen,
    Vercel, Zencoder, CommandCode
  - Update agent count from 17 to 32 across all components
  - Update command count from 30+ to 40+
  - Remove inline Documentation section (now in Fumadocs)
  - Link Docs to /docs route

- Add 15 new agent adapters to @skillkit/agents
  - All use UniversalAdapter as base
  - Added to detection order and adapter registry

- Configure Vercel rewrites for /docs proxy to Fumadocs

* fix: resolve TypeScript build errors in fumadocs

- Remove createRelativeLink from docs page (not compatible with current fumadocs)
- Remove redundant isLoading prop in SkillGenerator (status already narrowed)
- Fix lucide-react icon type casting in Card component
- Fix MDXComponents return type in mdx-components

* fix: resolve /docs 404 and show docs link on mobile

- Handle undefined slug by defaulting to empty array for index page
- Remove hidden class from Docs link so it shows on mobile

* fix: address CodeRabbit review suggestions

- Move Gemini API key to server-side route (security)
- Add default type='button' to Button component
- Use dynamic agent count instead of hardcoded 32
- Add 'use client' directive to Documentation
- Fix stale closure in SkillSubmitForm with useCallback
- Add URL validation for external references
- Add noopener to external links for security
- Fix Clawdbot path in agents.mdx
- Update cicd.mdx with correct CLI commands
- Capitalize proper nouns (Markdown, provider names)
- Add text language to README code block
- Update date example in quickstart.mdx

* fix: add noopener to external links and improve nav accessibility

- Add noopener to rel attributes on external links for tabnabbing protection
- Add aria-label to nav element for screen readers
- Add type="button" and aria-current to nav buttons

* fix: add vercel.json for fumadocs deployment

* fix: disable turbo detection in Vercel deployment

* fix: clean up ASCII logo for better rendering

* fix: improve code block contrast in SkillGenerator

* fix: sync ASCII logo and code block contrast fixes to old Vite components

* fix: improve mobile responsiveness for tabs and header buttons

* fix: address CodeRabbit security and code quality suggestions

- Add rate limiting to API route (10 requests/min per IP)
- Add proper type validation for topic parameter
- Move API key check after input validation
- Add 'use client' directive to SkillGenerator
- Add YAML escape helper to prevent frontmatter injection
- Change vercel.json to use pnpm instead of npm
2026-01-28 18:29:14 +00:00

237 lines
5.8 KiB
Markdown

# @skillkit/agents
[![npm version](https://img.shields.io/npm/v/@skillkit/agents.svg)](https://www.npmjs.com/package/@skillkit/agents)
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
**Agent adapters for SkillKit** - configuration and detection for 32 AI coding agents.
## Installation
```bash
npm install @skillkit/agents
```
## Supported Agents (32)
| Agent | Config Format | Project Skills | Global Skills |
|-------|--------------|----------------|---------------|
| Claude Code | SKILL.md | `.claude/skills/` | `~/.claude/skills/` |
| Cursor | MDC (.mdc) | `.cursor/skills/` | `~/.cursor/skills/` |
| Codex | SKILL.md | `.codex/skills/` | `~/.codex/skills/` |
| Gemini CLI | SKILL.md | `.gemini/skills/` | `~/.gemini/skills/` |
| OpenCode | SKILL.md | `.opencode/skills/` | `~/.config/opencode/skills/` |
| Antigravity | SKILL.md | `.antigravity/skills/` | - |
| Amp | SKILL.md | `.amp/skills/` | - |
| Clawdbot | SKILL.md | `.clawdbot/skills/` | - |
| Cline | SKILL.md | `.cline/skills/` | - |
| CodeBuddy | SKILL.md | `.codebuddy/skills/` | - |
| CommandCode | SKILL.md | `.commandcode/skills/` | - |
| Continue | SKILL.md | `.continue/skills/` | `~/.continue/skills/` |
| Crush | SKILL.md | `.crush/skills/` | - |
| Droid (Factory) | SKILL.md | `.factory/skills/` | - |
| Factory | SKILL.md | `.factory/skills/` | - |
| GitHub Copilot | Markdown | `.github/skills/` | - |
| Goose | SKILL.md | `.goose/skills/` | `~/.goose/skills/` |
| Kilo Code | SKILL.md | `.kilocode/skills/` | `~/.kilocode/skills/` |
| Kiro CLI | SKILL.md | `.kiro/skills/` | `~/.kiro/skills/` |
| MCPJam | SKILL.md | `.mcpjam/skills/` | - |
| Mux | SKILL.md | `.mux/skills/` | - |
| Neovate | SKILL.md | `.neovate/skills/` | - |
| OpenHands | SKILL.md | `.openhands/skills/` | - |
| Pi | SKILL.md | `.pi/skills/` | - |
| Qoder | SKILL.md | `.qoder/skills/` | - |
| Qwen | SKILL.md | `.qwen/skills/` | - |
| Roo Code | SKILL.md | `.roo/skills/` | `~/.roo/skills/` |
| Trae | SKILL.md | `.trae/skills/` | - |
| Vercel | SKILL.md | `.vercel/skills/` | - |
| Windsurf | Markdown | `.windsurf/skills/` | `~/.codeium/windsurf/skills/` |
| Zencoder | SKILL.md | `.zencoder/skills/` | - |
| Universal | SKILL.md | `skills/` | - |
## Usage
### Get Agent Adapter
```typescript
import { getAdapter, AgentType } from '@skillkit/agents';
// Get adapter for specific agent
const adapter = getAdapter('claude-code');
console.log(adapter.name); // 'claude-code'
console.log(adapter.skillsDir); // '.claude/skills/'
console.log(adapter.globalSkillsDir); // '~/.claude/skills/'
console.log(adapter.configFile); // 'AGENTS.md'
console.log(adapter.format); // 'skill-md'
```
### Detect Installed Agents
```typescript
import { detectAgent, detectAllAgents } from '@skillkit/agents';
// Detect primary agent in current directory
const primary = await detectAgent();
console.log(primary); // 'claude-code'
// Detect all installed agents
const all = await detectAllAgents();
console.log(all); // ['claude-code', 'cursor', 'windsurf']
// Detect in specific directory
const agents = await detectAllAgents('./my-project');
```
### List All Adapters
```typescript
import { listAdapters, getAdapterNames } from '@skillkit/agents';
// Get all adapter configurations
const adapters = listAdapters();
adapters.forEach(adapter => {
console.log(`${adapter.name}: ${adapter.skillsDir}`);
});
// Get just the names
const names = getAdapterNames();
console.log(names); // ['claude-code', 'cursor', 'codex', ...]
```
### Generate Agent Config
```typescript
import { getAdapter } from '@skillkit/agents';
import { findAllSkills } from '@skillkit/core';
const adapter = getAdapter('cursor');
const skills = findAllSkills([adapter.skillsDir]);
// Generate config file content
const config = adapter.generateConfig(skills);
console.log(config);
```
### Get Skills Directory
```typescript
import { getAdapter } from '@skillkit/agents';
import { homedir } from 'os';
const adapter = getAdapter('claude-code');
// Project-local skills directory
const projectDir = adapter.skillsDir; // '.claude/skills/'
// Global skills directory
const globalDir = adapter.globalSkillsDir.replace('~', homedir());
// '/Users/you/.claude/skills/'
```
## Adapter Interface
```typescript
interface AgentAdapter {
// Agent identifier
name: AgentType;
// Display name
displayName: string;
// Skill file format
format: 'skill-md' | 'mdc' | 'markdown';
// Project skills directory (relative)
skillsDir: string;
// Global skills directory (with ~)
globalSkillsDir: string;
// Config file name
configFile: string;
// Generate config from skills
generateConfig(skills: Skill[]): string;
// Parse existing config
parseConfig(content: string): Skill[];
}
```
## Agent Types
```typescript
type AgentType =
| 'claude-code'
| 'cursor'
| 'codex'
| 'gemini-cli'
| 'opencode'
| 'antigravity'
| 'amp'
| 'clawdbot'
| 'cline'
| 'codebuddy'
| 'commandcode'
| 'continue'
| 'crush'
| 'droid'
| 'factory'
| 'github-copilot'
| 'goose'
| 'kilo'
| 'kiro-cli'
| 'mcpjam'
| 'mux'
| 'neovate'
| 'openhands'
| 'pi'
| 'qoder'
| 'qwen'
| 'roo'
| 'trae'
| 'vercel'
| 'windsurf'
| 'zencoder'
| 'universal';
```
## Format Details
### SKILL.md Format
Used by most agents. YAML frontmatter + Markdown content:
```markdown
---
name: my-skill
description: What this skill does
---
# My Skill
Instructions...
```
### MDC Format (Cursor)
Cursor-specific format with globs and alwaysApply:
```
---
description: What this skill does
globs: ["**/*.tsx"]
alwaysApply: false
---
Instructions...
```
### Markdown Format
Plain markdown used by Windsurf and Copilot:
```markdown
# Skill Name
Instructions for the agent...
```
## Documentation
Full documentation: https://github.com/rohitg00/skillkit
## License
Apache-2.0