Skip to content

nonebot/nb-cli

Repository files navigation

nonebot

NB CLI

✨ NoneBot2 命令行工具 ✨

license pypi python site pre-commit
QQ Chat Group QQ Channel Telegram Channel Discord Server

文档 · 安装 · NoneBot 文档

功能

  • 创建新的 Nonebot 项目
  • 启动 Nonebot
  • 管理插件
    • 创建新的插件
    • 搜索/安装/更新/卸载在官方商店上发布的插件
  • 管理适配器
    • 创建新的适配器
    • 搜索/安装/更新/卸载在官方商店上发布的适配器
  • 管理驱动器
    • 搜索/安装/更新/卸载在官方商店上发布的驱动器
  • 支持 CLI 插件和运行脚本

使用

完整使用文档请参考 文档

安装

使用 pipx 安装

pipx install nb-cli

使用 Docker 运行

docker pull nonebot/nb-cli:latest

Docker 镜像可以选择以下版本:

  • latest, latest-slim:最新的稳定版本
  • latest-${python版本}, latest-${python版本}-slim:指定 Python 版本的最新稳定版本
  • ${cli版本}, ${cli版本}-slim:指定 CLI 版本的最新稳定版本
  • ${cli版本}-${python版本}, ${cli版本}-${python版本}-slim:指定 CLI 和 Python 版本的最新稳定版本

命令行使用

nb --help

Warning

如果找不到 nb 命令,请尝试 pipx ensurepath 来添加路径到环境变量

  • nb create (init) 创建新的 NoneBot 项目
  • nb run 在当前目录启动 NoneBot
  • nb generate 在当前目录生成启动脚本
  • nb driver 管理驱动器
  • nb plugin 管理插件
  • nb adapter 管理适配器
  • nb self 管理 CLI 内部环境
  • nb <script> 运行脚本

Docker 镜像使用

docker run --rm -it -v ./:/workspaces nonebot/nb-cli:latest --help

挂载当前目录到容器的 /workspaces 目录,然后在容器中运行 nb 命令。

交互式使用

nb

Docker 镜像使用

docker run --rm -it -v ./:/workspaces nonebot/nb-cli:latest

开发

翻译

生成模板

pdm run extract

初始化语言翻译文件或者更新现有语言翻译文件

pdm run init en_US

更新语言翻译文件

pdm run update

编译语言翻译文件

pdm run compile