https://github.com/nonebot/nb-cli

NoneBot2 脚手架 / CLI for NoneBot2
https://github.com/nonebot/nb-cli

cli nonebot2

Last synced: 7 days ago
JSON representation

NoneBot2 脚手架 / CLI for NoneBot2

• Host: GitHub
• URL: https://github.com/nonebot/nb-cli
• Owner: nonebot
• License: mit
• Created: 2020-08-27T09:52:50.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-04-12T12:38:06.000Z (10 months ago)
• Last Synced: 2024-04-14T09:04:12.685Z (10 months ago)
• Topics: cli, nonebot2
• Language: Python
• Homepage: https://cli.nonebot.dev
• Size: 1.32 MB
• Stars: 147
• Watchers: 5
• Forks: 16
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        



  





# NB CLI

_✨ NoneBot2 命令行工具 ✨_





  

    

  

  

    

  

  

  

    

  

  

    

  

  


  

    

  

  

    

  

  

    

  

  

    

  





  文档

  ·

  安装

  ·

  NoneBot 文档



## 功能

- 创建新的 Nonebot 项目

- 启动 Nonebot

- 管理插件

  - 创建新的插件

  - 搜索/安装/更新/卸载在官方商店上发布的插件

- 管理适配器

  - 创建新的适配器

  - 搜索/安装/更新/卸载在官方商店上发布的适配器

- 管理驱动器

  - 搜索/安装/更新/卸载在官方商店上发布的驱动器

- 支持 CLI 插件和运行脚本

## 使用

完整使用文档请参考 [文档](https://cli.nonebot.dev/)。

### 安装

使用 pipx 安装

```shell

pipx install nb-cli

```

使用 Docker 运行

```shell

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 版本的最新稳定版本

### 命令行使用

```shell

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 ` 运行脚本

Docker 镜像使用

```shell

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

```

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

### 交互式使用

```shell

nb

```

Docker 镜像使用

```shell

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

```

## 开发

### 翻译

生成模板

```shell

pdm run extract

```

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

```shell

pdm run init en_US

```

更新语言翻译文件

```shell

pdm run update

```

编译语言翻译文件

```shell

pdm run compile

```