@adamchanadam/agent-handoff-kit 0.3.30 → 0.3.32

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.
package/README.md CHANGED
@@ -1,56 +1,71 @@
1
1
  # Agent Handoff Kit
2
2
 
3
- 狀態:目前版本為 `v0.3.30`。這是早期可用版本,仍在持續完善中。
3
+ 狀態:目前版本為 `v0.3.32`。這是早期可用版本,仍在持續完善中。
4
4
 
5
- ![Agent Handoff Kit 主視覺](https://raw.githubusercontent.com/Adamchanadam/agent-handoff-kit/main/images/agent-handoff-kit-main-visual2.png)
5
+ <p align="center">
6
+ <img src="https://raw.githubusercontent.com/Adamchanadam/agent-handoff-kit/main/images/agent-handoff-kit-promo-30s.gif" alt="Agent Handoff Kit 功能簡介動畫" width="720">
7
+ </p>
6
8
 
7
9
  Agent Handoff Kit 是 **AI 對話之間的接力棒**。
8
10
 
9
- 它只處理一件狹窄但重要的事:AI 跨對話失憶。每次開新對話,AI 往往不記得你上次做到哪裡,也認不出中途新建的文件、你引入的參考資料、哪些檔案是真源。這套工具把進度、下一步、風險、檔案登記與下次開工提示寫進固定文件,讓下一個 AI 工具能接得上上一棒。
10
-
11
- 📌 使用時,你只需要說明目的;確認資料夾、判斷安裝或升級、執行指令和檢查結果,交給能讀寫本機資料夾的 AI 處理。
12
-
13
- ## 🚀 三步上手
14
-
15
- 第一次用,不需要先讀完整 README,也不需要研究終端機指令。只做三件事:
16
-
17
- 1. 在你想使用 Agent Handoff Kit 的資料夾打開 AI,貼上這句話:
18
-
19
- ```text
20
- 請讀取 https://adamchanadam.github.io/agent-handoff-kit/agent-handoff-kit-ai-install.html,並在這個資料夾安裝或升級 Agent Handoff Kit。
21
- ```
22
-
23
- 你也可以先打開 [`agent-handoff-kit-ai-install.html`](https://adamchanadam.github.io/agent-handoff-kit/agent-handoff-kit-ai-install.html) 看看 AI 會照甚麼步驟處理。
24
-
25
- 2. 安裝完成後,對 AI 說 `Start Agent Handoff` 或「開工」。
26
- 3. 完成本輪工作後,對 AI 說「收工」。
27
-
28
- 🔎 你不用判斷安裝、升級、檢查或檔案結構。AI 會先說明它看到的資料夾、風險與下一步;需要你確認時才停下來。
29
-
30
- 已裝過舊版,或資料夾裡已有 `AGENTS.md`、`CLAUDE.md`、`GEMINI.md` 等 AI 記憶文件,也用同一句交給 AI 判斷。AI 會先檢查,不會靜默覆寫。
31
-
32
- 想先看非技術版介紹,可打開 GitHub Pages 上的 [`agent-handoff-kit-intro.html`](https://adamchanadam.github.io/agent-handoff-kit/agent-handoff-kit-intro.html)。想看完整操作示範,可開 [`agent-handoff-kit-guide.html`](https://adamchanadam.github.io/agent-handoff-kit/agent-handoff-kit-guide.html)。想了解它在本機 Agentic AI 工作系統中的位置,可看 [`local-agentic-ai-workflow-case-study.html`](https://adamchanadam.github.io/agent-handoff-kit/local-agentic-ai-workflow-case-study.html)。
33
-
34
- ## 🔎 它解決甚麼問題
11
+ 它只處理一件狹窄但重要的事:AI 跨對話失憶。每次開新對話,AI 往往不記得你上次做到哪裡,也認不出中途新建的文件、你引入的參考資料、哪些檔案是真源。這套工具把進度、下一步、風險、檔案登記與下次開工提示寫進固定文件,讓下一個 AI 工具能接得上上一棒。
12
+
13
+ 📌 使用時,你只需要說明目的;確認資料夾、判斷安裝或升級、執行指令和檢查結果,交給能讀寫本機資料夾的 AI 處理。
14
+
15
+ ## 🚀 三步上手
16
+
17
+ 第一次用,不需要先讀完整 README,也不需要研究終端機指令。只做三件事:
18
+
19
+ 1. 在你想使用 Agent Handoff Kit 的資料夾打開 AI,貼上這句話:
20
+
21
+ ```text
22
+ 請讀取 https://adamchanadam.github.io/agent-handoff-kit/agent-handoff-kit-ai-install.html,並在這個資料夾安裝或升級 Agent Handoff Kit。
23
+ ```
24
+
25
+ 你也可以先打開 [`agent-handoff-kit-ai-install.html`](https://adamchanadam.github.io/agent-handoff-kit/agent-handoff-kit-ai-install.html) 看看 AI 會照甚麼步驟處理。
26
+
27
+ 2. 安裝完成後,對 AI 說 `Start Agent Handoff` 或「開工」。
28
+ 3. 完成本輪工作後,對 AI 說「收工」。
29
+
30
+ 🔎 你不用判斷安裝、升級、檢查或檔案結構。AI 會先說明它看到的資料夾、風險與下一步;需要你確認時才停下來。
31
+
32
+ 已裝過舊版,或資料夾裡已有 `AGENTS.md`、`CLAUDE.md`、`GEMINI.md` 等 AI 記憶文件,也用同一句交給 AI 判斷。AI 會先檢查,不會靜默覆寫。
33
+
34
+ 想先看非技術版介紹,可打開 GitHub Pages 上的 [`agent-handoff-kit-intro.html`](https://adamchanadam.github.io/agent-handoff-kit/agent-handoff-kit-intro.html)。想看完整操作示範,可開 [`agent-handoff-kit-guide.html`](https://adamchanadam.github.io/agent-handoff-kit/agent-handoff-kit-guide.html)。想了解它在本機 Agentic AI 工作系統中的位置,可看 [`local-agentic-ai-workflow-case-study.html`](https://adamchanadam.github.io/agent-handoff-kit/local-agentic-ai-workflow-case-study.html)。
35
+
36
+ ## 🧭 這個 repo 怎樣讀
37
+
38
+ 如果你只是想使用 Agent Handoff Kit,只需要看四個入口:
39
+
40
+ | 入口 | 用途 |
41
+ |---|---|
42
+ | `README.md` | 正式用途、安裝路徑、限制與安全邊界。 |
43
+ | [`agent-handoff-kit-intro.html`](https://adamchanadam.github.io/agent-handoff-kit/agent-handoff-kit-intro.html) | 非技術版 60 秒入門與宣傳動畫。 |
44
+ | [`agent-handoff-kit-guide.html`](https://adamchanadam.github.io/agent-handoff-kit/agent-handoff-kit-guide.html) | 三個實操情景,示範開工、工作、收工。 |
45
+ | [`agent-handoff-kit-ai-install.html`](https://adamchanadam.github.io/agent-handoff-kit/agent-handoff-kit-ai-install.html) | 給 AI 讀的安裝與升級指令頁。 |
46
+
47
+ 這個公開 repo 是用戶流通版,保留使用、安裝、入門、GitHub Pages 與 npm 執行所需內容;內部 release QA、升級夾具和候選審核材料留在開發真源,不放入公開流通版。
48
+
49
+ ## 🔎 它解決甚麼問題
35
50
 
36
51
  用 AI 做長期項目,常見四個問題:
37
52
 
38
53
  | 問題 | Agent Handoff Kit 怎樣處理 |
39
54
  |---|---|
40
55
  | 新 AI 不知做到哪 | 用 `dev/SESSION_HANDOFF.md` 保存目前狀態、下一步、風險與驗收。 |
41
- | 新建檔案、參考資料變孤兒 | 你可以叫 AI 把文件接入 Agent Handoff Kit,用 `dev/PROJECT_INDEX.md` 與 `dev/DOC_SYNC_REGISTRY.md` 登記檔案角色、真源與同步責任。 |
56
+ | 新建檔案、參考資料變孤兒 | 你可以叫 AI 把文件接入 Agent Handoff Kit,用 `dev/PROJECT_INDEX.md` 與 `dev/DOC_SYNC_REGISTRY.md` 登記檔案角色、真源與同步責任。 |
42
57
  | 不同 AI 工具入口不同 | 同時安裝 `AGENTS.md`、`CLAUDE.md`、`GEMINI.md`,全部指向同一套開工流程;Antigravity CLI 會讀工作資料夾內的 `AGENTS.md` 與 `GEMINI.md`。 |
43
58
  | AI 可能亂改、亂刪或誤發佈 | 內置安全規則;高風險操作必須先講計劃,破壞性指令與未批准發佈一律禁止。 |
44
59
 
45
60
  它不是聊天機器人,也不是開發框架。它比較像一本固定放在專案內的交接簿。
46
61
 
47
- ## 🧰 適用工具
62
+ ## 🧰 適用工具
48
63
 
49
64
  Agent Handoff Kit 適合能讀寫本機專案資料夾的 agentic AI 工具,例如 Claude Code、OpenAI Codex、Gemini CLI、Google Antigravity,或其他具備本機工作區讀寫能力的工具。
50
65
 
51
66
  它不適合普通 web chat AI,例如沒有本機檔案讀寫能力的 ChatGPT、Claude、Gemini 網頁版。上載檔案或貼上交接內容不能取代本工具需要的本機讀寫能力;這類工具不能可靠維護專案內的交接文件。
52
67
 
53
- ## 🟢 開工
68
+ ## 🟢 開工
54
69
 
55
70
  打開能讀寫本機專案資料夾的 AI agent。
56
71
 
@@ -74,7 +89,7 @@ Work in <你的專案資料夾>. Read AGENTS.md first, then Start Agent Handoff.
74
89
 
75
90
  然後用日常話描述你要完成的任務。AI 應先讀交接文件,說明目前狀態、下一步與風險,再開始工作。
76
91
 
77
- ## 💾 收工
92
+ ## 💾 收工
78
93
 
79
94
  本輪工作完成、準備結束時,只需輸入:
80
95
 
@@ -98,71 +113,71 @@ AI 應更新交接文件,並同步更新下一次開工提示副本:
98
113
  START_NEXT_SESSION_PROMPT.txt
99
114
  ```
100
115
 
101
- 這個檔案保存下一次真正要讀的開工內容。你下次仍只需說 `Start Agent Handoff` 或「開工」;若 AI 尚未指向專案資料夾,才使用帶路徑啟動句。真正的權威來源仍是 `dev/SESSION_HANDOFF.md` 裡的「下次開工提示」段。若兩者不同,永遠以 `dev/SESSION_HANDOFF.md` 為準重新產生副本。
102
-
103
- ## 🩺 不確定狀態時
104
-
105
- 如你不確定目前資料夾是否安裝完整、是否需要升級,或剛升級後想確認狀態,直接叫 AI:
106
-
107
- ```text
108
- 請讀取頁頂的安裝頁,幫我檢查這個資料夾的 Agent Handoff Kit 狀態。
109
- ```
110
-
111
- AI 會處理檢查,不會把「檢查通過」誤當成已理解你的專案。真正開始工作前,仍要對 AI 說 `Start Agent Handoff` 或「開工」。
112
-
113
- ## 🗂️ AI 會替你維護甚麼
114
-
115
- 安裝後,Agent Handoff Kit 會在你的專案中放入一組交接文件。你不需要逐一閱讀,也不需要手動維護。
116
-
117
- - **開工入口**:讓不同 AI 工具找到同一套開工方式,例如 `AGENTS.md`、`CLAUDE.md`、`GEMINI.md` 和 `START_NEXT_SESSION_PROMPT.txt`。
118
- - **目前狀態**:保存做到哪裡、下一步、風險和檢查結果,例如 `dev/SESSION_HANDOFF.md`。
119
- - **追溯紀錄**:保存近期做過的事;長期使用後,AI 會自動整理,避免紀錄無止境膨脹。
120
- - **項目索引與決策**:記錄重要文件、外部來源、同步責任和長期決策,方便你日後問「之前為何這樣做」。
121
- - **工作規則**:AI 會按你的任務自己載入需要的規則;你不用記規則名稱。
122
-
123
- ## 🧭 AI 工作規則怎樣運作
124
-
125
- 你不需要記住任何規則檔名。Agent Handoff Kit 會讓 AI 先判斷你現在要做甚麼,再只載入需要的工作規則。
126
-
127
- | 你要做的事 | AI 會套用的規則 |
128
- |---|---|
129
- | 寫程式 / 修錯誤 | 先讀項目索引、相關檔案,再改動和測試。 |
130
- | 寫文章 / README / 社交帖文 | 先確認讀者、目的、語氣和發布位置。 |
131
- | 查資料 / 比較工具 | 分清已驗證事實、來源摘要和 AI 推論。 |
132
- | 刪檔 / Git / 發佈 / npm | 高風險操作必須先說明影響,並等你確認。 |
133
- | Notion / Google Drive 等外部工具 | 先確認是否已連接;機密不寫入項目文件。 |
134
-
135
- 你只要用日常話說目的,例如「幫我改 README」、「幫我查這個工具是否適合」、「把這份文件接入 Agent Handoff Kit」。AI 會自己判斷要用哪些規則。
136
-
137
- 想加入自己的長期規則,也不用手改規則檔。你可以直接說:
138
-
139
- ```text
140
- 以後寫公開中文文件時,請用繁體中文書面語,避免半中半英。請把這條規則接入 Agent Handoff Kit。
141
- ```
142
-
143
- AI 應先判斷這條規則應放在哪裡:是一次性備忘、下次交接、項目索引,還是長期工作規則。它不應把所有東西都塞進同一個檔案。
144
-
145
- ## 💬 你可以怎樣叫 AI
146
-
147
- 你只要用自然語言講目的,AI 會自己判斷要讀哪些交接文件、規則或索引。
148
-
149
- | 你想做的事 | 可以這樣說 |
150
- |---|---|
151
- | 接上上次工作 | `Start Agent Handoff` 或「開工」 |
152
- | 結束本輪工作 | 「收工」 |
153
- | 讓新文件不變成孤兒 | 「把這份文件接入 Agent Handoff Kit,讓下次 AI 知道何時要讀、何時要更新。」 |
154
- | 掃描可能被遺漏的重要文件 | 「掃描未接入 Agent Handoff Kit 的重要文件。」 |
155
- | 把錯誤經驗保存成日後機制 | 「把今次錯誤變成日後機制,寫入長期治理。」 |
156
- | 讓 API / 工具用法之後都生效 | 「以後都用這個 API 調用方式,跨 session 生效。」 |
157
- | 使用外部工具,例如 Notion、Google Drive、GitHub | 「這個項目會用到這些外部工具,請記住哪些能直接使用,機密不要寫入項目文件。」 |
158
-
159
- 這個掃描只列出候選與缺口,不會自動修改;是否接入、合併或退役由你確認。
160
-
161
- 長期機制不應只寫入 `dev/SESSION_LOG.md`,也不只留在 session log 或 handoff;AI 應放入合適的長期治理位置。
162
-
163
- 如涉及刪除、改名、合併真源、發佈、上傳或權限變更,AI 應先說明影響並等你確認。
164
-
165
- ## 🛡️ 安全護欄
116
+ 這個檔案保存下一次真正要讀的開工內容。你下次仍只需說 `Start Agent Handoff` 或「開工」;若 AI 尚未指向專案資料夾,才使用帶路徑啟動句。真正的權威來源仍是 `dev/SESSION_HANDOFF.md` 裡的「下次開工提示」段。若兩者不同,永遠以 `dev/SESSION_HANDOFF.md` 為準重新產生副本。
117
+
118
+ ## 🩺 不確定狀態時
119
+
120
+ 如你不確定目前資料夾是否安裝完整、是否需要升級,或剛升級後想確認狀態,直接叫 AI:
121
+
122
+ ```text
123
+ 請讀取頁頂的安裝頁,幫我檢查這個資料夾的 Agent Handoff Kit 狀態。
124
+ ```
125
+
126
+ AI 會處理檢查,不會把「檢查通過」誤當成已理解你的專案。真正開始工作前,仍要對 AI 說 `Start Agent Handoff` 或「開工」。
127
+
128
+ ## 🗂️ AI 會替你維護甚麼
129
+
130
+ 安裝後,Agent Handoff Kit 會在你的專案中放入一組交接文件。你不需要逐一閱讀,也不需要手動維護。
131
+
132
+ - **開工入口**:讓不同 AI 工具找到同一套開工方式,例如 `AGENTS.md`、`CLAUDE.md`、`GEMINI.md` 和 `START_NEXT_SESSION_PROMPT.txt`。
133
+ - **目前狀態**:保存做到哪裡、下一步、風險和檢查結果,例如 `dev/SESSION_HANDOFF.md`。
134
+ - **追溯紀錄**:保存近期做過的事;長期使用後,AI 會自動整理,避免紀錄無止境膨脹。
135
+ - **項目索引與決策**:記錄重要文件、外部來源、同步責任和長期決策,方便你日後問「之前為何這樣做」。
136
+ - **工作規則**:AI 會按你的任務自己載入需要的規則;你不用記規則名稱。
137
+
138
+ ## 🧭 AI 工作規則怎樣運作
139
+
140
+ 你不需要記住任何規則檔名。Agent Handoff Kit 會讓 AI 先判斷你現在要做甚麼,再只載入需要的工作規則。
141
+
142
+ | 你要做的事 | AI 會套用的規則 |
143
+ |---|---|
144
+ | 寫程式 / 修錯誤 | 先讀項目索引、相關檔案,再改動和測試。 |
145
+ | 寫文章 / README / 社交帖文 | 先確認讀者、目的、語氣和發布位置。 |
146
+ | 查資料 / 比較工具 | 分清已驗證事實、來源摘要和 AI 推論。 |
147
+ | 刪檔 / Git / 發佈 / npm | 高風險操作必須先說明影響,並等你確認。 |
148
+ | Notion / Google Drive 等外部工具 | 先確認是否已連接;機密不寫入項目文件。 |
149
+
150
+ 你只要用日常話說目的,例如「幫我改 README」、「幫我查這個工具是否適合」、「把這份文件接入 Agent Handoff Kit」。AI 會自己判斷要用哪些規則。
151
+
152
+ 想加入自己的長期規則,也不用手改規則檔。你可以直接說:
153
+
154
+ ```text
155
+ 以後寫公開中文文件時,請用繁體中文書面語,避免半中半英。請把這條規則接入 Agent Handoff Kit。
156
+ ```
157
+
158
+ AI 應先判斷這條規則應放在哪裡:是一次性備忘、下次交接、項目索引,還是長期工作規則。它不應把所有東西都塞進同一個檔案。
159
+
160
+ ## 💬 你可以怎樣叫 AI
161
+
162
+ 你只要用自然語言講目的,AI 會自己判斷要讀哪些交接文件、規則或索引。
163
+
164
+ | 你想做的事 | 可以這樣說 |
165
+ |---|---|
166
+ | 接上上次工作 | `Start Agent Handoff` 或「開工」 |
167
+ | 結束本輪工作 | 「收工」 |
168
+ | 讓新文件不變成孤兒 | 「把這份文件接入 Agent Handoff Kit,讓下次 AI 知道何時要讀、何時要更新。」 |
169
+ | 掃描可能被遺漏的重要文件 | 「掃描未接入 Agent Handoff Kit 的重要文件。」 |
170
+ | 把錯誤經驗保存成日後機制 | 「把今次錯誤變成日後機制,寫入長期治理。」 |
171
+ | 讓 API / 工具用法之後都生效 | 「以後都用這個 API 調用方式,跨 session 生效。」 |
172
+ | 使用外部工具,例如 Notion、Google Drive、GitHub | 「這個項目會用到這些外部工具,請記住哪些能直接使用,機密不要寫入項目文件。」 |
173
+
174
+ 這個掃描只列出候選與缺口,不會自動修改;是否接入、合併或退役由你確認。
175
+
176
+ 長期機制不應只寫入 `dev/SESSION_LOG.md`,也不只留在 session log 或 handoff;AI 應放入合適的長期治理位置。
177
+
178
+ 如涉及刪除、改名、合併真源、發佈、上傳或權限變更,AI 應先說明影響並等你確認。
179
+
180
+ ## 🛡️ 安全護欄
166
181
 
167
182
  就算你不懂代碼,這套工具也會要求 AI 在高風險操作前停下來講清楚。
168
183
 
@@ -172,18 +187,18 @@ AI 應先判斷這條規則應放在哪裡:是一次性備忘、下次交接
172
187
  - 權限不足就停手:檔案被鎖或沒有權限時,輸出手動操作清單,不嘗試繞過。
173
188
  - 發佈需明確批准:建立版本標籤、GitHub Release、npm publish、部署或上傳,都不能因「準備好了」而自動執行。
174
189
 
175
- ## 🔗 可選配合:Adam-AI-Instructions
176
-
177
- Agent Handoff Kit 可與 [Adam-AI-Instructions](https://github.com/prompt-templates/Adam-AI-Instructions) 配合使用。兩者分工互補,不重疊:
178
-
179
- - **Adam-AI-Instructions** 負責 AI 在**單一對話**內的做事規矩:語氣、做事優先序、回覆骨架、計算紀律、用語紀律、安全護欄、輸出層分工。屬「AI 應該怎樣答你」的持久基準。
180
- - **Agent Handoff Kit** 負責 AI 在**對話之間**的接力:當前狀態、下一步、檔案登記、收工同下次開工。屬「AI 在對話之間怎樣記住你的項目」的持久基準。
181
-
182
- 這是可選配合,不影響 Agent Handoff Kit 的安裝和日常使用。想使用時,到該倉庫選擇適合你 AI 工具的版本,貼入 AI 工具設定即可。
190
+ ## 🔗 可選配合:Adam-AI-Instructions
191
+
192
+ Agent Handoff Kit 可與 [Adam-AI-Instructions](https://github.com/prompt-templates/Adam-AI-Instructions) 配合使用。兩者分工互補,不重疊:
193
+
194
+ - **Adam-AI-Instructions** 負責 AI 在**單一對話**內的做事規矩:語氣、做事優先序、回覆骨架、計算紀律、用語紀律、安全護欄、輸出層分工。屬「AI 應該怎樣答你」的持久基準。
195
+ - **Agent Handoff Kit** 負責 AI 在**對話之間**的接力:當前狀態、下一步、檔案登記、收工同下次開工。屬「AI 在對話之間怎樣記住你的項目」的持久基準。
196
+
197
+ 這是可選配合,不影響 Agent Handoff Kit 的安裝和日常使用。想使用時,到該倉庫選擇適合你 AI 工具的版本,貼入 AI 工具設定即可。
183
198
 
184
- ## ⚠️ 目前限制
199
+ ## ⚠️ 目前限制
185
200
 
186
- - 目前版本為 `v0.3.30`;正式安裝請以 npm registry `latest` 顯示為準。
201
+ - 目前版本為 `v0.3.32`;正式安裝請以 npm registry `latest` 顯示為準。
187
202
  - 這是早期可用版本,仍在持續完善中。
188
203
  - 升級合併屬窄範圍策略,不是完整的複雜合併工具。
189
204
  - `doctor` 能檢查結構,不能代替 AI 對專案內容的理解。