copilot-dev-toolkit

AI-assisted development toolkit: GitHub Copilot skills, agents, prompts and instructions for any project.

Provides a set of GitHub Copilot configuration files (.github/ assets) that can be installed into any project via a simple CLI command. All project-specific values are parameterized with {{PLACEHOLDER}} tokens and resolved from a skills.config.json file in your project root.

Quick Start

方式一：一鍵腳本（推薦 — 不動 package.json、不留痕跡）

執行後只會把檔案複製到 .github/ 等指定目錄，不會在你的專案新增任何 npm 依賴。

Windows (PowerShell)：

# 安裝全部模組
irm https://raw.githubusercontent.com/HeimlichLin/copilot-dev-toolkit/main/install.ps1 | iex

# 只安裝指定模組
$env:CDT_MODULE='doc-generation'; irm https://raw.githubusercontent.com/HeimlichLin/copilot-dev-toolkit/main/install.ps1 | iex

# 強制覆蓋已存在的檔案
$env:CDT_FORCE='1'; irm https://raw.githubusercontent.com/HeimlichLin/copilot-dev-toolkit/main/install.ps1 | iex

macOS / Linux (bash)：

# 安裝全部模組
curl -fsSL https://raw.githubusercontent.com/HeimlichLin/copilot-dev-toolkit/main/install.sh | bash

# 只安裝指定模組
CDT_MODULE=doc-generation curl -fsSL .../install.sh | bash

# 強制覆蓋
CDT_FORCE=1 curl -fsSL .../install.sh | bash

腳本會把 toolkit clone 到系統暫存目錄，執行安裝後自動刪除，你的專案中不會有任何 toolkit 相關檔案或 package.json 變更。

方式二：npm install（toolkit 保留在 package.json）

如果你希望版本追蹤或自動更新，可以保留 npm 依賴：

# 安裝後自動執行 postinstall，若有 skills.config.json 則自動複製模組
npm install --save-dev git+https://github.com/HeimlichLin/copilot-dev-toolkit.git

# 初始化設定檔（首次使用）
npx skills init
# 編輯 skills.config.json，填入 PROJECT_PREFIX 等

# 手動安裝模組
npx skills add-all
npx skills add doc-generation   # 或指定模組

# 清除殘留設定檔
npx skills clean        # 只清除 skills.config.json
npx skills clean --all  # 一並清除 package.json / package-lock.json / node_modules/

更新 toolkit：

npm install git+https://github.com/HeimlichLin/copilot-dev-toolkit.git

使用 --save-dev 而非 --save，toolkit 只會出現在 devDependencies，不影響 production 部署。

方式三：npm install --no-save（臨時使用、不修改 package.json）

# 安裝但不寫入 package.json（postinstall 仍會自動複製模組）
npm install --no-save git+https://github.com/HeimlichLin/copilot-dev-toolkit.git

方式四：npx 直接執行（免安裝）

# 1. 在你的專案根目錄初始化設定檔
npx copilot-dev-toolkit init

# 2. 編輯 skills.config.json，填入專案資訊（PROJECT_PREFIX 等）

# 3. 安裝所需模組（安裝後自動清除殘留檔案）
npx copilot-dev-toolkit add-all --clean

# 或分兩步執行
npx copilot-dev-toolkit add-all
npx copilot-dev-toolkit clean        # 只清除 skills.config.json
npx copilot-dev-toolkit clean --all  # 一並清除 package.json / package-lock.json / node_modules/

Commands

| 命令 | 說明 | |------|------| | skills init | 在當前目錄建立 skills.config.json 範本 | | skills list | 列出所有可安裝模組 | | skills list --tag any | 篩選特定標籤的模組 | | skills info <module> | 顯示模組詳細資訊（檔案清單、佔位符、安裝路徑等） | | skills add <module> | 安裝模組（目的路徑依模組設定，預設為 .github/） | | skills add <module> --force | 覆蓋已存在的檔案 | | skills add <module> --dry-run | 模擬執行，不實際寫入 | | skills add <module> --no-placeholders | 直接複製原始檔案，不替換佔位符 | | skills add-all | 安裝所有模組 | | skills add-all --tag any | 安裝指定標籤的所有模組 | | skills add-all --force | 覆蓋已存在的檔案 | | skills add-all --dry-run | 模擬執行，不實際寫入 | | skills add-all --no-placeholders | 直接複製原始檔案，不替換佔位符 | | skills add-all --clean | 安裝完成後自動清除殘留檔案 | | skills clean | 清除 skills.config.json（安裝機學殐留檔案） | | skills clean --all | 一並清除 package.json、package-lock.json、node_modules/（僅當 toolkit 為唯一依賴時） |

Available Modules

Universal（任何專案皆可使用）

| 模組 | 說明 | |------|------| | universal/git-utils | Conventional Commits 中文版 + .gitignore 生成 | | universal/code-review | 通用 Code Review Agents | | universal/chatmodes | GPT-4.1 Coding Agents 自訂模式 | | universal/prompt-tools | prompt-builder、README 生成器、工作日誌格式化 | | universal/anthropic-skills | Anthropic 官方 Skills（docx、MCP builder 等） | | universal/markdown-style | Markdown 檔案撰寫規範：Front Matter、標題結構、驗證規則 |

Feature（功能模組）

| 模組 | 說明 | |------|------| | doc-generation | 系統功能文件 + 批次作業文件自動生成 | | doc-review | 系統說明文件品質審查：五大驗證 Pass 自動比對與修正 | | keywords | 功能 ID 對應表 + Job ID 對應表空白模板 |

Module Structure

modules/
├── universal/
│   ├── git-utils/
│   │   └── prompts/         → .github/prompts/
│   ├── code-review/         → .github/agents/
│   ├── chatmodes/
│   │   └── chatmodes/       → .github/chatmodes/
│   ├── prompt-tools/
│   │   └── prompts/         → .github/prompts/
│   ├── anthropic-skills/
│   │   └── skills/          → .github/skills/
│   └── markdown-style/
│       └── instructions/    → .github/instructions/
├── doc-generation/
│   ├── agents/              → .github/agents/
│   ├── prompts/             → .github/prompts/
│   └── skills/              → .github/skills/
├── doc-review/
│   ├── agents/              → .github/agents/
│   ├── prompts/             → .github/prompts/
│   └── skills/              → .github/skills/
└── keywords/                → .github/keywords/   (targetDir: keywords)

Fork & Customize

本 toolkit 設計為 fork 後各自維護：

1. Fork 此 repo 到你的組織
2. 根據你的技術棧新增 / 修改模組
3. 更新 catalog.json 加入新模組
4. 若有通用改進，可提 PR 回原 repo

Development

# 本 toolkit 零外部依賴，不需要 npm install
npm test          # 執行 skills list
node bin/skills.js --help
node bin/skills.js list

License

MIT