Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Skill Agent - 可插拔技能系统

展示 KODE SDK 的 SkillsManager + SKILL.md 技能包 能力。

功能特点

  • 技能是 Markdown 格式的指令包(SKILL.md)
  • 使用 SkillsManager 自动扫描和加载技能
  • 运行时动态激活技能,注入到对话上下文
  • 支持同时激活多个技能
  • 完全可插拔:用户可自定义技能,当前示例仅供演示

典型使用场景

技能系统的核心价值是将专业知识封装成可复用的指令包。以下是可以自定义技能的场景:

1. 团队规范沉淀

将团队约定打包成技能:

  • Git 提交规范(Conventional Commits)
  • 代码审查检查清单
  • PR 模板和评审流程
  • 项目目录结构规范

2. 运维操作手册

将复杂操作标准化:

  • 数据库备份恢复流程
  • 服务器部署检查清单
  • 故障排查步骤
  • 监控告警处理流程

3. 开发模式库

常用开发模式的指南:

  • 设计模式实现模板
  • 错误处理最佳实践
  • 性能优化检查清单
  • 安全编码规范

4. 项目专属知识

针对具体项目的技能:

  • 项目架构说明
  • API 调用约定
  • 业务逻辑规则
  • 第三方服务集成指南

如何扩展

只需在 skills/ 目录下添加 SKILL.md 文件即可:

skills/
├── my-team/
│   ├── code-style/SKILL.md      # 你的代码风格规范
│   └── deploy-checklist/SKILL.md # 你的部署检查清单
└── my-project/
    └── api-guide/SKILL.md        # 你的 API 使用指南

与普通 Prompt 的区别

普通 Prompt Skill 技能
每次重复编写 一次编写复用
格式不统一 结构化 Markdown
难以维护 版本控制友好
个人使用 团队共享

什么是 Skill?

Skill 是基于 Markdown 的知识包,包含:

  • 最佳实践和工作流程
  • 命令模板和示例
  • 检查清单和注意事项
skills/
├── git/
│   ├── using-git-worktrees/
│   │   └── SKILL.md          # Git Worktree 使用指南
│   └── commit-message-guide/
│       └── SKILL.md          # 提交信息规范
└── project/
    ├── dependency-analysis/
    │   └── SKILL.md          # 依赖分析指南
    └── code-review/
        └── SKILL.md          # 代码审查清单

快速开始

# 全局安装
npm install -g @shareai-lab/sdk-demo-skill-agent

# 首次运行(自动进入交互式配置)
skill-agent

# 重新配置
skill-agent config

配置说明

  • 全局配置:~/.config/shareai-sdk-demos/skill-agent/config.json
  • 本地数据:./.sdk-demo-skill-agent/(与当前目录绑定)
  • 兼容 .env:仍支持 ANTHROPIC_API_KEY / OPENAI_API_KEY / GEMINI_API_KEY

清理配置:

skill-agent config clean

使用方式

命令

命令 说明
skills 列出所有可用技能
use <name> 激活指定技能
active 查看已激活的技能
exit 退出程序

示例

💬 你: skills

📦 可用技能:

  - using-git-worktrees
    使用 Git Worktree 创建隔离的工作空间

  - commit-message-guide
    编写清晰、规范的 Git 提交信息

  - dependency-analysis
    分析项目依赖关系

  - code-review
    系统性地进行代码审查

💬 你: use code-review

✅ 已激活技能: code-review
📄 技能路径: ./skills/project/code-review/SKILL.md

🔧 调用工具: (none - skill content injected)

好的,我已经加载了代码审查技能。我现在可以按照系统化的审查方法
帮你进行代码审查,包括功能正确性、代码质量、安全性等多个维度。

需要我帮你审查什么代码?

💬 你: 帮我审查 src/auth.ts 这个文件

(Agent 按照 code-review 技能中的检查清单进行审查...)

包含的技能

Git 技能

技能 说明
using-git-worktrees Git Worktree 创建和管理
commit-message-guide Conventional Commits 规范

Project 技能

技能 说明
dependency-analysis npm/pip/go 依赖分析
code-review 代码审查检查清单

创建新技能

  1. skills/<category>/<skill-name>/ 创建目录
  2. 添加 SKILL.md 文件:
---
name: my-skill
description: 技能的简短描述
---

# 技能标题

## 概述
技能的详细说明...

## 工作流程
1. 步骤一
2. 步骤二

## 命令模板
```bash
some-command --flag

注意事项

  • 注意点一
  • 注意点二

3. 重启程序,新技能会自动被扫描到

## 环境变量

| 变量 | 说明 | 默认值 |
|------|------|--------|
| `ANTHROPIC_API_KEY` | Anthropic API 密钥 | - |
| `OPENAI_API_KEY` | OpenAI API 密钥 | - |
| `GEMINI_API_KEY` | Gemini API 密钥 | - |
| `SKILLS_DIR` | 技能目录路径 | `./skills` |

> **注意**:Agent 可以读取项目中任何文件,但写操作只会发生在本地工作目录中,避免污染项目源码。

## 数据存储

./.sdk-demo-skill-agent/ ├── data/ └── workspace/


## 核心代码

- `skills/` - SKILL.md 技能包目录
- `src/template.ts` - Agent 模板
- `src/restricted-tools.ts` - 受限文件工具
- `src/commands/run.ts` - SkillsManager 集成和技能激活逻辑
- `src/cli.ts` - CLI 入口

## 卸载

```bash
skill-agent clean
skill-agent config clean
npm uninstall -g @shareai-lab/sdk-demo-skill-agent