Skip to content

Commit f5917e9

Browse files
author
薛華慶, james.hsueh
committed
feat: apply python install
1 parent 15fe963 commit f5917e9

File tree

9 files changed

+887
-156
lines changed

9 files changed

+887
-156
lines changed

INSTALLER_README.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# GSI-Protocol Installer
2+
3+
快速安裝 GSI-Protocol 工作流程指令到 Claude Code 或 Codex。
4+
5+
## 安裝方式
6+
7+
### 方式 1:使用 uvx(推薦)
8+
9+
```bash
10+
# 直接執行(不需要安裝)
11+
uvx gsi-protocol-installer
12+
13+
# 或從本地
14+
uvx --from . gsi-install
15+
```
16+
17+
### 方式 2:使用 pipx
18+
19+
```bash
20+
# 直接執行
21+
pipx run gsi-protocol-installer
22+
23+
# 或安裝後使用
24+
pipx install gsi-protocol-installer
25+
gsi-install
26+
```
27+
28+
### 方式 3:使用 pip
29+
30+
```bash
31+
pip install gsi-protocol-installer
32+
gsi-install
33+
```
34+
35+
## 功能
36+
37+
- ✅ 互動式安裝流程
38+
- ✅ 支援 Claude Code 和 Codex
39+
- ✅ 自動偵測專案類型
40+
- ✅ 全域或專案安裝
41+
- ✅ 彩色終端輸出
42+
- ✅ 錯誤處理
43+
44+
## 使用說明
45+
46+
執行安裝程式後,會詢問:
47+
48+
1. **選擇 AI 平台**
49+
- Claude Code only
50+
- Codex (OpenAI) only
51+
- Both
52+
53+
2. **選擇安裝位置**
54+
- 當前專案(如果在 Git repo 中)
55+
- 全域(`~/.claude/commands``~/.codex/commands`
56+
57+
3. 自動下載並安裝指令檔案
58+
59+
## 需求
60+
61+
- Python 3.10+
62+
- Git(用於下載指令檔案)
63+
64+
## License
65+
66+
MIT

README.md

Lines changed: 36 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,36 @@ GSI-Protocol 是一個 AI 驅動的工作流程插件,實作了**規格驅動
3535

3636
### 安裝
3737

38-
**選項 1:一鍵安裝(推薦):**
38+
**選項 1:使用 uvx(最推薦,無需安裝)**
3939

4040
```bash
41-
curl -sSL https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/install.sh | bash
41+
uvx gsi-protocol-installer
4242
```
4343

44-
安裝腳本會詢問您要安裝哪個 AI 平台(Claude Code、Codex 或兩者),以及選擇全域安裝或專案安裝。
44+
**選項 2:使用 pipx**
4545

46-
**選項 2:手動全域安裝:**
46+
```bash
47+
pipx run gsi-protocol-installer
48+
```
49+
50+
**選項 3:直接執行 Python**
51+
52+
```bash
53+
# 下載並執行
54+
wget https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/gsi_installer.py
55+
python3 gsi_installer.py
56+
57+
# 或使用 curl
58+
curl -O https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/gsi_installer.py
59+
python3 gsi_installer.py
60+
```
61+
62+
安裝程式會引導您:
63+
1. 選擇 AI 平台(Claude Code、Codex 或兩者)
64+
2. 選擇安裝位置(全域或當前專案)
65+
3. 自動完成安裝
66+
67+
**選項 4:手動全域安裝**
4768

4869
**Claude Code:**
4970
```bash
@@ -74,6 +95,10 @@ curl -sSL https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.c
7495
### 第一次使用(2 分鐘)
7596

7697
```bash
98+
# 使用 uvx 安裝
99+
uvx gsi-protocol-installer
100+
101+
# 選擇平台和安裝位置後,進入您的專案
77102
cd your-project
78103

79104
# 自動模式 - 生成所有內容
@@ -94,6 +119,7 @@ cd your-project
94119
|----------|-------------|
95120
| **[快速入門指南](docs/QUICKSTART.md)** | 5 分鐘教學 |
96121
| **[安裝指南](docs/INSTALL.md)** | 詳細安裝說明 |
122+
| **[Python 安裝器](docs/PYTHON_INSTALLER.md)** | uvx 安裝方式(推薦) |
97123
| **[平台支援](docs/PLATFORM_SUPPORT.md)** | Claude Code vs Codex 比較 |
98124
| **[指令參考](docs/COMMANDS.md)** | 完整指令文件 |
99125
| **[語言指南](docs/LANGUAGE_GUIDE.md)** | 多語言支援指南 |
@@ -313,7 +339,8 @@ GSI-Protocol/
313339
├── README.md # 本檔案
314340
├── CONTRIBUTING.md # 貢獻指南
315341
├── LICENSE # MIT 授權
316-
├── install.sh # 安裝腳本(支援多平台)
342+
├── gsi_installer.py # Python 安裝器
343+
├── pyproject.toml # Python 專案配置
317344
├── .claude/
318345
│ └── commands/ # Claude Code slash 指令
319346
│ ├── sdd-auto.md # 自動工作流程
@@ -331,6 +358,7 @@ GSI-Protocol/
331358
├── docs/ # 文件
332359
│ ├── QUICKSTART.md # 快速入門指南
333360
│ ├── INSTALL.md # 安裝指南
361+
│ ├── PYTHON_INSTALLER.md # Python 安裝器說明
334362
│ ├── PLATFORM_SUPPORT.md # 平台支援說明
335363
│ ├── COMMANDS.md # 指令參考
336364
│ ├── LANGUAGE_GUIDE.md # 語言支援
@@ -368,6 +396,9 @@ GSI-Protocol/
368396
- **AI 平台(擇一或兩者):**
369397
- Claude Code CLI,或
370398
- Codex (OpenAI)
399+
- **安裝工具:**
400+
- Python 3.10+
401+
- uvx/pipx(推薦)或 pip
371402
- Git
372403
- 目標語言執行環境(Python 3.8+、Node.js 16+、Go 1.19+ 等)
373404

docs/COMMANDS.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -291,11 +291,30 @@
291291

292292
---
293293

294+
## 安裝指令
295+
296+
詳細安裝說明請參考:
297+
- [INSTALL.md](INSTALL.md) - 完整安裝指南
298+
- [PYTHON_INSTALLER.md](PYTHON_INSTALLER.md) - Python 安裝器使用說明
299+
- [QUICKSTART.md](QUICKSTART.md) - 5 分鐘快速開始
300+
301+
**快速安裝:**
302+
```bash
303+
# 使用 uvx(推薦)
304+
uvx gsi-protocol-installer
305+
306+
# 或使用 pipx
307+
pipx run gsi-protocol-installer
308+
```
309+
310+
---
311+
294312
## 獲取幫助
295313

296314
- 查看 [QUICKSTART.md](QUICKSTART.md) 了解實作指南
297315
- 查看 [LANGUAGE_GUIDE.md](LANGUAGE_GUIDE.md) 了解特定語言模式
298-
- 查看 [README.md](README.md) 了解完整文件
316+
- 查看 [PLATFORM_SUPPORT.md](PLATFORM_SUPPORT.md) 了解 AI 平台比較
317+
- 查看 [README.md](../README.md) 了解完整文件
299318

300319
---
301320

@@ -305,7 +324,7 @@
305324
快速原型 → /sdd-auto <需求>
306325
生產程式碼 → /sdd-spec → /sdd-arch → /sdd-impl → /sdd-verify
307326
只要規格 → /sdd-spec <需求>
308-
只要結構 → /sdd-arch <spec.feature>
309-
只要程式碼 → /sdd-impl <spec> <structure>
310-
只要驗證 → /sdd-verify <spec> <impl>
327+
只要架構 → /sdd-arch <spec.feature>
328+
只要程式碼 → /sdd-impl <spec.feature>
329+
只要驗證 → /sdd-verify <spec.feature>
311330
```

docs/INDEX.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ GSI-Protocol(Gherkin-Structure-Implementation)工作流程的完整文件。
1212
|----------|-------------|------|
1313
| **[快速入門指南](QUICKSTART.md)** | 5 分鐘快速開始教學 | 5 分鐘 |
1414
| **[安裝指南](INSTALL.md)** | 所有情境的詳細安裝說明 | 10 分鐘 |
15+
| **[Python 安裝器](PYTHON_INSTALLER.md)** | 使用 uvx 的現代化安裝方式 | 3 分鐘 |
1516
| **[平台支援](PLATFORM_SUPPORT.md)** | Claude Code vs Codex 比較 | 5 分鐘 |
1617

1718
### 參考

0 commit comments

Comments
 (0)