nonebot/nb-cli

NB CLI

✨ NoneBot2 命令行工具 ✨

功能特性

• 创建新的 NoneBot 项目
• 启动 NoneBot 应用
• 管理插件：创建新插件、搜索/安装/更新/卸载官方商店插件
• 管理适配器：创建新适配器、搜索/安装/更新/卸载官方商店适配器
• 管理驱动器：搜索/安装/更新/卸载官方商店驱动器
• 支持 CLI 插件扩展和运行自定义脚本

使用场景

适用于 NoneBot2 开发者的项目初始化、日常开发、插件/适配器管理及应用部署流程，提供命令行与交互式两种操作模式，支持 Docker 容器化运行。

使用方法

安装方式

pipx 安装

shell
pipx install nb-cli

Docker 镜像使用

拉取镜像：

shell
docker pull nonebot/nb-cli:latest

镜像版本说明：

• latest/latest-slim：最新稳定版
• latest-${python版本}/latest-${python版本}-slim：指定 Python 版本的最新稳定版
• ${cli版本}/${cli版本}-slim：指定 CLI 版本的稳定版
• ${cli版本}-${python版本}/${cli版本}-${python版本}-slim：指定 CLI 与 Python 版本的稳定版

Docker 部署方案示例

1. 拉取最新镜像：

shell
docker pull nonebot/nb-cli:latest

2. 交互式运行（挂载当前目录至容器工作区）：

shell
docker run --rm -it -v $(pwd):/workspaces nonebot/nb-cli:latest

3. 命令行模式执行操作（如创建项目）：

shell
docker run --rm -it -v $(pwd):/workspaces nonebot/nb-cli:latest create

基础命令使用

查看帮助：

shell
nb --help

核心命令：

• nb create (init)：初始化新 NoneBot 项目
• nb run：启动当前目录项目
• nb generate：生成项目启动脚本
• nb plugin [subcommand]：插件管理（create/install/update/uninstall/search）
• nb adapter [subcommand]：适配器管理（create/install/update/uninstall/search）
• nb driver [subcommand]：驱动器管理（install/update/uninstall/search）
• nb self：CLI 环境管理
• nb <script>：运行项目脚本

注意：若系统提示找不到 nb 命令，执行 pipx ensurepath 添加环境变量路径

交互式模式

直接运行 nb 进入交互式控制台：

shell
nb

开发支持

翻译功能

• 生成翻译模板：pdm run extract
• 初始化/更新语言文件：pdm run init en_US
• 更新翻译内容：pdm run update
• 编译翻译文件：pdm run compile