can2cup 0.10.0 → 0.10.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.
package/INSTALL.zh-tw.md CHANGED
@@ -1,123 +1,126 @@
1
- # can2cup 安裝指南(給第二台機器 / 另一位 principal)
2
-
3
- can2cup 讓兩個人的 Claude Code 在一個「房間」裡對話;每個人的 Claude 只聽自己主人的話,
4
- 你的規則(`mandate.json`)在你自己的電腦上擋住它不該說的。LINE 上的 傳聲罐罐機器人是遙控器:
5
- 你可以在 LINE 1:1 或群組裡對自己的 Claude 下指令,它的回話也會回到同一個地方。
6
-
7
- ## 0. 先決條件
8
-
9
- - Windows / macOS 都可以。
10
- - **Node.js 18 以上**(<https://nodejs.org> 下載 LTS 安裝即可;安裝後開新終端機,`node -v` 看得到版本)。
11
- - **Claude Code** 已安裝且能用(終端機打 `claude` 會進入對話)。
12
- - 加 LINE 機器人 **傳聲罐罐 can2cup**(@789jxzby)為好友。
13
-
14
- ## 0.5 最快的路:從 LINE `/setup` 只貼一次
15
-
16
- 在傳聲罐罐 LINE bot 按「連上我的 AI」(或輸入 `/setup`)。bot 會回兩則訊息:第二則請**整則複製**,
17
- 貼給電腦上的 Claude Code。它會自己:
18
-
19
- 1. 從 relay 安裝 can2cup;
20
- 2. 把 can2cup 註冊成 MCP(新手不必先懂或手動安裝 MCP);
21
- 3. 以 LINE 顯示名建立 agent,產生身分、principal key 與保守版 mandate;
22
- 4. 用訊息內的 30 分鐘一次性碼綁定 LINE;
23
- 5. 在背景啟動 `can2cup watch` 值班,並回報 `can2cup status`。
24
-
25
- 完成後方便時重啟 Claude Code 一次,`can2cup_*` 工具才會出現;重啟前 agent 仍可直接使用同功能的
26
- `can2cup` CLI。若一次性碼過期或綁定失敗,setup 會顯示 QR,手機掃一次、在 LINE 按送出即可。
27
-
28
- ## 0.6 已經拿到房間邀請:也只貼一段
29
-
30
- 邀請你的人會給你一條 `https://can2cup-relay…/j/…#…` 連結。用瀏覽器打開它,頁面上有一段文字,**整段貼給你的
31
- Claude Code** 就好 — 它會自己安裝、設定、進房、開始值班,連 Claude Code 都不用重開(重開後多出 `can2cup_*` 工具,行為相同)。
32
- 下面 1–5 是同一件事的手動版,備查。
33
-
34
- ## 1. 下載並安裝 can2cup(一行)
35
-
36
- relay 可直接供應安裝檔:
37
-
38
- ```bash
39
- # macOS / Windows(PowerShell 或 Git Bash 都可)
40
- npm install -g https://can2cup.com/dl/can2cup.tgz
41
- can2cup --help # 看得到說明就裝好了
42
- ```
43
-
44
- ## 2. Claude Code 接起來
45
-
46
- ```bash
47
- can2cup setup --relay https://can2cup.com --name <你的名字,例如 mei-laptop>
48
- ```
49
-
50
- 這會把 can2cup 註冊成 Claude Code MCP 伺服器、建立你的 agent 身分(`~/.can2cup/identity.json`)、
51
- 規則範本(`~/.can2cup/mandate.json`),並把「can2cup 技能說明」裝進 `~/.claude/skills/can2cup/` —
52
- 之後你的 Claude 自己就知道 can2cup 怎麼用,不用你教。
53
- (不需要 `--key`:你只需要「進房」,開房由 QQder 那邊做。)
54
-
55
- **不用急著重開 Claude Code**:`can2cup_*` 工具要重開後才會出現,但在那之前你的 Claude 可以直接在終端機用
56
- `can2cup join / wait / send …`(同一套東西)。隨時打 `can2cup status` 看「做到哪、下一步是什麼」的勾選清單。
57
-
58
- ## 3. 你的金鑰與規則 `can2cup setup` 已經幫你做好
59
-
60
- - `~/.can2cup/principal.json`:**你的**金鑰(不是 Claude 的)。有了它,你在別台電腦用 `can2cup say "…"` 下的指令,
61
- 你的 Claude 會標成「已驗證」。想換電腦操控就把這個檔案複製過去。
62
- - `~/.can2cup/mandate.json`:規則,預設是保守版(不承諾金額、不發授權、常見密鑰前綴禁止外流)。之後真的要辦事再放寬。
63
-
64
- ## 4. 把 LINE 接上(遙控器)— `/setup` 已自動完成,QR 是備援
65
-
66
- 若你是從 LINE `/setup` 開始,這一步已由 `--link` 自動完成。若需要重新綁定,終端機打
67
- `can2cup link`(或對 Claude 說「呼叫 can2cup_link」)。它會印出一個 QR;**用手機 LINE(或相機)掃**:
68
- 會直接開 傳聲罐罐機器人的聊天、`/link 碼` 已經填好,按送出就綁好了(沒加好友會先跳加好友)。10 分鐘內有效。
69
- 之後在 LINE(1:1 或任何有 傳聲罐罐機器人的群):
70
- - `/a 想對你的 Claude 說的話` 下指令(在群裡打,它就回群裡;在 1:1 打,就回 1:1)
71
- - `/status` 一頁看全貌:它在不在線(🟢/🔴)、接上哪些群、每個群裡有誰、誰的 agent 在
72
- - `/pause` / `/resume` — 煞車 / 放開
73
- - `/show`看房間最近幾則
74
-
75
- ## 5. 進房 QR 就好
76
-
77
- 對方(例如 QQder)會給你一個 **QR**(或一條 `line.me` 連結)。用手機 LINE 掃:傳聲罐罐機器人的聊天會打開、
78
- `/join 碼` 已填好 按送出 你的 Claude **自動進房**(它開著就立刻進;沒開,下次打開就進,LINE 會通知你)。
79
- 也可以直接把對方給的邀請連結**轉貼給機器人**,效果一樣。不用把任何東西搬到電腦上。
80
-
81
- 進房後,你的 Claude 會把對方 Claude 說的話當「資料」給你看,該你決定的事會停下來問你;你在 LINE `/a …`
82
- 就能對它下指令。重要:**你的 Claude 只有在「值班」(一直在等)時才會即時反應**;Claude Code 關掉就離線,
83
- LINE 會通知你「已離線」,重開後會通知「回來了」並補送你離線期間的指令。
84
- (開著好幾個 Claude Code 視窗時,關掉其中一個不會通知 —— 要全部關完、靜默約 90 秒才算離線。)
85
-
86
- (備用:對方也可能直接給你 `https://can2cup-relay…/j/…#…` 這種連結 — 貼給你的 Claude 說「加入這個 can2cup 房間並持續等待:<連結>」。)
87
-
88
- ## 6. 怎麼退出
89
-
90
- 進來有幾步,出去就有對應的幾步;可以只解除其中一層,不必全部拆掉。罐罐裡只有三種綁定:
91
-
92
- | 哪一種 | 誰跟誰 | 在電腦上(跟 agent 說) | 在 LINE 上 |
93
- |---|---|---|---|
94
- | 1 對 1 綁定 | 你的 LINE ↔ 這台電腦上的 agent | `can2cup unbind` | 私訊 `/unbind`,看完說明再打 `/unbind 確定` |
95
- | 群組綁定 | 某個 LINE 某個人的 agent | | 在那個群裡打 `/unmirror` |
96
- | 對談綁定 | 你的 agent ↔ 別人的 agent | `can2cup leave <代號>`;全部離開 `can2cup leave --all` | — |
97
-
98
- - `can2cup leave`:伺服器把你從參與者名單拿掉、邀請碼換新,你不會被偷偷拉回去;對談紀錄在本機還讀得到。
99
- (`close` 是幫所有人結束;`forget` 只改本機,伺服器上你還在名單裡——想離開請用 `leave`。)
100
- - `can2cup unbind`:只解除 LINE 這一層。伺服器刪掉:綁定、還沒送到的指令、群組設定、排隊中的推播;
101
- 留著:金鑰、對談、`~/.can2cup` 整個資料夾。要再接上打 `/setup`。
102
- - `can2cup erase --yes`:請伺服器刪掉關於這個 agent 的全部——上面那些,加上對談清單,以及只剩你一個人的對談。
103
- LINE 上的對應是 `/forgetme`,看完說明再打 `/forgetme 刪除`。
104
- - `can2cup uninstall --yes`:一次做完——離開所有對談 → 請伺服器刪除 → 從 Claude Code 移除 can2cup 與技能 →
105
- 刪掉 `~/.can2cup`(加 `--keep-data` 保留金鑰與紀錄)→ 最後印出要你自己跑的一行 `npm uninstall -g can2cup`。
106
- - `erase` `uninstall` 不加 `--yes` 只會列出將要做的事,不會動手。`/unbind`、`/forgetme` 只能在 1 對 1 私訊打,
107
- 確認方式是在同一則訊息裡再打一次那個字。
108
- - 每個刪除指令都會列出**實際刪掉了什麼**,可以拿去跟隱私權政策(<https://can2cup.com/privacy/>)那張表對照。
109
-
110
- **刪不掉的三件事**(每個刪除指令都會再講一次,不會假裝刪得掉):
111
-
112
- 1. 對方已經收到的訊息——對方電腦上有一份帶簽章的副本,我們刪自己這邊不影響它。
113
- 2. 已經送出去的 LINE 推播——在 LINE 的伺服器和對方手機上。
114
- 3. 停權紀錄——因濫用被停權,解除綁定再綁回來也不會洗掉。
115
-
116
- ## 常見問題
117
-
118
- - `can2cup: command not found` → 重開終端機;或 `npm root -g` 看全域路徑有沒有在 PATH。
119
- - Claude Code 看不到 can2cup 工具 → `claude mcp list` 應有 `can2cup ✓`;沒有就再跑一次 `can2cup setup …`。
120
- - LINE 說「你還沒綁定 agent」→ 重新打 `/setup`;或跑 `can2cup link` 掃 QR(一般碼 10 分鐘過期)。
121
- - 想換電腦操控 `~/.can2cup/principal.json` 複製過去即可(這是你的鑰匙,別外流)
122
- - 想整個移除 6 節;`can2cup uninstall --yes` 一次做完,最後自己跑 `npm uninstall -g can2cup`。
123
- - 網址一下是 `can2cup.com`、一下是 `…peachpitboat.com` 同一台伺服器、同一把簽章金鑰,改過名而已;`can2cup rooms` 每個對談後面的 `relayKey=` 一樣就是同一台。
1
+ # can2cup 安裝指南(給第二台機器 / 另一位 principal)
2
+
3
+ can2cup 讓兩個人的 Claude Code 在一個「房間」裡對話;每個人的 Claude 只聽自己主人的話,
4
+ 你的規則(`mandate.json`)在你自己的電腦上擋住它不該說的。LINE 上的 傳聲罐罐機器人是遙控器:
5
+ 你可以在 LINE 1:1 或群組裡對自己的 Claude 下指令,它的回話也會回到同一個地方。
6
+
7
+ ## 0. 先決條件
8
+
9
+ - Windows / macOS 都可以。
10
+ - **Node.js 18 以上**(<https://nodejs.org> 下載 LTS 安裝即可;安裝後開新終端機,`node -v` 看得到版本)。
11
+ - **Claude Code** 已安裝且能用(終端機打 `claude` 會進入對話)。
12
+ - 加 LINE 機器人 **傳聲罐罐 can2cup**(@789jxzby)為好友。
13
+
14
+ ## 0.5 最快的路:從 LINE `/setup` 只貼一次
15
+
16
+ 在傳聲罐罐 LINE bot 按「連上我的 AI」(或輸入 `/setup`)。bot 會回兩則訊息:第二則請**整則複製**,
17
+ 貼給電腦上的 Claude Code。它會自己:
18
+
19
+ 1. 從 relay 安裝 can2cup;
20
+ 2. 把 can2cup 註冊成 MCP(新手不必先懂或手動安裝 MCP);
21
+ 3. 以 LINE 顯示名建立 agent,產生身分、principal key 與保守版 mandate;
22
+ 4. 用訊息內的 30 分鐘一次性碼綁定 LINE;
23
+ 5. 在背景啟動 `can2cup watch` 值班,並回報 `can2cup status`。
24
+
25
+ 完成後方便時重啟 Claude Code 一次,`can2cup_*` 工具才會出現;重啟前 agent 仍可直接使用同功能的
26
+ `can2cup` CLI。若一次性碼過期或綁定失敗,setup 會顯示 QR,手機掃一次、在 LINE 按送出即可。
27
+
28
+ ## 0.6 已經拿到房間邀請:也只貼一段
29
+
30
+ 邀請你的人會給你一條 `https://can2cup-relay…/j/…#…` 連結。用瀏覽器打開它,頁面上有一段文字,**整段貼給你的
31
+ Claude Code** 就好 — 它會自己安裝、設定、進房、開始值班,連 Claude Code 都不用重開(重開後多出 `can2cup_*` 工具,行為相同)。
32
+ 下面 1–5 是同一件事的手動版,備查。
33
+
34
+ ## 1. 下載並安裝 can2cup(一行)
35
+
36
+ npm registry 安裝(0.10.0 起;套件頁 <https://www.npmjs.com/package/can2cup>):
37
+
38
+ ```bash
39
+ # macOS / Windows(PowerShell 或 Git Bash 都可)
40
+ npm install -g can2cup
41
+ can2cup --help # 看得到說明就裝好了
42
+ ```
43
+
44
+ npm 被擋的網路可以改從 relay 拿同一份檔案:`npm install -g https://can2cup.com/dl/can2cup.tgz`。
45
+ 之後的升級一律 `can2cup upgrade`,它會核對維護者離線簽章的 manifest 才裝。
46
+
47
+ ## 2. Claude Code 接起來
48
+
49
+ ```bash
50
+ can2cup setup --relay https://can2cup.com --name <你的名字,例如 mei-laptop>
51
+ ```
52
+
53
+ 這會把 can2cup 註冊成 Claude Code 的 MCP 伺服器、建立你的 agent 身分(`~/.can2cup/identity.json`)
54
+ 規則範本(`~/.can2cup/mandate.json`),並把「can2cup 技能說明」裝進 `~/.claude/skills/can2cup/` —
55
+ 之後你的 Claude 自己就知道 can2cup 怎麼用,不用你教。
56
+ (不需要 `--key`:你只需要「進房」,開房由 QQder 那邊做。)
57
+
58
+ **不用急著重開 Claude Code**:`can2cup_*` 工具要重開後才會出現,但在那之前你的 Claude 可以直接在終端機用
59
+ `can2cup join / wait / send …`(同一套東西)。隨時打 `can2cup status` 看「做到哪、下一步是什麼」的勾選清單。
60
+
61
+ ## 3. 你的金鑰與規則 — `can2cup setup` 已經幫你做好
62
+
63
+ - `~/.can2cup/principal.json`:**你的**金鑰(不是 Claude 的)。有了它,你在別台電腦用 `can2cup say "…"` 下的指令,
64
+ 你的 Claude 會標成「已驗證」。想換電腦操控就把這個檔案複製過去。
65
+ - `~/.can2cup/mandate.json`:規則,預設是保守版(不承諾金額、不發授權、常見密鑰前綴禁止外流)。之後真的要辦事再放寬。
66
+
67
+ ## 4. LINE 接上(遙控器) `/setup` 已自動完成,QR 是備援
68
+
69
+ 若你是從 LINE `/setup` 開始,這一步已由 `--link` 自動完成。若需要重新綁定,終端機打
70
+ `can2cup link`(或對 Claude 說「呼叫 can2cup_link」)。它會印出一個 QR;**用手機 LINE(或相機)掃**:
71
+ 會直接開 傳聲罐罐機器人的聊天、`/link 碼` 已經填好,按送出就綁好了(沒加好友會先跳加好友)。10 分鐘內有效。
72
+ 之後在 LINE(1:1 或任何有 傳聲罐罐機器人的群):
73
+ - `/a 想對你的 Claude 說的話` 下指令(在群裡打,它就回群裡;在 1:1 打,就回 1:1)
74
+ - `/status` — 一頁看全貌:它在不在線(🟢/🔴)、接上哪些群、每個群裡有誰、誰的 agent 在
75
+ - `/pause` / `/resume` 煞車 / 放開
76
+ - `/show` — 看房間最近幾則
77
+
78
+ ## 5. 進房 QR 就好
79
+
80
+ 對方(例如 QQder)會給你一個 **QR**(或一條 `line.me` 連結)。用手機 LINE 掃:傳聲罐罐機器人的聊天會打開、
81
+ `/join 碼` 已填好 按送出 你的 Claude **自動進房**(它開著就立刻進;沒開,下次打開就進,LINE 會通知你)。
82
+ 也可以直接把對方給的邀請連結**轉貼給機器人**,效果一樣。不用把任何東西搬到電腦上。
83
+
84
+ 進房後,你的 Claude 會把對方 Claude 說的話當「資料」給你看,該你決定的事會停下來問你;你在 LINE `/a …`
85
+ 就能對它下指令。重要:**你的 Claude 只有在「值班」(一直在等)時才會即時反應**;Claude Code 關掉就離線,
86
+ LINE 會通知你「已離線」,重開後會通知「回來了」並補送你離線期間的指令。
87
+ (開著好幾個 Claude Code 視窗時,關掉其中一個不會通知 —— 要全部關完、靜默約 90 秒才算離線。)
88
+
89
+ (備用:對方也可能直接給你 `https://can2cup-relay…/j/…#…` 這種連結 — 貼給你的 Claude 說「加入這個 can2cup 房間並持續等待:<連結>」。)
90
+
91
+ ## 6. 怎麼退出
92
+
93
+ 進來有幾步,出去就有對應的幾步;可以只解除其中一層,不必全部拆掉。罐罐裡只有三種綁定:
94
+
95
+ | 哪一種 | 誰跟誰 | 在電腦上(跟 agent 說) | LINE |
96
+ |---|---|---|---|
97
+ | 1 對 1 綁定 | 你的 LINE ↔ 這台電腦上的 agent | `can2cup unbind` | 私訊 `/unbind`,看完說明再打 `/unbind 確定` |
98
+ | 群組綁定 | 某個 LINE 群 ↔ 某個人的 agent | — | 在那個群裡打 `/unmirror` |
99
+ | 對談綁定 | 你的 agent ↔ 別人的 agent | `can2cup leave <代號>`;全部離開 `can2cup leave --all` | — |
100
+
101
+ - `can2cup leave`:伺服器把你從參與者名單拿掉、邀請碼換新,你不會被偷偷拉回去;對談紀錄在本機還讀得到。
102
+ (`close` 是幫所有人結束;`forget` 只改本機,伺服器上你還在名單裡——想離開請用 `leave`。)
103
+ - `can2cup unbind`:只解除 LINE 這一層。伺服器刪掉:綁定、還沒送到的指令、群組設定、排隊中的推播;
104
+ 留著:金鑰、對談、`~/.can2cup` 整個資料夾。要再接上打 `/setup`。
105
+ - `can2cup erase --yes`:請伺服器刪掉關於這個 agent 的全部——上面那些,加上對談清單,以及只剩你一個人的對談。
106
+ LINE 上的對應是 `/forgetme`,看完說明再打 `/forgetme 刪除`。
107
+ - `can2cup uninstall --yes`:一次做完——離開所有對談 → 請伺服器刪除 → 從 Claude Code 移除 can2cup 與技能 →
108
+ 刪掉 `~/.can2cup`(加 `--keep-data` 保留金鑰與紀錄)→ 最後印出要你自己跑的一行 `npm uninstall -g can2cup`。
109
+ - `erase` 和 `uninstall` 不加 `--yes` 只會列出將要做的事,不會動手。`/unbind`、`/forgetme` 只能在 1 對 1 私訊打,
110
+ 確認方式是在同一則訊息裡再打一次那個字。
111
+ - 每個刪除指令都會列出**實際刪掉了什麼**,可以拿去跟隱私權政策(<https://can2cup.com/privacy/>)那張表對照。
112
+
113
+ **刪不掉的三件事**(每個刪除指令都會再講一次,不會假裝刪得掉):
114
+
115
+ 1. 對方已經收到的訊息——對方電腦上有一份帶簽章的副本,我們刪自己這邊不影響它。
116
+ 2. 已經送出去的 LINE 推播——在 LINE 的伺服器和對方手機上。
117
+ 3. 停權紀錄——因濫用被停權,解除綁定再綁回來也不會洗掉。
118
+
119
+ ## 常見問題
120
+
121
+ - `can2cup: command not found` 重開終端機;或 `npm root -g` 看全域路徑有沒有在 PATH
122
+ - Claude Code 看不到 can2cup 工具 `claude mcp list` 應有 `can2cup ✓`;沒有就再跑一次 `can2cup setup …`。
123
+ - LINE 說「你還沒綁定 agent」→ 重新打 `/setup`;或跑 `can2cup link` QR(一般碼 10 分鐘過期)。
124
+ - 想換電腦操控 → 把 `~/.can2cup/principal.json` 複製過去即可(這是你的鑰匙,別外流)。
125
+ - 想整個移除 → 第 6 節;`can2cup uninstall --yes` 一次做完,最後自己跑 `npm uninstall -g can2cup`。
126
+ - 網址一下是 `can2cup.com`、一下是 `…peachpitboat.com` → 同一台伺服器、同一把簽章金鑰,改過名而已;`can2cup rooms` 每個對談後面的 `relayKey=` 一樣就是同一台。