nonebot2/website/docs/start/nb-cli.md

sidebar_position, description, options

sidebar_position	description	options
90	使用 nb-cli 帮助开发	menu weight category 11 guide

使用脚手架

安装

pip install nb-cli

初次使用

在安装完成之后，即可在命令行使用 nb-cli 的命令 nb 进行开发：

# 直接使用 nb 命令
nb
# 或使用 Python 执行 module
python -m nb_cli

:::warning 注意 通常情况下，你可以直接在命令行使用 nb 命令，但如果命令行出现 Command not found 错误，这是由于环境变量 PATH 没有正确配置或未配置导致的，可以使用第二种方式代替。 :::

使用方式

nb-cli 具有两种使用方式：

1. 命令行指令

   查看帮助信息：

   $ nb --help
   Usage: nb [OPTIONS] COMMAND [ARGS]...
   
   Options:
     -V, --version  Show the version and exit.
     --help         Show this message and exit.
   
   ...
   

   查看子命令帮助：

   $ nb plugin --help
   Usage: nb plugin [OPTIONS] COMMAND [ARGS]...
   
     Manage Bot Plugin.
   
   Options:
     --help  Show this message and exit.
   
   ...
   

2. 交互式选择（支持鼠标）

   交互式选择菜单：

   $ nb
   Welcome to NoneBot CLI!
   [?] What do you want to do? (Use ↑ and ↓ to choose, Enter to submit)
   ...
   

   交互式子命令菜单：

   $ nb plugin
   [?] What do you want to do? (Use ↑ and ↓ to choose, Enter to submit)
   ...