Skip to content

Commit dbb2dbb

Browse files
committed
docs: 优化 README 与开发规范
- 修正插件仓库徽章名(TeleBox-Plugins) - 补全内置插件列表,sysinfo 更正为 status - switch 描述改为 Classic ↔ Next - 依赖版本与 package.json 对齐
1 parent 5923302 commit dbb2dbb

2 files changed

Lines changed: 50 additions & 9 deletions

File tree

‎README.md‎

Lines changed: 49 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ sudo 权限分配和用户管理
9494
│ │ ├── 👑 sudo.ts # 权限管理
9595
│ │ ├── 💻 exec.ts # Shell 执行
9696
│ │ ├── 🏓 ping.ts # 网络测试
97-
│ │ ├── 📊 sysinfo.ts # 系统信息
97+
│ │ ├── 📊 status.ts # 运行状态
9898
│ │ └── 🔧 ... # 其他内置插件
9999
│ └── 🛠️ utils/ # 工具库
100100
│ ├── ⚙️ pluginManager.ts # 插件管理核心
@@ -241,9 +241,9 @@ abstract class Plugin {
241241
<td>🌐 网络延迟测试工具</td>
242242
</tr>
243243
<tr>
244-
<td><strong>📊 sysinfo</strong></td>
245-
<td><code>sysinfo</code></td>
246-
<td>📈 系统信息监控</td>
244+
<td><strong>📊 status</strong></td>
245+
<td><code>status</code></td>
246+
<td>📡 运行状态与 generation 信息</td>
247247
</tr>
248248
<tr>
249249
<td><strong>🏷️ alias</strong></td>
@@ -280,6 +280,47 @@ abstract class Plugin {
280280
<td><code>sure</code></td>
281281
<td>🤔 确认操作工具</td>
282282
</tr>
283+
284+
<tr>
285+
<td><strong>🔀 switch</strong></td>
286+
<td><code>switch</code></td>
287+
<td>🔁 Classic / Next 版本切换</td>
288+
</tr>
289+
<tr>
290+
<td><strong>🔧 autofix</strong></td>
291+
<td><code>autofix</code></td>
292+
<td>🛠️ 一键修复:清理重名插件、硬同步代码、重启并更新插件</td>
293+
</tr>
294+
<tr>
295+
<td><strong>💾 save</strong></td>
296+
<td><code>save</code></td>
297+
<td>📌 会话/配置保存相关工具</td>
298+
</tr>
299+
<tr>
300+
<td><strong>📥 leech</strong></td>
301+
<td><code>leech</code></td>
302+
<td>📚 历史消息抓取与归档</td>
303+
</tr>
304+
<tr>
305+
<td><strong>🤖 agent</strong></td>
306+
<td><code>agent</code></td>
307+
<td>🧠 内置 Agent 能力</td>
308+
</tr>
309+
<tr>
310+
<td><strong>🏷️ version</strong></td>
311+
<td><code>version</code></td>
312+
<td>📋 版本信息</td>
313+
</tr>
314+
<tr>
315+
<td><strong>🔤 prefix</strong></td>
316+
<td><code>prefix</code></td>
317+
<td>✏️ 命令前缀管理</td>
318+
</tr>
319+
<tr>
320+
<td><strong>🪵 loglevel</strong></td>
321+
<td><code>loglevel</code></td>
322+
<td>🎚️ 日志级别管理</td>
323+
</tr>
283324
</tbody>
284325
</table>
285326

@@ -305,7 +346,7 @@ abstract class Plugin {
305346
306347
<div align="center">
307348

308-
[![Plugin Repository](https://img.shields.io/badge/🔌_插件仓库-TeleBox__Plugins-blue?style=for-the-badge)](https://github.com/TeleBoxOrg/TeleBox-Plugins)
349+
[![Plugin Repository](https://img.shields.io/badge/🔌_插件仓库-TeleBox--Plugins-blue?style=for-the-badge)](https://github.com/TeleBoxOrg/TeleBox-Plugins)
309350

310351
</div>
311352

@@ -317,10 +358,10 @@ abstract class Plugin {
317358
| :----------------: | :------------------: | :---------: |
318359
| 🚀 **运行时** | Node.js | `24.x` |
319360
| 💎 **开发语言** | TypeScript | `^5.9.2` |
320-
| 📡 **Telegram 库** | Teleproto | `^1.227.1` |
361+
| 📡 **Telegram 库** | Teleproto | `^1.228.0` |
321362
| 💾 **数据库** | better-sqlite3 | `^12.2.0` |
322363
| 💾 **数据库** | lowdb | `^7.0.1` |
323-
| ⚡ **构建工具** | tsx + tsconfig-paths | `^4.20.4` |
364+
| ⚡ **构建工具** | tsx + tsconfig-paths | `^4.22.4` |
324365
| 🌐 **HTTP 客户端** | axios | `^1.11.0` |
325366
| 🖼️ **图像处理** | sharp | `^0.34.3` |
326367
| 🧰 **工具库** | lodash | `^4.17.21` |
@@ -390,7 +431,7 @@ npm run dev
390431

391432
[![主仓库](https://img.shields.io/badge/📦_主仓库-TeleBox-blue?style=for-the-badge&logo=github)](https://github.com/TeleBoxOrg/TeleBox)
392433

393-
[![插件仓库](https://img.shields.io/badge/🔌_插件仓库-TeleBox__Plugins-green?style=for-the-badge&logo=github)](https://github.com/TeleBoxOrg/TeleBox-Plugins)
434+
[![插件仓库](https://img.shields.io/badge/🔌_插件仓库-TeleBox--Plugins-green?style=for-the-badge&logo=github)](https://github.com/TeleBoxOrg/TeleBox-Plugins)
394435

395436
</td>
396437
<td align="center" width="20%">

‎TELEBOX_DEVELOPMENT.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,7 @@ run();
316316
| `status.ts` | 系统状态(PM2、版本、内存、generation) |
317317
| `sudo.ts` | 权限管理 |
318318
| `sure.ts` | 确认操作 |
319-
| `switch.ts` | 版本切换(teleproto ↔ mtcute) |
319+
| `switch.ts` | 版本切换(Classic ↔ Next) |
320320
| `tpm.ts` | 插件包管理器 |
321321
| `update.ts` | 更新管理(含自动更新功能) |
322322

0 commit comments

Comments
 (0)