upx-cli
v1.2.0
Published
A CLI tool to manage AI editor prompts, rules, and skills from GitHub
Maintainers
Readme
English Version
upx-cli
一个用于从 GitHub 管理 AI 编辑器 prompts、rules 和 skills 的命令行工具。
功能特色
- 🚀 资源零依赖 npm —— 直接从 GitHub 获取 rules、prompts 和 skills
- 🔄 多编辑器支持 —— 同时适用于 VS Code(Copilot)、Cursor、Trae、Claude Code、Windsurf 和 Antigravity
- ⚙️ 可配置资源源 —— 可指定任意 GitHub 仓库作为资源源
- 📦 交互式选择 —— 通过直观界面精准选择所需资源
安装
# 全局安装(npm)
npm i -g upx-cli
# 或使用 pnpm
pnpm add -g upx-cli快速开始
# 1. 配置你的 GitHub 仓库资源源
upx config set repo https://github.com/your-username/your-repo
# 2. 列出可用资源
upx list
# 3. 添加资源到你的项目
upx add命令说明
upx config
管理 upx 配置。
# 查看当前配置
upx config get
# 设置 GitHub 仓库地址
upx config set repo https://github.com/your-username/your-repo
# 恢复默认配置
upx config resetupx list
从已配置仓库列出可用资源。
# 列出所有资源
upx list
# 列出指定类型
upx list rules
upx list prompts
upx list skillsupx add
将 rules、prompts 或 skills 添加到当前项目。
# 交互模式(推荐)
upx add
# 指定类型
upx add rules
upx add prompts
upx add skills
# 指定类型和编辑器
upx add rules copilot
upx add prompts cursor
upx add rules trae
upx add rules claude
upx add prompts windsurf
upx add rules antigravity
# 覆盖已存在文件
upx add rules cursor --overwrite仓库结构
你的 GitHub 仓库应遵循如下结构:
your-repo/
├── rules/
│ └── <rule-name>/
│ └──RULES.md # 必需:规则内容
├── prompts/
│ └── <prompt-name>/
│ └──PROMPT.md # 必需:提示内容
└── skills/
└── <skill-name>/
└── SKILL.md # 必需:技能内容目标路径
VS Code(Copilot)
| 类型 | 目标路径 |
| ------- | --------------------------------------------- |
| Rules | .github/instructions/<name>.instructions.md |
| Prompts | .github/prompts/<name>.prompt.md |
| Skills | .github/skills/<name>/SKILL.md |
Cursor
| 类型 | 目标路径 |
| ------------------- | -------------------------------- |
| Rules | .cursor/rules/<name>.md |
| Prompts(Commands) | .cursor/commands/<name>.md |
| Skills | .cursor/skills/<name>/SKILL.md |
Trae
| 类型 | 目标路径 |
| ------ | -------------------------- |
| Rules | .trae/rules/<name>.md |
| Prompts | .trae/rules/<name>.md * |
| Skills | .trae/skills/<name>/SKILL.md |
*Trae 不支持 Prompts,已映射为 Rules。
Claude Code
| 类型 | 目标路径 |
| ------ | ------------------------------- |
| Rules | CLAUDE.md |
| Prompts | .claude/commands/<name>.md |
| Skills | .claude/skills/<name>/SKILL.md |
Windsurf
| 类型 | 目标路径 |
| ------ | -------------------------------- |
| Rules | .windsurf/rules/<name>.md |
| Prompts | .windsurf/prompts/<name>.md |
| Skills | .windsurf/skills/<name>/SKILL.md |
Antigravity
| 类型 | 目标路径 |
| ------ | ------------------------------ |
| Rules | .agent/rules/<name>.md |
| Prompts | .agent/rules/<name>.md * |
| Skills | .agent/skills/<name>/SKILL.md |
*Antigravity 不支持 Prompts/Commands,已映射为 Rules。
示例
向 Cursor 添加 Flutter 规则
$ upx add rules cursor
? 选择要添加的规则:
◯ flutter
◯ react
◯ typescript
✓ 成功安装:
• flutter
→ .cursor/rules/flutter.md向 VS Code Copilot 添加技能
$ upx add skills copilot
? 选择要添加的技能:
◯ frontend-design
◯ api-testing
✓ 成功安装:
• frontend-design
→ .github/skills/frontend-design/SKILL.md
### 向 Trae 添加 Prompts(会映射为 Rules)
```bash
$ upx add prompts trae
? 选择要添加的 prompts:
◯ git-commit
◯ fix-issue
✓ 成功安装:
• git-commit
→ .trae/rules/git-commit.md向 Claude Code 添加 Rules
$ upx add rules claude
? 选择要添加的规则:
◯ typescript
◯ git
✓ 成功安装:
• typescript
→ CLAUDE.md
### 向 Windsurf 添加 Prompts
```bash
$ upx add prompts windsurf
? 选择要添加的 prompts:
◯ git-commit
◯ fix-issue
✓ 成功安装:
• git-commit
→ .windsurf/prompts/git-commit.md
### 向 Antigravity 添加 Prompts(会映射为 Rules)
```bash
$ upx add prompts antigravity
? 选择要添加的 prompts:
◯ git-commit
◯ fix-issue
✓ 成功安装:
• git-commit
→ .agent/rules/git-commit.md向 Trae 添加 Prompts(会映射为 Rules)
$ upx add prompts trae
? 选择要添加的 prompts:
◯ git-commit
◯ fix-issue
✓ 成功安装:
• git-commit
→ .trae/rules/git-commit.md
## 开发
```bash
# 克隆仓库
git clone https://github.com/ventupx/upx-cli.git
cd upx
# 安装依赖
pnpm install
# 构建
pnpm run build
# 本地运行
node dist/index.js
# 或全局链接测试
pnpm linkSkills 来源
- https://github.com/anthropics/skills/tree/main/skills
- https://github.com/hyf0/vue-skills/tree/master/skills
- https://github.com/0xBigBoss/claude-code/tree/main/.claude/skills
- https://github.com/lobehub/lobe-chat/tree/next/.agents/skills
skills/mcp参考网站
- https://skills.sh/
- https://smithery.ai/
许可证
MIT
