@buiducnhat/agent-skills 0.5.1 → 0.5.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +233 -0
  2. package/README.vi.md +227 -0
  3. package/package.json +53 -10
package/README.md ADDED
@@ -0,0 +1,233 @@
1
+ # agent-skills
2
+
3
+ Install standardized AI agent workflow skills and configuration assets into any repository with a single command.
4
+
5
+ Supports **39 AI coding agents** including Claude Code, Cursor, Windsurf, Copilot, Cline, Roo Code, and more.
6
+
7
+ ---
8
+
9
+ **Languages:** English | [Tiếng Việt](README.vi.md)
10
+
11
+ ---
12
+
13
+ ## What it does
14
+
15
+ Running the installer:
16
+
17
+ 1. Lets you **select which agents** to configure (auto-detects already-installed agents)
18
+ 2. Installs **9 workflow skills** into each agent's skills directory via the [Vercel skills CLI](https://github.com/vercel-labs/skills)
19
+ 3. Injects **shared agent instructions** (`AGENTS.md`) into each agent's rules file using idempotent markers
20
+ 4. Copies **Claude Code settings** (`.claude/`) into your project
21
+
22
+ ## Installation
23
+
24
+ ### Interactive (recommended)
25
+
26
+ ```bash
27
+ npx @buiducnhat/agent-skills
28
+ ```
29
+
30
+ Walks you through agent selection and install mode (symlink or copy).
31
+
32
+ ### Non-interactive (CI / automation)
33
+
34
+ ```bash
35
+ npx @buiducnhat/agent-skills --non-interactive
36
+ ```
37
+
38
+ Skips all prompts and installs skills for all agents.
39
+
40
+ ### Via shell script
41
+
42
+ ```bash
43
+ curl -fsSL https://raw.githubusercontent.com/buiducnhat/agent-skills/main/install.sh | bash
44
+ ```
45
+
46
+ Checks for Node.js 18+ and runs the installer automatically.
47
+
48
+ ### Global install
49
+
50
+ ```bash
51
+ npx @buiducnhat/agent-skills --global
52
+ ```
53
+
54
+ Installs skills to your home directory (`~/<agent>/skills/`) so they are available across all projects.
55
+
56
+ ## Interactive walkthrough
57
+
58
+ ```
59
+ ┌ Agent Skills Installer
60
+
61
+ ◇ Select agents to install skills for:
62
+ │ ◼ Claude Code ◼ Cursor ◻ Windsurf ...
63
+
64
+ ◇ How should the skills be installed?
65
+ │ ● Symlink (recommended) ○ Copy
66
+
67
+ ◇ Installing skills via skills CLI...
68
+
69
+ ◇ Installation complete!
70
+
71
+ │ What was set up:
72
+ │ .claude/ - Claude Code settings
73
+ │ CLAUDE.md - updated
74
+
75
+ │ Agent configurations updated for:
76
+ │ - claude-code
77
+ │ - cursor
78
+
79
+ └ Done! Your AI agent skills are ready.
80
+ ```
81
+
82
+ ## CLI options
83
+
84
+ | Flag | Description |
85
+ | ------------------- | ------------------------------------------------ |
86
+ | `--non-interactive` | Skip prompts; install all skills to all agents |
87
+ | `--copy` | Copy skill files instead of symlinking |
88
+ | `-g, --global` | Install to `~/` instead of the current directory |
89
+ | `-h, --help` | Show help |
90
+ | `-v, --version` | Show version |
91
+
92
+ ## Workflow skills
93
+
94
+ Nine reusable workflow skills are installed into each agent:
95
+
96
+ | Skill | Description |
97
+ | ----------------- | ------------------------------------------------------------------------- |
98
+ | `ask` | Ask clarifying questions to gather requirements and context |
99
+ | `bootstrap` | Set up project structure, documentation, and conventions for new projects |
100
+ | `brainstorm` | Explore ideas and break down complex problems before planning |
101
+ | `docs` | Initialize (`--init`) or update (`--update`) project documentation |
102
+ | `execute-plan` | Execute written plans systematically with checkpoints |
103
+ | `fix` | Diagnose and resolve bugs |
104
+ | `quick-implement` | Rapid implementation for simple tasks or bug fixes |
105
+ | `review` | Review uncommitted changes with codebase context |
106
+ | `write-plan` | Create detailed implementation plans with phases and tasks |
107
+
108
+ ### Recommended workflow sequences
109
+
110
+ ---
111
+
112
+ #### Init documentations
113
+
114
+ ```
115
+ /docs --init # or /docs --update for updating existing docs
116
+ ```
117
+
118
+ #### Complex or ambiguous tasks
119
+
120
+ ```
121
+ brainstorm → write-plan → execute-plan
122
+ ```
123
+
124
+ Use when requirements are unclear or multiple approaches are possible.
125
+
126
+ ```
127
+ # Step 1 — explore and define the design
128
+ /brainstorm add dark mode support
129
+
130
+ # Agent clarifies requirements, proposes approaches, writes:
131
+ # docs/brainstorms/260306-1430-dark-mode/SUMMARY.md
132
+ # Then prompts: "Proceed to write-plan?"
133
+
134
+ # Step 2 — create a phased implementation plan
135
+ /write-plan
136
+
137
+ # Agent reads the brainstorm, writes:
138
+ # docs/plans/260306-1445-dark-mode/SUMMARY.md
139
+ # docs/plans/260306-1445-dark-mode/phase-01-tokens.md
140
+ # docs/plans/260306-1445-dark-mode/phase-02-components.md
141
+ # Ends with: "Use /clear then /execute-plan docs/plans/... to execute"
142
+
143
+ # Step 3 — execute the approved plan in a fresh context
144
+ /clear
145
+ /execute-plan docs/plans/260306-1445-dark-mode/SUMMARY.md
146
+ ```
147
+
148
+ ---
149
+
150
+ #### Well-defined features or large refactors
151
+
152
+ ```
153
+ write-plan → execute-plan
154
+ ```
155
+
156
+ Use when the task is clear but too large or risky to implement without a plan.
157
+
158
+ ```
159
+ # Step 1 — plan the work
160
+ /write-plan migrate auth to JWT
161
+
162
+ # Agent writes:
163
+ # docs/plans/260306-1020-jwt-auth/SUMMARY.md
164
+ # docs/plans/260306-1020-jwt-auth/phase-01-schema.md
165
+ # docs/plans/260306-1020-jwt-auth/phase-02-middleware.md
166
+ # Ends with: "Use /clear then /execute-plan docs/plans/... to execute"
167
+
168
+ # Step 2 — execute in a fresh context
169
+ /clear
170
+ /execute-plan docs/plans/260306-1020-jwt-auth/SUMMARY.md
171
+ ```
172
+
173
+ ---
174
+
175
+ #### Small tasks and quick fixes
176
+
177
+ ```
178
+ quick-implement
179
+ ```
180
+
181
+ Use for small, well-scoped changes where a formal plan would be overhead.
182
+
183
+ ```
184
+ # Implement directly — no plan needed
185
+ /quick-implement add a tooltip to the submit button
186
+ ```
187
+
188
+ ---
189
+
190
+ #### Bug fixes
191
+
192
+ ```
193
+ fix
194
+ ```
195
+
196
+ Use when you have a concrete error, failing test, or unexpected behavior to diagnose.
197
+
198
+ ```
199
+ /fix TypeError: Cannot read properties of undefined at checkout.ts:42
200
+
201
+ # For simple bugs: agent diagnoses, applies fix, verifies
202
+ # For complex bugs: agent stops and routes to write-plan
203
+ ```
204
+
205
+ ## Supported agents
206
+
207
+ <details>
208
+ <summary>View all 39 supported agents</summary>
209
+
210
+ AdaL, Amp, Antigravity, Augment, Claude Code, Cline, CodeBuddy, Codex, Command Code, Continue, Cortex Code, Crush, Cursor, Droid, Gemini CLI, GitHub Copilot, Goose, iFlow CLI, Junie, Kilo Code, Kimi Code CLI, Kiro CLI, Kode, MCPJam, Mistral Vibe, Mux, Neovate, OpenClaw, OpenCode, OpenHands, Pi, Pochi, Qoder, Qwen Code, Replit, Roo Code, Trae, Trae CN, Windsurf, Zencoder
211
+
212
+ </details>
213
+
214
+ ## Requirements
215
+
216
+ - Node.js 18+
217
+ - `git` available in `PATH`
218
+ - Network access (to clone templates from GitHub)
219
+
220
+ ## Re-running the installer
221
+
222
+ Re-running is safe. Rules injection is idempotent — the existing content between markers is replaced without duplication. New agents can be added to an existing setup at any time.
223
+
224
+ ## Release
225
+
226
+ Tag pushes matching `v*` trigger the GitHub Actions workflow `.github/workflows/release.yml` to publish `@buiducnhat/agent-skills` to npm automatically.
227
+
228
+ ## Documentation
229
+
230
+ - [Product PDR](docs/project-pdr.md)
231
+ - [Architecture](docs/architecture.md)
232
+ - [Codebase Map](docs/codebase.md)
233
+ - [Code Standard](docs/code-standard.md)
package/README.vi.md ADDED
@@ -0,0 +1,227 @@
1
+ # agent-skills
2
+
3
+ Cài đặt các workflow skill chuẩn hóa cho AI agent và các tài nguyên cấu hình vào bất kỳ repository nào chỉ với một lệnh duy nhất.
4
+
5
+ Hỗ trợ **39 AI coding agent** bao gồm Claude Code, Cursor, Windsurf, Copilot, Cline, Roo Code và nhiều hơn nữa.
6
+
7
+ ---
8
+
9
+ **Ngôn ngữ:** [English](README.md) | Tiếng Việt
10
+
11
+ ---
12
+
13
+ ## Tính năng
14
+
15
+ Khi chạy trình cài đặt:
16
+
17
+ 1. Cho phép **chọn agent** cần cấu hình (tự động phát hiện các agent đã cài)
18
+ 2. Cài đặt **9 workflow skill** vào thư mục skills của từng agent thông qua [Vercel skills CLI](https://github.com/vercel-labs/skills)
19
+ 3. Chèn **hướng dẫn dùng chung cho agent** (`AGENTS.md`) vào file rules của từng agent sử dụng marker idempotent
20
+ 4. Sao chép **cài đặt Claude Code** (`.claude/`) vào project của bạn
21
+
22
+ ## Cài đặt
23
+
24
+ ### Tương tác (khuyến nghị)
25
+
26
+ ```bash
27
+ npx @buiducnhat/agent-skills
28
+ ```
29
+
30
+ Hướng dẫn từng bước qua việc chọn agent và chế độ cài đặt (symlink hoặc copy).
31
+
32
+ ### Không tương tác (CI / tự động hóa)
33
+
34
+ ```bash
35
+ npx @buiducnhat/agent-skills --non-interactive
36
+ ```
37
+
38
+ Bỏ qua tất cả các bước hỏi và cài đặt skill cho tất cả agent.
39
+
40
+ ### Qua shell script
41
+
42
+ ```bash
43
+ curl -fsSL https://raw.githubusercontent.com/buiducnhat/agent-skills/main/install.sh | bash
44
+ ```
45
+
46
+ Kiểm tra Node.js 18+ và chạy trình cài đặt tự động.
47
+
48
+ ### Cài đặt toàn cục
49
+
50
+ ```bash
51
+ npx @buiducnhat/agent-skills --global
52
+ ```
53
+
54
+ Cài đặt skill vào thư mục home (`~/<agent>/skills/`) để dùng được trên tất cả các project.
55
+
56
+ ## Hướng dẫn tương tác
57
+
58
+ ```
59
+ ┌ Agent Skills Installer
60
+
61
+ ◇ Select agents to install skills for:
62
+ │ ◼ Claude Code ◼ Cursor ◻ Windsurf ...
63
+
64
+ ◇ How should the skills be installed?
65
+ │ ● Symlink (recommended) ○ Copy
66
+
67
+ ◇ Installing skills via skills CLI...
68
+
69
+ ◇ Installation complete!
70
+
71
+ │ What was set up:
72
+ │ .claude/ - Claude Code settings
73
+ │ CLAUDE.md - updated
74
+
75
+ │ Agent configurations updated for:
76
+ │ - claude-code
77
+ │ - cursor
78
+
79
+ └ Done! Your AI agent skills are ready.
80
+ ```
81
+
82
+ ## Tùy chọn CLI
83
+
84
+ | Flag | Mô tả |
85
+ | ------------------- | ---------------------------------------------------------- |
86
+ | `--non-interactive` | Bỏ qua các bước hỏi; cài đặt tất cả skill cho tất cả agent |
87
+ | `--copy` | Sao chép file skill thay vì tạo symlink |
88
+ | `-g, --global` | Cài vào `~/` thay vì thư mục hiện tại |
89
+ | `-h, --help` | Hiển thị trợ giúp |
90
+ | `-v, --version` | Hiển thị phiên bản |
91
+
92
+ ## Workflow skill
93
+
94
+ Chín workflow skill có thể tái sử dụng được cài đặt vào mỗi agent:
95
+
96
+ | Skill | Mô tả |
97
+ | ----------------- | -------------------------------------------------------------------- |
98
+ | `ask` | Đặt câu hỏi làm rõ để thu thập yêu cầu và ngữ cảnh |
99
+ | `bootstrap` | Thiết lập cấu trúc project, tài liệu và quy ước cho project mới |
100
+ | `brainstorm` | Khám phá ý tưởng và phân tích vấn đề phức tạp trước khi lên kế hoạch |
101
+ | `docs` | Khởi tạo (`--init`) hoặc cập nhật (`--update`) tài liệu project |
102
+ | `execute-plan` | Thực thi kế hoạch đã viết theo từng giai đoạn với các điểm kiểm tra |
103
+ | `fix` | Chẩn đoán và sửa lỗi |
104
+ | `quick-implement` | Triển khai nhanh cho các task nhỏ hoặc sửa lỗi đơn giản |
105
+ | `review` | Review các thay đổi chưa commit với ngữ cảnh codebase |
106
+ | `write-plan` | Tạo kế hoạch triển khai chi tiết theo từng giai đoạn |
107
+
108
+ ### Chuỗi workflow khuyến nghị
109
+
110
+ ---
111
+
112
+ #### Tác vụ phức tạp hoặc chưa rõ ràng
113
+
114
+ ```
115
+ brainstorm → write-plan → execute-plan
116
+ ```
117
+
118
+ Dùng khi yêu cầu chưa rõ hoặc có nhiều hướng tiếp cận khả thi.
119
+
120
+ ```
121
+ # Bước 1 — khám phá và xác định thiết kế
122
+ /brainstorm thêm chế độ dark mode
123
+
124
+ # Agent làm rõ yêu cầu, đề xuất các hướng tiếp cận, tạo file:
125
+ # docs/brainstorms/260306-1430-dark-mode/SUMMARY.md
126
+ # Sau đó hỏi: "Tiến hành write-plan không?"
127
+
128
+ # Bước 2 — tạo kế hoạch triển khai theo giai đoạn
129
+ /write-plan
130
+
131
+ # Agent đọc brainstorm, tạo:
132
+ # docs/plans/260306-1445-dark-mode/SUMMARY.md
133
+ # docs/plans/260306-1445-dark-mode/phase-01-tokens.md
134
+ # docs/plans/260306-1445-dark-mode/phase-02-components.md
135
+ # Kết thúc với: "Dùng /clear rồi /execute-plan docs/plans/... để thực thi"
136
+
137
+ # Bước 3 — thực thi kế hoạch đã duyệt trong context mới
138
+ /clear
139
+ /execute-plan docs/plans/260306-1445-dark-mode/SUMMARY.md
140
+ ```
141
+
142
+ ---
143
+
144
+ #### Tính năng rõ ràng hoặc refactor lớn
145
+
146
+ ```
147
+ write-plan → execute-plan
148
+ ```
149
+
150
+ Dùng khi task rõ ràng nhưng quá lớn hoặc có rủi ro để triển khai trực tiếp.
151
+
152
+ ```
153
+ # Bước 1 — lên kế hoạch
154
+ /write-plan chuyển đổi auth sang JWT
155
+
156
+ # Agent tạo:
157
+ # docs/plans/260306-1020-jwt-auth/SUMMARY.md
158
+ # docs/plans/260306-1020-jwt-auth/phase-01-schema.md
159
+ # docs/plans/260306-1020-jwt-auth/phase-02-middleware.md
160
+ # Kết thúc với: "Dùng /clear rồi /execute-plan docs/plans/... để thực thi"
161
+
162
+ # Bước 2 — thực thi trong context mới
163
+ /clear
164
+ /execute-plan docs/plans/260306-1020-jwt-auth/SUMMARY.md
165
+ ```
166
+
167
+ ---
168
+
169
+ #### Tác vụ nhỏ và sửa nhanh
170
+
171
+ ```
172
+ quick-implement
173
+ ```
174
+
175
+ Dùng cho các thay đổi nhỏ, phạm vi rõ ràng mà không cần kế hoạch chính thức.
176
+
177
+ ```
178
+ # Triển khai trực tiếp — không cần kế hoạch
179
+ /quick-implement thêm tooltip cho nút submit
180
+ ```
181
+
182
+ ---
183
+
184
+ #### Sửa lỗi
185
+
186
+ ```
187
+ fix
188
+ ```
189
+
190
+ Dùng khi có lỗi cụ thể, test thất bại hoặc hành vi không mong muốn cần chẩn đoán.
191
+
192
+ ```
193
+ /fix TypeError: Cannot read properties of undefined at checkout.ts:42
194
+
195
+ # Lỗi đơn giản: agent chẩn đoán, áp dụng fix, kiểm tra
196
+ # Lỗi phức tạp: agent dừng lại và chuyển sang write-plan
197
+ ```
198
+
199
+ ## Agent được hỗ trợ
200
+
201
+ <details>
202
+ <summary>Xem tất cả 39 agent được hỗ trợ</summary>
203
+
204
+ AdaL, Amp, Antigravity, Augment, Claude Code, Cline, CodeBuddy, Codex, Command Code, Continue, Cortex Code, Crush, Cursor, Droid, Gemini CLI, GitHub Copilot, Goose, iFlow CLI, Junie, Kilo Code, Kimi Code CLI, Kiro CLI, Kode, MCPJam, Mistral Vibe, Mux, Neovate, OpenClaw, OpenCode, OpenHands, Pi, Pochi, Qoder, Qwen Code, Replit, Roo Code, Trae, Trae CN, Windsurf, Zencoder
205
+
206
+ </details>
207
+
208
+ ## Yêu cầu
209
+
210
+ - Node.js 18+
211
+ - `git` có trong `PATH`
212
+ - Kết nối mạng (để clone template từ GitHub)
213
+
214
+ ## Chạy lại trình cài đặt
215
+
216
+ Chạy lại hoàn toàn an toàn. Việc chèn rules là idempotent — nội dung giữa các marker sẽ được thay thế mà không bị trùng lặp. Có thể thêm agent mới vào cài đặt hiện có bất cứ lúc nào.
217
+
218
+ ## Phát hành
219
+
220
+ Các tag push khớp với `v*` sẽ kích hoạt GitHub Actions workflow `.github/workflows/release.yml` để tự động publish `@buiducnhat/agent-skills` lên npm.
221
+
222
+ ## Tài liệu
223
+
224
+ - [Product PDR](docs/project-pdr.md)
225
+ - [Kiến trúc](docs/architecture.md)
226
+ - [Bản đồ Codebase](docs/codebase.md)
227
+ - [Tiêu chuẩn Code](docs/code-standard.md)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@buiducnhat/agent-skills",
3
- "version": "0.5.1",
3
+ "version": "0.5.3",
4
4
  "description": "Install AI agent workflow skills for coding assistants",
5
5
  "type": "module",
6
6
  "bin": {
@@ -31,19 +31,62 @@
31
31
  "publishConfig": {
32
32
  "access": "public"
33
33
  },
34
+ "keywords": [
35
+ "cli",
36
+ "workflow",
37
+ "agent-skills",
38
+ "skills",
39
+ "ai-agents",
40
+ "amp",
41
+ "antigravity",
42
+ "augment",
43
+ "claude-code",
44
+ "openclaw",
45
+ "cline",
46
+ "codebuddy",
47
+ "codex",
48
+ "command-code",
49
+ "continue",
50
+ "cortex",
51
+ "crush",
52
+ "cursor",
53
+ "droid",
54
+ "gemini-cli",
55
+ "github-copilot",
56
+ "goose",
57
+ "junie",
58
+ "iflow-cli",
59
+ "kilo",
60
+ "kimi-cli",
61
+ "kiro-cli",
62
+ "kode",
63
+ "mcpjam",
64
+ "mistral-vibe",
65
+ "mux",
66
+ "opencode",
67
+ "openhands",
68
+ "pi",
69
+ "qoder",
70
+ "qwen-code",
71
+ "replit",
72
+ "roo",
73
+ "trae",
74
+ "trae-cn",
75
+ "windsurf",
76
+ "zencoder",
77
+ "neovate",
78
+ "pochi",
79
+ "adal",
80
+ "universal"
81
+ ],
82
+ "homepage": "https://github.com/buiducnhat/agent-skills#readme",
83
+ "bugs": {
84
+ "url": "https://github.com/buiducnhat/agent-skills/issues"
85
+ },
34
86
  "repository": {
35
87
  "type": "git",
36
88
  "url": "https://github.com/buiducnhat/agent-skills.git",
37
89
  "directory": "packages/cli"
38
90
  },
39
- "keywords": [
40
- "ai",
41
- "agent",
42
- "skills",
43
- "workflow",
44
- "claude",
45
- "copilot",
46
- "cursor"
47
- ],
48
91
  "license": "MIT"
49
92
  }