启动 CLI

确保当前 Python 环境安装了 NcatBot.

执行 python -m ncatbot.cli.main [path] 可以启动 CLI, [path] 是一个可选参数, 用于指定 CLI 工作目录.

默认工作目录是 ./ncatbot, 你需要先自行创建它或者干脆使用 python -m ncatbot.cli.main ./ 将当前目录(或者别的目录)指定为工作目录.

工作目录会用于存放插件文件夹, 插件数据, 日志等必要的文件.

启动 NcatBot

第一次进入 CLI 时, 会提示设置 QQ 号. 后续启动时无需再次设置. 在 CLI 中也可以用 setqq 修改 QQ 号.

第一次进入 CLI 时还会自动安装 TestPlugin 插件, 用于测试 NcatBot 的基本功能, 后续可以使用 remove TestPlugin 卸载插件.

启动后输出以下提示信息:

工作目录:  C:\Users\huany\Desktop\Projects\QQ-Bot\backend
欢迎使用 NcatBot CLI!
当前 QQ 号为: 123456
支持的命令:
1. 'install <插件名> [--fix]' - 安装插件
2. 'setqq' - 重新设置 QQ 号
3. 'start' - 启动 NcatBot
4. 'update' - 更新 NcatBot
5. 'remove <插件名> ' - 卸载插件
6. 'list' - 列出已安装插件
7. 'exit' - 退出 CLI 工具
请输入命令:

在 CLI 中输入 start 并回车即可启动 NcatBot.

NcatBot-CLI 命令

install <插件名> [--fix]

对于已经发布到插件商店的插件, 可以使用 CLI 的 install 命令自动安装.

例如查看插件列表找到已有的插件 TestPlugin 后, 可以使用 install TestPlugin 命令安装插件.

--fix 是一个可选参数, 用于尝试修复没有被正确安装的插件.

start

启动 NcatBot.

update

更新 NcatBot. 会使用 pip 从阿里源(https://mirrors.aliyun.com/pypi/simple/)安装最新版本的 NcatBot, 安装之后会关闭 CLI.

版权所有

版权归属：huan-yp

许可证：署名 4.0 国际 (CC-BY-4.0)