Skip to content

Commit 53f895b

Browse files
author
xuhongbin
committed
docs: normalize documentation, rename to EMP Skills and setup skills hub
1 parent 69609d7 commit 53f895b

File tree

16 files changed

+591
-37
lines changed

16 files changed

+591
-37
lines changed

DOCUMENTATION_INDEX.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ emp-skill/
3333
│ │ ├── IMPLEMENTATION.md # 实现指南
3434
│ │ └── PROJECT_SUMMARY.md # 项目总结
3535
│ └── website/ # 📄 静态网站
36-
├── skill-recomend.md # 💡 技能推荐文档
36+
├── SKILL_RECOMMENDATION.md # 💡 技能推荐文档
3737
├── DOCUMENTATION_INDEX.md # 🗂️ 文档索引
3838
├── README.md # 🏠 项目总览
3939
├── package.json
@@ -65,7 +65,7 @@ emp-skill/
6565
|------|------|------|
6666
| 实现指南 | [apps/web/IMPLEMENTATION.md](./apps/web/IMPLEMENTATION.md) | 详细实现步骤 |
6767
| 项目总结 | [apps/web/PROJECT_SUMMARY.md](./apps/web/PROJECT_SUMMARY.md) | 项目架构总结 |
68-
| 技能推荐 | [skill-recomend.md](./skill-recomend.md) | 技能推荐文档 |
68+
| 技能推荐 | [SKILL_RECOMMENDATION.md](./SKILL_RECOMMENDATION.md) | 技能推荐文档 |
6969

7070
## 🎯 按用户角色查找文档
7171

@@ -151,19 +151,19 @@ Web 浏览 → Web 平台 (docs/WEB_PLATFORM.md)
151151
## 🤝 反馈渠道
152152

153153
### 文档问题
154-
- **GitHub Issues**: https://github.com/emp/skill/issues
154+
- **GitHub Issues**: https://github.com/empjs/skill/issues
155155
- **标签**: `documentation`
156156

157157
### 改进建议
158-
- **GitHub Discussions**: https://github.com/emp/skill/discussions
158+
- **GitHub Discussions**: https://github.com/empjs/skill/discussions
159159
- **分类**: `Documentation`
160160

161161
## 📞 联系我们
162162

163-
- **项目主页**: https://emp-skill.com
164-
- **GitHub 仓库**: https://github.com/emp/skill
163+
- **项目主页**: https://skill.empjs.dev
164+
- **GitHub 仓库**: https://github.com/empjs/skill
165165
- **Discord 社区**: https://discord.gg/emp-skill
166-
- **邮箱**: team@emp-skill.com
166+
- **邮箱**: team@skill.empjs.dev
167167

168168
---
169169

