diff --git a/README.md b/README.md index fb18c1e..56505e2 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,31 @@ telegram-codex-bot start # 先做環境檢查(codex/登入/pm2/git),再 | 🤖 Bot 管理 | 新增/編輯(token、目錄用原生視窗選、沙盒、模型/推理強度/速度下拉、逾時)、啟動/停止/重啟、log、刪除 | | 📊 PM2 | 整台機器所有 pm2 程序:狀態、監聽 port(可點)、CPU、記憶體、out/err log、啟停/重啟/刪除 | +### 圖文使用說明 + +**① Bot 管理首頁** — 每個 bot 一列:狀態、工作目錄、沙盒與模型設定、遮罩後的 token。 +右側按鈕:▶ 啟動 / ⏹ 停止、🔄 重啟、📄 log、✏️ 編輯、🗑 刪除。上方橫幅提醒群組使用要先關 Group Privacy。 + +![Bot 管理首頁](docs/01-bots.png) + +**② 新增 Bot** — 按右上「➕ 新增 Bot」: + +1. **名稱**:也是 pm2 程序名,建立後不可改 +2. **Token**:貼上 BotFather 給的 token,儲存時自動打 Telegram 驗證,無效會警告 +3. **工作目錄**:按「📂 瀏覽…」會在這台機器桌面跳出原生資料夾視窗,選完自動帶入 +4. **模型 / 推理強度 / 速度**:下拉選單,預設值自動帶你機器上 codex 的全域設定;清單讀自本機 codex 模型快取,換模型時強度選項會連動(如 ultra 只有支援的模型才出現) +5. 勾「建立後立即啟動」→ 儲存,bot 就上線了 + +![新增 Bot 表單](docs/02-create.png) + +**③ PM2 分頁** — 整台機器所有 pm2 程序。Port 可直接點開對應網頁,右側可啟停/重啟/刪除任何程序。 + +![PM2 分頁](docs/03-pm2.png) + +**④ Log 檢視** — 點任一程序的「📄 out」/「⚠ err」,下方展開尾端 200 行,可勾自動更新(5s)。 + +![Log 檢視](docs/04-log.png) + - 兩個分頁每 5 秒自動更新 - Bot 設定存於 `~/.tgcodex/bots/<名稱>/tgcodex.config.json`,bot 掛 pm2 的程序名 = bot 名稱 - 預設只綁 `127.0.0.1`。這個介面能控制 pm2 且存有 token,**不要裸露到外網**; diff --git a/docs/01-bots.png b/docs/01-bots.png new file mode 100644 index 0000000..600a748 Binary files /dev/null and b/docs/01-bots.png differ diff --git a/docs/02-create.png b/docs/02-create.png new file mode 100644 index 0000000..2c9def7 Binary files /dev/null and b/docs/02-create.png differ diff --git a/docs/03-pm2.png b/docs/03-pm2.png new file mode 100644 index 0000000..8d3a4e3 Binary files /dev/null and b/docs/03-pm2.png differ diff --git a/docs/04-log.png b/docs/04-log.png new file mode 100644 index 0000000..556633c Binary files /dev/null and b/docs/04-log.png differ