@lovehlmmm/primekit 1.0.0 → 1.0.2

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 (2) hide show
  1. package/README.md +61 -18
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,7 +1,7 @@
1
1
  # PrimeKit (AI Coding Suite Generator)
2
- > Bộ công cụ AI Coding cá nhân hoá, kiến trúc mở cho Claude Code, Cursor, Codex và các AI Assistants.
2
+ > Bộ công cụ AI Coding cá nhân hoá, kiến trúc mở cho Claude Code, Cursor, Codex, VS Code và các AI Assistants.
3
3
 
4
- ![PrimeKit Banner](https://img.shields.io/badge/PrimeKit-v1.0.0-blue.svg)
4
+ [![npm package](https://img.shields.io/npm/v/@lovehlmmm/primekit.svg)](https://www.npmjs.com/package/@lovehlmmm/primekit)
5
5
  ![Build Status](https://img.shields.io/badge/Tests-100%25%20Passing-brightgreen.svg)
6
6
  ![License](https://img.shields.io/badge/License-MIT-green.svg)
7
7
 
@@ -9,7 +9,59 @@
9
9
 
10
10
  ## 🌟 Tổng quan Dự án
11
11
 
12
- **PrimeKit** là một AI Coding Suite hoàn chỉnh được xây dựng dựa trên kiến trúc mở của PrimeKit. Dự án bao gồm hệ thống 100+ skills độc lập, CLI quản lý vòng đời (`init`, `list`, `doctor`, `update`, `import`, `uninstall`) và bộ kiểm thử benchmark 5 kịch bản thực tế.
12
+ **PrimeKit** (`@lovehlmmm/primekit`) là một AI Coding Suite hoàn chỉnh được thiết kế theo kiến trúc modular mở. Dự án bao gồm hệ thống **100+ skills độc lập**, CLI quản lý vòng đời (`init`, `list`, `doctor`, `update`, `import`, `uninstall`) và bộ kiểm thử benchmark 5 kịch bản thực tế.
13
+
14
+ ---
15
+
16
+ ## 🚀 Hướng dẫn Cài đặt & Sử dụng (Quick Start)
17
+
18
+ ### 1. Khởi tạo bằng `npx` (Không cần cài đặt)
19
+ Mở bất kỳ dự án/workspace nào và chạy:
20
+ ```bash
21
+ npx @lovehlmmm/primekit init
22
+ ```
23
+
24
+ ### 2. Cài đặt Cục bộ (Global CLI)
25
+ ```bash
26
+ npm install -g @lovehlmmm/primekit
27
+
28
+ # Sử dụng qua lệnh primekit hoặc alias ngắn pk
29
+ primekit init
30
+ # hoặc
31
+ pk init
32
+ ```
33
+
34
+ ---
35
+
36
+ ## ⚡ Cú pháp Gọi Skill Rút gọn (`/pk:`)
37
+
38
+ PrimeKit hỗ trợ cú pháp kích hoạt skill rút gọn cực nhanh bằng tiền tố `/pk:`:
39
+
40
+ | Lệnh Gọi Skill | Tên Skill | Vai trò & Quy trình |
41
+ | :--- | :--- | :--- |
42
+ | `/pk:explore` | Codebase Scout | Khảo sát sâu kiến trúc repository, dependencies & entry points |
43
+ | `/pk:clarify` | Requirement Clarifier | Làm rõ yêu cầu chưa đầy đủ & thách thức phạm vi YAGNI |
44
+ | `/pk:plan` | Implementation Planner | Lập kế hoạch theo giai đoạn (`--fast`, `--deep`, `--debate`, `--ultra`) |
45
+ | `/pk:implement` | Focused Coder | Lập trình khoanh vùng chính xác (Hỗ trợ TDD `--tdd`) |
46
+ | `/pk:debug` | Root Cause Analyzer | Phân tích nguyên nhân gốc rễ 5-Whys & kịch bản tái hiện |
47
+ | `/pk:test` | Test Execution | Tự động chạy unit/integration test suite & chống lỗi hồi quy |
48
+ | `/pk:review` | Diff Inspector | Đánh giá git diff, kiểm tra rủi ro bảo mật OWASP/STRIDE |
49
+ | `/pk:handoff` | Session Continuity | Lưu trạng thái bàn giao Hợp đồng Tiếp nối phiên sau |
50
+ | `/pk:predict` | Architecture Predictor | 5 Chuyên gia phản biện kiến trúc trước khi code |
51
+ | `/pk:vibe` | Autonomous Pipeline | Tự động hóa luồng từ GitHub Issue tới PR hoàn chỉnh |
52
+
53
+ ---
54
+
55
+ ## 🛠️ Lệnh Quản lý CLI Reference
56
+
57
+ ```bash
58
+ primekit init # Khởi tạo PrimeKit vào workspace (.primekit/, AGENTS.md, .cursorrules)
59
+ primekit list # Liệt kê các skill, hooks và adapters đã cài đặt
60
+ primekit doctor # Kiểm tra sức khỏe hệ thống, SHA256 checksum & tương thích Assistant
61
+ primekit import <name> # Import/clone skill bất kỳ từ hệ sinh thái vào workspace (VD: pk import predict)
62
+ primekit update # Cập nhật an toàn bộ skill & CLI (tự động tạo backup .bak)
63
+ primekit uninstall # Gỡ bỏ sạch sẽ các thành phần do PrimeKit quản lý
64
+ ```
13
65
 
14
66
  ---
15
67
 
@@ -17,7 +69,7 @@
17
69
 
18
70
  ```text
19
71
  PrimeKit/
20
- ├── .primekit/ # Thư mục chứa skills & adapters đã init
72
+ ├── .primekit/ # Thư mục chứa skills & adapters đã init trong workspace
21
73
  │ ├── skills/ # Tất cả skills (SKILL.md)
22
74
  │ └── manifest.json # File theo dõi phiên bản & checksum SHA256
23
75
  ├── cli/ # Mã nguồn CLI (Node.js & TypeScript)
@@ -28,7 +80,7 @@ PrimeKit/
28
80
  │ └── USAGE.md # Hướng dẫn sử dụng CLI reference
29
81
  ├── benchmarks/ # 5 bài kiểm thử thực tế (Bug fix, Feature, Refactor, Review, Handoff)
30
82
  ├── scripts/ # Scripts kiểm thử CLI & runner benchmark
31
- ├── skills/ # Thư mục nguồn các Skills (SKILL.md)
83
+ ├── skills/ # Thư mục nguồn 100+ Skills (SKILL.md)
32
84
  ├── AGENTS.md # Quy tắc agent chuẩn hóa hệ thống
33
85
  ├── agnt.md # File đặc tả cấu hình Agent tối ưu
34
86
  ├── package.json # Cấu hình package & scripts
@@ -37,29 +89,20 @@ PrimeKit/
37
89
 
38
90
  ---
39
91
 
40
- ## 🚀 Hướng dẫn Chạy Nhanh (Quick Start)
92
+ ## 🧪 Phát triển & Kiểm thử (Development & Benchmarks)
41
93
 
42
- ### 1. Cài đặt dependencies và Build
43
94
  ```bash
95
+ # Cài đặt dependencies và build TypeScript
44
96
  npm install
45
97
  npm run build
46
- ```
47
98
 
48
- ### 2. Chạy Kiểm thử CLI
49
- ```bash
99
+ # Chạy bộ test CLI integration
50
100
  npm test
51
- ```
52
101
 
53
- ### 3. Chạy Đánh giá Benchmark 5 Bài Thực tế
54
- ```bash
102
+ # Chạy bộ đánh giá 5 kịch bản benchmark thực tế
55
103
  npm run benchmark
56
104
  ```
57
105
 
58
- ### 4. Khởi tạo PrimeKit trong Workspace bất kỳ
59
- ```bash
60
- node cli/dist/index.js init
61
- ```
62
-
63
106
  ---
64
107
 
65
108
  ## 📜 Giấy phép (License)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lovehlmmm/primekit",
3
- "version": "1.0.0",
3
+ "version": "1.0.2",
4
4
  "description": "Universal AI Coding Tool Suite Generator inspired by AgentKit",
5
5
  "main": "cli/dist/index.js",
6
6
  "bin": {