CLI 入口是 jiuli.mjs，三种调用方式等价：

node jiuli <命令>      # 推荐，带简写
node jiuli.mjs <命令>
pnpm jiuli <命令>

命令表

命令	简写	说明
init	i	安装依赖 + 编译内核 + 生成配置
start	s	pm2 后台启动（自动检查依赖 / 构建 / 配置）
start --fg	f	前台启动，Ctrl+C 退出
stop	x	停止
restart	r / rs	重启，完成后通知原会话
log [条数]	l	查看日志；-f 持续输出
flush		清空 pm2 日志文件
status	st	环境与运行状态
list	ls	列出 plugins/ 下的插件目录
create <名称>	c	生成插件骨架（--dsl 函数式 / --dir 独立目录）
add <git地址>	a	安装第三方插件（克隆 + 自动装依赖），--name 目录名 指定目录名
session	m	在 tmux 会话里启动：可脱离、随时接回（服务器推荐）
attach	at	接回 tmux / screen 会话，实时日志与终端输入都还在
build	b	编译内核（tsc）
deps	d	扫描 plugins/ 下 JS 插件的 import，一键装齐缺失依赖（--dry 只看不装）
help	h / ?	命令说明

npm scripts 等价物：pnpm start / pnpm stop / pnpm rs / pnpm log / pnpm setup / pnpm build / pnpm app（= node .）。

安装第三方插件

# 目录名默认取仓库地址最后一段（去掉 .git）
node jiuli a https://gitee.com/TimeRainStarSky/Yunzai-ICQQ-Plugin

# 指定目录名：--name 写在 URL 后面
node jiuli a https://gitee.com/TimeRainStarSky/Yunzai-ICQQ-Plugin --name ICQQ-Plugin

URL 必须写在 --name 前面（CLI 取第一个非 - 开头的参数作为地址）。 目标目录已存在时不会覆盖，需要更新就进那个目录执行 git pull。

云崽插件包常把目录名写死在代码里（./plugins/<目录名>/apps），改名要连代码一起改， 详见安装部署的说明。

安装插件依赖

散在 plugins/example/*.js 这类单文件插件里的 import 没有任何地方声明依赖， 只能一个个手装 —— 用 deps 扫一遍就都装齐了：

node jiuli deps --dry     # 只看缺什么，不安装（推荐先跑）
node jiuli deps           # 扫描并安装

[JiuLi] 扫描松散 JS 插件目录：plugins/example　（另有 9 个插件包的依赖由 pnpm i 负责）
[JiuLi] plugins/example 缺失 2 个依赖：
    uuid ← plugins/example/fakeFile.js
    highlight.js ← plugins/example/图片日志.js

[JiuLi] 安装中：pnpm --dir plugins/example add uuid highlight.js
[JiuLi] 已安装 2 个依赖 → plugins/example
[JiuLi] 发 #重载 或 #重启 后生效

规则：

• 只扫「没有 index.js 的平铺插件目录」（example/ 这类）。插件包（miao-plugin、 genshin、TRSS-Plugin… 有 index.js 的）依赖由各自 package.json 负责，跑 pnpm i 即可， 扫它们只会报出一堆假缺失
• 只扫插件代码：跳过 resources/、web/、static/、*.min.js 这些前端产物与压缩库
• 内置模块（node:fs）、相对路径、已经能解析的包都不算缺失
• 插件内部自己的文件写法（models/xx.js 且本地存在）不算依赖
• 子路径归到包名：require('pkg/a/b.js') → 装 pkg；@scope/name 保持完整
• 该目录声明过版本就用它（pkg@^1.2.3），否则装最新
• 装到该插件目录（有 package.json 就用 pnpm --dir），没有则用 pnpm -w 装到项目根 —— 直接 pnpm add 到 workspace 根会被 pnpm 拒绝（ERR_PNPM_ADDING_TO_ROOT）
• 装完发 #重载（或 #重启）生效

启动模式

命令	进程模型	重启行为
node .	守护进程 + 主进程，占用当前终端	主进程以 255 退出，守护进程在同一终端重新拉起
node jiuli s	pm2 托管	交给 pm2
node . start	单进程	以 255 退出，由外部管理器拉起
node . stop	—	让运行中的实例退出

守护进程只在收到退出码 255 时重新拉起（这是 #重启 的约定），正常退出或崩溃都不会无限重启。

环境变量

变量	作用
JIULI_CONFIG_DIR	指定用户配置目录，默认 config/config/。多实例、测试隔离靠它
JIULI_PLUGINS_DIR	指定插件目录，默认 plugins/
JIULI_MOCK_STDIN	为 1 时，stdin 每行一个 JSON 事件，用 Mock 适配器模拟收发
JIULI_CHILD	内部用：标记当前进程是守护进程拉起的子进程

多实例示例：

JIULI_CONFIG_DIR=config/instance-b/ JIULI_PLUGINS_DIR=plugins-b/ node .

退出码约定

码	含义
0	正常停止（#停止）
255	请求重启，守护进程据此重新拉起

贡献者: HL-z7

上一页快速开始

下一页配置说明