README.md

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# @empjs/skill - Unified AI Agent Skill Hub
2+
3+
[![NPM Version](https://img.shields.io/npm/v/@empjs/skill.svg)](https://www.npmjs.com/package/@empjs/skill)
4+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5+
6+
The Enterprise Distribution Hub for AI Agent Skills. Securely bridge your internal engineering standards with AI Agents (Claude, Cursor, Windsurf, and more).
7+
8+
## 🚀 Overview
9+
10+
`@empjs/skill` is a unified CLI tool and platform designed to manage, distribute, and trace AI agent skills across multiple platforms. It solves the fragmentation of skill management by providing a centralized hub for all your agent extensions.
11+
12+
- **Unified Registry**: Centralized skill management in `~/.emp-agent/skills/`.
13+
- **18+ Agents Supported**: Auto-detects and links to Claude Code, Cursor, Windsurf, Trae, Gemini, and more.
14+
- **Smart Distribution**: Zero manual path configuration.
15+
- **Private Repo Support**: Seamless integration with private GitLab/GitHub repositories.
16+
- **B2B On-demand**: Monorepo support for project-specific skill installation.
17+
18+
## 📦 Supported AI Agents
19+
20+
The platform automatically detects and supports:
21+
22+
- **Claude Code** (`~/.claude/skills/`)
23+
- **Cursor** (`~/.cursor/skills/`)
24+
- **Windsurf** (`~/.windsurf/skills/`)
25+
- **Trae** (`~/.trae/skills/`)
26+
- **Gemini** (`~/.gemini/skills/`)
27+
- **Cline**, **Roo Code**, **Goose**, **AMP**, and many more.
28+
29+
## 🛠️ Installation
30+
31+
```bash
32+
# Using pnpm (recommended)
33+
pnpm add -g @empjs/skill
34+
35+
# Using npm
36+
npm install -g @empjs/skill
37+
```
38+
39+
## 📖 Quick Start
40+
41+
### Install a Skill
42+
```bash
43+
# Install from NPM
44+
eskill install @empjs/skill-example
45+
46+
# Install from Git URL (GitHub/GitLab)
47+
eskill install https://github.com/empjs/skill/tree/main/packages/yapi-mock-data
48+
```
49+
50+
### List Skills
51+
```bash
52+
eskill list
53+
```
54+
55+
### Dev Mode
56+
```bash
57+
cd path/to/your-skill
58+
eskill install . --link
59+
```
60+
61+
## 📁 Project Structure
62+
63+
- `apps/website`: The official website (built with Vite + Tailwind).
64+
- `packages/eskill`: The core CLI tool.
65+
- `packages/yapi-mock-data`: An example skill package.
66+
- `docs/`: Comprehensive documentation.
67+
- `skills/`: Skill definitions and templates.
68+
69+
## 📚 Documentation
70+
71+
For more detailed information, please refer to our documentation:
72+
73+
- [Documentation Index](./DOCUMENTATION_INDEX.md)
74+
- [CLI Guide](./docs/CLI_GUIDE.md)
75+
- [Architecture](./docs/ARCHITECTURE.md)
76+
- [Web Platform](./docs/WEB_PLATFORM.md)
77+
- [Deployment](./docs/DEPLOYMENT.md)
78+
- [Contribution Guide](./docs/CONTRIBUTION.md)
79+
80+
## 🤝 Contributing
81+
82+
We welcome contributions! Please see our [Contributing Guide](./docs/CONTRIBUTION.md) for more details.
83+
84+
## 📄 License
85+
86+
© 2026 EMP Team. Licensed under the [MIT License](./LICENSE).
87+
88+
## 🔗 Links
89+
90+
- **Repository**: [https://github.com/empjs/skill](https://github.com/empjs/skill)
91+
- **Website**: [https://skill.empjs.dev](https://skill.empjs.dev) (Hosted on Cloudflare)

SKILL.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# 🚀 AI Agent Skills Guide
2+
3+
This project provides a unified hub for managing AI Agent skills. Skills are stored in the `skills/` directory and can be installed via the `eskill` CLI.
4+
5+
## 📂 Skill Directory Structure
6+
7+
Skills should be organized within the `skills/` folder:
8+
9+
```
10+
skills/
11+
├── your-skill-name/
12+
│ ├── SKILL.md # Core skill definition
13+
│ └── ... # Supporting files
14+
└── TEMPLATE.md # Template for new skills
15+
```
16+
17+
## 📝 Defining a Skill
18+
19+
A skill is defined by a `SKILL.md` file with frontmatter metadata:
20+
21+
```markdown
22+
---
23+
name: my-awesome-skill
24+
description: "Does something amazing"
25+
version: "1.0.0"
26+
---
27+
28+
# My Awesome Skill
29+
30+
Detailed instructions for the AI Agent...
31+
```
32+
33+
## 🛠️ Usage
34+
35+
To install a skill locally for development:
36+
37+
```bash
38+
eskill install ./skills/your-skill-name --link
39+
```
40+
41+
To install a skill from the repository:
42+
43+
```bash
44+
eskill install https://github.com/empjs/skill/tree/main/skills/your-skill-name
45+
```
46+
47+
## 🌟 Best Practices
48+
49+
- Keep skill definitions focused and concise.
50+
- Provide clear examples of how the agent should use the skill.
51+
- Use versioning to manage changes.
52+
- Test your skills across multiple agents (Claude, Cursor, Windsurf, etc.).

0 commit comments

Comments
 (0)