mirror of
https://github.com/nonebot/nonebot2.git
synced 2024-11-27 18:45:05 +08:00
📝 add nb-cli doc
This commit is contained in:
parent
956ee7e321
commit
482fba234b
14
README.md
14
README.md
@ -156,12 +156,14 @@ NoneBot2 不是 NoneBot1 的替代品。事实上,它们都在被积极的维
|
||||
|
||||
`NoneBot` 采用 `MIT` 许可证进行开源
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
```text
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
```
|
||||
|
||||
## 贡献
|
||||
|
||||
|
@ -10,4 +10,75 @@ options:
|
||||
|
||||
# 使用脚手架
|
||||
|
||||
<!-- TODO: nb-cli docs -->
|
||||
## 安装
|
||||
|
||||
```bash
|
||||
pip install nb-cli
|
||||
```
|
||||
|
||||
## 初次使用
|
||||
|
||||
在安装完成之后,即可在命令行使用 `nb-cli` 的命令 `nb` 进行开发:
|
||||
|
||||
```bash
|
||||
# 直接使用 nb 命令
|
||||
nb
|
||||
# 或使用 python 执行 module
|
||||
python -m nb_cli
|
||||
```
|
||||
|
||||
:::warning 注意
|
||||
通常情况下,你可以直接在命令行使用 `nb` 命令,但如果命令行出现 `Command not found` 错误,这是由于环境变量 `PATH` 没有正确配置或未配置导致的,可以使用第二种方式代替。
|
||||
:::
|
||||
|
||||
## 使用方式
|
||||
|
||||
`nb-cli` 具有两种使用方式:
|
||||
|
||||
1. 命令行指令
|
||||
|
||||
查看帮助信息:
|
||||
|
||||
```bash
|
||||
$ nb --help
|
||||
Usage: nb [OPTIONS] COMMAND [ARGS]...
|
||||
|
||||
Options:
|
||||
-V, --version Show the version and exit.
|
||||
--help Show this message and exit.
|
||||
|
||||
...
|
||||
```
|
||||
|
||||
查看子命令帮助:
|
||||
|
||||
```bash
|
||||
$ nb plugin --help
|
||||
Usage: nb plugin [OPTIONS] COMMAND [ARGS]...
|
||||
|
||||
Manage Bot Plugin.
|
||||
|
||||
Options:
|
||||
--help Show this message and exit.
|
||||
|
||||
...
|
||||
```
|
||||
|
||||
2. 交互式选择(支持鼠标)
|
||||
|
||||
交互式选择菜单:
|
||||
|
||||
```bash
|
||||
$ nb
|
||||
Welcome to NoneBot CLI!
|
||||
[?] What do you want to do? (Use ↑ and ↓ to choose, Enter to submit)
|
||||
...
|
||||
```
|
||||
|
||||
交互式子命令菜单:
|
||||
|
||||
```bash
|
||||
$ nb plugin
|
||||
[?] What do you want to do? (Use ↑ and ↓ to choose, Enter to submit)
|
||||
...
|
||||
```
|
||||
|
Loading…
Reference in New Issue
Block a user