CLI
约 892 字大约 3 分钟
2025-03-05
简介
NcatBot CLI 是一个命令行工具，用于管理和控制 NcatBot 的运行。它提供了丰富的命令来管理插件、配置机器人以及执行各种系统操作。
快速开始
启动 CLI
确保当前 Python 环境已安装 NcatBot。
执行以下命令启动 CLI：
python -m ncatbot.cli.main [path]其中 [path] 是一个可选参数，用于指定 CLI 工作目录，默认工作目录为执行此命令的目录。
直接执行命令
CLI 支持不进入交互模式直接执行命令：
python -m ncatbot.cli.main -c "命令" [-a] [参数...]例如：
# 直接启动 NcatBot
python -m ncatbot.cli.main -c start
# 安装插件
python -m ncatbot.cli.main -c install -a TestPlugin
# 列出已安装插件
python -m ncatbot.cli.main -c list
# 创建一个模板插件(名为 MyPlugin)
python -m ncatbot.cli.main -c new -a MyPlugin首次运行
首次运行 CLI 时：
- 系统会提示设置 QQ 号
- 自动安装
TestPlugin插件用于测试 - 创建必要的工作目录结构
命令系统
CLI 采用命令注册系统，所有命令都通过装饰器注册到全局命令注册表中。每个命令都包含以下信息：
- 命令名称
- 命令描述
- 使用说明
- 帮助文本
- 命令别名
系统命令
start
- 用法：
start - 别名：
s,run - 描述：启动 NcatBot
setqq
- 用法：
setqq - 别名：
qq - 描述：设置或更新 QQ 号
update
- 用法：
update - 别名：
u,upgrade - 描述：更新 NcatBot 和 NapCat
- 功能：
- 更新 NapCat 版本
- 从阿里源更新 NcatBot
- 更新完成后需要重新启动 CLI
exit
- 用法：
exit - 别名：
quit,q - 描述：退出 CLI 工具
插件管理命令
install
- 用法：
install <插件名> [--fix] - 别名：
i - 描述：安装或更新插件
- 参数：
--fix：尝试修复安装失败的插件，或者尝试覆盖安装
remove
- 用法：
remove <插件名> - 别名：
r,uninstall - 描述：卸载指定插件
list
- 用法：
list - 别名：
l,ls - 描述：列出已安装的插件及其版本
list_remote
- 用法：
list_remote - 别名：
lr - 描述：列出远程仓库中可用的插件
create
- 用法：
create <插件名> - 别名：
new,template - 描述：创建新的插件模板
- 功能：
- 创建插件目录结构
- 生成基本代码文件
- 创建配置文件
- 生成 README 文档
信息命令
help
- 用法：
help [命令名] - 别名：
h,? - 描述：显示命令帮助信息
- 参数：
命令名：显示指定命令的详细帮助
version
- 用法：
version - 别名：
v,ver - 描述：显示 NcatBot 版本信息
工作目录结构
CLI 的工作目录包含以下内容：
plugins/ # 插件目录
| ├── plugin1/ # 插件1
| └── plugin2/ # 插件2
├── number.txt # QQ 号配置文件
└── logs/ # 日志目录插件开发
创建新插件
使用 create 命令创建新插件模板：
create MyPlugin或者不进入 CLI 直接执行命令
python -m ncatbot.cli -c create MyPlugin这将创建一个包含以下文件的插件模板，插件名为 MyPlugin：
__init__.py：插件入口文件main.py：插件主文件README.md：插件文档.gitignore：Git 忽略文件requirements.txt：依赖项文件
插件模板结构
插件模板包含以下基本功能：
- 群消息事件处理
- 私聊消息事件处理
- 配置项管理
- 功能注册系统
注意事项
- 确保在使用 CLI 前已正确安装 NcatBot
- 建议使用稳定的网络环境进行插件安装和更新
- 定期使用
update命令保持 NcatBot 为最新版本 - 插件安装失败时，可以尝试使用
--fix参数进行修复
版权所有
版权归属：huan-yp