Skip to content

docker support for nb-cli

License

Notifications You must be signed in to change notification settings

nonebot/cli-plugin-docker

Repository files navigation

nonebot

NB CLI Plugin Docker

✨ NoneBot2 命令行工具 Docker 插件 ✨

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

准备

在使用本插件前请确保 Docker CLI 以及 Docker Compose Plugin 已经安装,且可以从命令行直接使用。

详细安装方法请参考 Docker 文档

Docker 官方 Linux 快速安装一键脚本:

curl -fsSL https://get.docker.com | sudo sh

安装插件

uv tool / uvx(推荐)

首先需要安装 uv

直接使用:

uvx --from nb-cli --with nb-cli-plugin-docker nb docker
#
uv tool run --from nb-cli --with nb-cli-plugin-docker nb docker

安装:

uv tool install --with nb-cli-plugin-docker nb-cli

# 更新环境变量(如果需要)
uv tool update-shell

通用方式

nb self install nb-cli-plugin-docker

使用插件

nb docker
# 其他别名
# nb deploy
# nb compose

generate

生成 Dockerfiledocker-compose.yml

什么时候需要(重新)生成?

  • 在项目中首次使用本插件时;
  • 更换了机器人项目的管理器时。

传递项目依赖

对于使用了 uv, pdmpoetry 的机器人项目,本插件会自动检查相应的依赖固定信息(即 *.lock 文件)判断并调用相应工具自动向容器内传递依赖。

对于其他管理方式的机器人项目,则需要手动导出一份 requirements.txt 来传递项目依赖到容器内,例如:

source .venv/bin/activate
pip freeze > requirements.txt

build

构建机器人镜像。

up / down

部署/取消部署机器人实例。

logs

查看机器人日志。

ps

查看机器人运行状态。

About

docker support for nb-cli

Resources

License

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •