正在加载插件详情…
在聊天中增删指令,调整帮助菜单显示内容
数据截至 2026/11/18 · 周下载取自 npm 全网(含 CI / 镜像),非本站安装数;综合分由星标、活跃度与兼容性检查合成。
git clone https://github.com/NXTSL/koishi-plugin-help-manage.git一键管理 Koishi help 中显示的命令:列出 / 添加 / 删除(Manage commands shown in Koishi's help menu)
koishi-plugin-help-manage
一键管理 Koishi help 中显示的命令:列出 / 添加 / 删除。
Koishi 的 help 只显示满足条件的指令:必须是顶层指令(parent === null),没有被 hidden 隐藏,且在当前上下文可用。
有些插件会把根指令错误地挂成子指令(例如某些指令名带数字的插件),或干脆不提供描述,导致 help 里看不到它们。
本插件提供一个统一入口,让你在聊天里直接管理 help 的显示内容,无需改代码、无需重启。
特性
- 列出:查看当前 help 显示 / 隐藏的全部指令及其描述
- 添加:把指令加入 help 显示;如果该指令被错误挂载到其他指令下,会自动重新挂到顶层;如果指令不存在,会自动创建一个占位指令
- 删除:把指令从 help 显示中移除(真正的指令仍然可用,只是不出现在帮助里)
- 改描述:添加时可顺便覆盖指令在 help 中显示的描述
- 持久化:所有改动写入 data/help-manage.json,重启后自动恢复
- 可撤销:reset 一键恢复默认(含恢复被覆盖的描述)
安装
本插件不发布到 npm,只支持手动安装或一键脚本安装。
一键安装脚本(推荐)
下载脚本(GitHub 访问慢时可用第二行的镜像)
curl -fsSL -o install.sh https://raw.githubusercontent.com/NXTSL/koishi-plugin-help-manage/main/install.sh
curl -fsSL -o install.sh https://cdn.jsdelivr.net/gh/NXTSL/koishi-plugin-help-manage@main/install.sh
本地部署:传入 Koishi 根目录(该目录下有 koishi.yml) bash install.sh /path/to/koishi
Docker 部署:默认容器名 koishi、容器内路径 /koishi bash install.sh --docker koishi
只复制文件、不自动重启 bash install.sh --docker koishi --no-restart
脚本做的事:
1. 从 GitHub 下载最新 index.js 与 package.json(失败时自动切换 jsDelivr / ghfast 镜像)
2. 复制到 <Koishi 根目录>/node_modules/koishi-plugin-help-manage
3. 在 koishi.yml 的 plugins: 下补一行 help-manage: {}(会先备份为 koishi.yml.bak.<时间>,已存在则跳过)
4. Docker 模式下自动重启容器
其他参数:
| 参数 | 说明 |
| --dir <path> | 指定 Koishi 根目录(Docker 模式下为容器内路径) |
| --no-restart | 不自动重启 |
| KOISHI_HELP_MANAGE_REF=<ref> | 指定分支 / 标签,默认 main |
手动安装
1. 获取源码:git clone https://github.com/NXTSL/koishi-plugin-help-manage.git,或直接下载 ZIP 解压
2. 把整个目录复制到 Koishi 的 node_modules/koishi-plugin-help-manage
3. 在 koishi.yml 的插件列表中加入:
plugins:
help-manage: {}
4. 重启 Koishi
Docker 部署可以这样:
docker exec -it koishi mkdir -p /koishi/node_modules/koishi-plugin-help-manage
docker cp ./koishi-plugin-help-manage/. koishi:/koishi/node_modules/koishi-plugin-help-manage/
docker restart koishi
需要 Koishi v4.18 及以上。
配置项
| 配置 | 类型 | 默认值 | 说明 |
| authority | number | 4 | 使用管理指令所需的最低权限等级 |
指令
| 指令 | 说明 |
| help-manage list | 列出当前 help 中显示 / 隐藏的指令 |
| help-manage add <指令名> [描述] | 把指令加入 help 显示,可顺便修改描述 |
| help-manage remove <指令名> | 把指令从 help 显示中移除 |
| help-manage reset | 恢复默认,清空所有自定义 |
别名:帮助管理、helpedit;list 也可以用 help-manage ls。
使用示例
help-manage list
help 显示的指令(共 12 个): 60s 60sAPI 插件 channel 频道管理 ... 已隐藏(共 1 个): timer 定时器信息
help-manage remove timer
🗑️ 已从 help 显示中移除:timer
help-manage add timer 定时器信息 ✅ 已加入 help 显示:timer 定时器信息
help-manage add 60s 60sAPI 插件 ✅ 已加入 help 显示:60s 60sAPI 插件
help-manage reset
♻️ 已恢复默认的 help 显示。
实现原理
- help 只遍历 ctx.$commander._commandList 中 parent === null 的指令,并跳过 config.hidden 为真的指令;
- 添加:把目标指令的 parent 置为 null,并把 config.hidden 设为 false;
- 删除:把目标指令的 config.hidden 设为 true;
- 改描述:写入 i18n 的空语言层('')中的 commands.<指令名>.description。Koishi 创建指令时也会把默认描述写在这一层,所以这里是优先级最高、覆盖最稳的位置;
- 状态保存在 <baseDir>/data/help-manage.json,插件 ready 时自动应用。
数据文件
{
"hidden": ["timer"],
"added": [
{
"name": "timer",
"created": false,
"originalDescription": "定时器信息", "description": "定时器信息" } ] }
贡献者
- NXTSL
- Koishi
License
MIT在聊天中增删指令,调整帮助菜单显示内容
本站实装验证(真实安装 L4 覆盖全站;L5 为运行时冒烟或实机截图,覆盖范围小于 L4) · 验证所用 dsh 版本 · 静态安装检查 · 风险分级 · 仓库维护状态。 下方各区块是它的证据明细。