指南
API
指南
API
简体中文

基础说明

这些是默认的面板内置 Shell 命令，在面板宿主机或容器内执行。Docker 可先运行 docker exec -it qinglong bash 进入容器。远程管理请使用独立的 npm CLI，可选的 TypeScript 执行与维护入口见面板内部工具。

内置命令

  • task
# 依次执行，如果设置了随机延迟，将随机延迟一定秒数
task <file_path>
# 依次执行，无论是否设置了随机延迟，均立即运行，前台会输出日志，同时记录在日志文件中
task <file_path> now
# 并发执行，无论是否设置了随机延迟，均立即运行，前台不输出日志，直接记录在日志文件中，且可指定账号执行
task <file_path> conc <env_name> <account_number>(可选的)
# 指定账号执行，无论是否设置了随机延迟，均立即运行
task <file_path> desi <env_name> <account_number>
# 设置任务超时时间
task -m <max_time> <file_path>
# 使用 -- 分割，-- 后面的参数会传给脚本，下面的例子，脚本就可接收到参数 -u whyour -p password
task <file_path> -- -u whyour -p password

-m 放在脚本名之前，例如 task -m 30s demo.js now、task -m 5m demo.py、task -m 1h demo.sh。无后缀时按秒计算；未指定 -m 时使用配置中的 CommandTimeoutTime，该配置为空时不设置超时。

超时会终止脚本及其后代进程，并按执行模式运行已配置的结束 hook。普通和 desi 模式记录超时码 124，conc 保留原有汇总行为；默认 Shell 包装器 task.sh 最终仍退出 0。检查任务日志中的超时信息，不能只用外层命令的 $? 判断成功。内部 TypeScript 执行器会返回超时码 124；远程 npm CLI 的 --timeout 则是 HTTP 请求等待时间。

Shell 脚本在子 Shell 中执行，继承 before hook 的变量和函数。脚本中的 cd、Shell 选项、exit 或 exec 不再改变主包装器后续的 hook 与收尾流程；依赖这些副作用的旧脚本需要调整。

  • ql
# 更新并重启青龙
ql update
# 运行自定义脚本extra.sh
ql extra
# 添加单个脚本文件
ql raw <file_url>
# 添加单个仓库的指定脚本
ql repo <repo_url> <whitelist> <blacklist> <dependence> <branch> <extensions>
# 删除旧日志
ql rmlog <days>
# 启动tg-bot
ql bot
# 检测青龙环境并修复
ql check
# 重置登录错误次数
ql resetlet
# 禁用两步登录
ql resettfa
参数 说明
file_url 脚本地址
repo_url 仓库地址
whitelist 拉取仓库时的白名单，即就是需要拉取的脚本的路径包含的字符串，多个竖线分割
blacklist 拉取仓库时的黑名单，即就是需要拉取的脚本的路径不包含的字符串，多个竖线分割
dependence 拉取仓库需要的依赖文件，会直接从仓库拷贝到scripts下的仓库目录，不受黑名单影响，多个竖线分割
extensions 拉取仓库的文件后缀，多个竖线分割
branch 拉取仓库的分支
days 需要保留的日志的天数
file_path 任务执行时的文件路径

开发

面板构建与回归验证沿用 Node.js 20 和 pnpm 8.3.1。独立远程 CLI 需要 Node.js 22.12 或更高版本。开发环境还需 Python3 和 pip3。

git clone https://github.com/whyour/qinglong.git
cd qinglong
cp .env.example .env
# 推荐使用 pnpm https://pnpm.io/zh/installation
npm install -g pnpm@8.3.1
pnpm install --frozen-lockfile
pnpm start
# 打开你的浏览器，访问 <http://127.0.0.1:5700>