發佈 0.1.3:README 圖片改公開網址、安裝說明補公開 registry

摘要:
README 截圖改指向 jianmiau.ddns.net(公開 repo,免登入可看),
兩邊套件頁的圖都能正常顯示;安裝說明補上公開 registry 的裝法。

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
2026-08-04 17:09:08 +08:00
co-authored by Claude Fable 5
parent 7b9bc0ea5b
commit ef9fcb9d4a
2 changed files with 12 additions and 11 deletions
+11 -10
View File
@@ -20,18 +20,19 @@
## 快速開始
套件不在官方 npmjs 上,安裝要指定 `--registry`(擇一,公開站不用登入):
```bash
# 套件發佈在公司的 npm registry(不是官方 npmjs),安裝要指定 --registry
# 公開 registry
npm install -g telegram-codex-bot --registry=https://jianmiau.ddns.net/api/packages/AI/npm/
# 或:公司內部 registry(需 git.catan.com.tw 帳號)
npm install -g telegram-codex-bot --registry=https://git.catan.com.tw/api/packages/Frontend/npm/
telegram-codex-bot start # 先做環境檢查(codex/登入/pm2/git),再把控制台掛上 pm2
```
之後升級同樣帶 `--registry`:
```bash
npm update -g telegram-codex-bot --registry=https://git.catan.com.tw/api/packages/Frontend/npm/
```
之後升級同樣帶 `--registry`(`npm update -g telegram-codex-bot --registry=...`)。
打開 **http://localhost:3799** →「🤖 Bot 管理」→「➕ 新增 Bot」:
@@ -58,7 +59,7 @@ npm update -g telegram-codex-bot --registry=https://git.catan.com.tw/api/package
**① Bot 管理首頁** — 每個 bot 一列:狀態、工作目錄、沙盒與模型設定、遮罩後的 token。
右側按鈕:▶ 啟動 / ⏹ 停止、🔄 重啟、📄 log、✏️ 編輯、🗑 刪除。上方橫幅提醒群組使用要先關 Group Privacy。
![Bot 管理首頁](https://git.catan.com.tw/Frontend/telegram-codex-bot/media/branch/master/docs/01-bots.png)
![Bot 管理首頁](https://jianmiau.ddns.net/AI/telegram-codex-bot/media/branch/master/docs/01-bots.png)
**② 新增 Bot** — 按右上「➕ 新增 Bot」:
@@ -68,15 +69,15 @@ npm update -g telegram-codex-bot --registry=https://git.catan.com.tw/api/package
4. **模型 / 推理強度 / 速度**:下拉選單,預設值自動帶你機器上 codex 的全域設定;清單讀自本機 codex 模型快取,換模型時強度選項會連動(如 ultra 只有支援的模型才出現)
5. 勾「建立後立即啟動」→ 儲存,bot 就上線了
![新增 Bot 表單](https://git.catan.com.tw/Frontend/telegram-codex-bot/media/branch/master/docs/02-create.png)
![新增 Bot 表單](https://jianmiau.ddns.net/AI/telegram-codex-bot/media/branch/master/docs/02-create.png)
**③ PM2 分頁** — 整台機器所有 pm2 程序。Port 可直接點開對應網頁,右側可啟停/重啟/刪除任何程序。
![PM2 分頁](https://git.catan.com.tw/Frontend/telegram-codex-bot/media/branch/master/docs/03-pm2.png)
![PM2 分頁](https://jianmiau.ddns.net/AI/telegram-codex-bot/media/branch/master/docs/03-pm2.png)
**④ Log 檢視** — 點任一程序的「📄 out」/「⚠ err」,下方展開尾端 200 行,可勾自動更新(5s)。
![Log 檢視](https://git.catan.com.tw/Frontend/telegram-codex-bot/media/branch/master/docs/04-log.png)
![Log 檢視](https://jianmiau.ddns.net/AI/telegram-codex-bot/media/branch/master/docs/04-log.png)
- 兩個分頁每 5 秒自動更新
- Bot 設定存於 `~/.tgcodex/bots/<名稱>/tgcodex.config.json`,bot 掛 pm2 的程序名 = bot 名稱