mirror of
https://github.com/whyour/qinglong.git
synced 2025-05-22 22:36:06 +08:00
更新 readme
This commit is contained in:
whyour
parent
9fb9b3d121
commit
41befcc0a8
120
README-en.md
120
README-en.md
|
|
@ -54,6 +54,66 @@ The npm version supports `debian/ubuntu/centos/alpine` systems and requires `nod
|
|||
npm i @whyour/qinglong
|
||||
```
|
||||
|
||||
## Built-in commands
|
||||
|
||||
1. task
|
||||
|
||||
```bash
|
||||
# Execute in sequence, if a random delay is set, it will be randomly delayed by a certain number of seconds
|
||||
task <file_path>
|
||||
# Execute in sequence, regardless of whether a random delay is set, all run immediately,
|
||||
# and the foreground will output the day, while recorded in the log file
|
||||
task <file_path> now
|
||||
# Concurrent execution, regardless of whether a random delay is set, are run immediately,
|
||||
# the foreground does not generate the day, directly recorded in the log file, and can be specified account execution
|
||||
task <file_path> conc <env_name> <account_number>(Optional)
|
||||
# Specify the account to execute and run immediately regardless of whether a random delay is set
|
||||
task <file_path> desi <env_name> <account_number>
|
||||
# Set task timeout
|
||||
task -m <max_time> <file_path>
|
||||
# Print task log in real time, no need to carry this parameter when creating timed tasks
|
||||
task -l <file_path>
|
||||
# Use -- to split, -- followed by a parameter that is passed to the script, as in the following example, the script receives the parameter -u whyour -p password
|
||||
task <file_path> -- -u whyour -p password
|
||||
```
|
||||
|
||||
1. ql
|
||||
|
||||
```bash
|
||||
# Update and restart Green Dragon
|
||||
ql update
|
||||
# Run custom scripts extra.sh
|
||||
ql extra
|
||||
# Adding a single script file
|
||||
ql raw <file_url>
|
||||
# Add a specific script for a single repository
|
||||
ql repo <repo_url> <whitelist> <blacklist> <dependence> <branch>
|
||||
# Delete old logs
|
||||
ql rmlog <days>
|
||||
# Start bot
|
||||
ql bot
|
||||
# Detecting the Green Dragon environment and repairing it
|
||||
ql check
|
||||
# Reset the number of login errors
|
||||
ql resetlet
|
||||
# Disable two-step login
|
||||
ql resettfa
|
||||
```
|
||||
|
||||
1. parameter description
|
||||
|
||||
- file_url: Script address
|
||||
- repo_url: Repository address
|
||||
- whitelist: The whitelist when pulling the repository, i.e., the string contained in the path of the script to be pulled
|
||||
- blacklist: Blacklisting when pulling repositories, i.e. strings that are not included in the path of the script to be pulled
|
||||
- dependence: Pulling the dependencies needed for the repository will be copied directly from the repository to the repository directory under scripts, regardless of the blacklist
|
||||
- branch: Pull the branch of the repository
|
||||
- days: Number of days of logs to be kept
|
||||
- file_path: File path for task execution
|
||||
- env_name: The name of the environment variable that needs to be concurrent or specified at the time of task execution
|
||||
- account_number: Specify the account number of an environment variable to be executed when the task is executed
|
||||
- max_time: Timeout, suffix "s" for seconds (default), "m" for minutes, "h" for hours, "d" for days
|
||||
|
||||
## Deployment
|
||||
|
||||
### Docker (Recommended)
|
||||
|
|
@ -119,66 +179,6 @@ export QL_DATA_DIR=""
|
|||
qinglong
|
||||
```
|
||||
|
||||
## Built-in commands
|
||||
|
||||
1. task
|
||||
|
||||
```bash
|
||||
# Execute in sequence, if a random delay is set, it will be randomly delayed by a certain number of seconds
|
||||
task <file_path>
|
||||
# Execute in sequence, regardless of whether a random delay is set, all run immediately,
|
||||
# and the foreground will output the day, while recorded in the log file
|
||||
task <file_path> now
|
||||
# Concurrent execution, regardless of whether a random delay is set, are run immediately,
|
||||
# the foreground does not generate the day, directly recorded in the log file, and can be specified account execution
|
||||
task <file_path> conc <env_name> <account_number>(Optional)
|
||||
# Specify the account to execute and run immediately regardless of whether a random delay is set
|
||||
task <file_path> desi <env_name> <account_number>
|
||||
# Set task timeout
|
||||
task -m <max_time> <file_path>
|
||||
# Print task log in real time, no need to carry this parameter when creating timed tasks
|
||||
task -l <file_path>
|
||||
# Use -- to split, -- followed by a parameter that is passed to the script, as in the following example, the script receives the parameter -u whyour -p password
|
||||
task <file_path> -- -u whyour -p password
|
||||
```
|
||||
|
||||
1. ql
|
||||
|
||||
```bash
|
||||
# Update and restart Green Dragon
|
||||
ql update
|
||||
# Run custom scripts extra.sh
|
||||
ql extra
|
||||
# Adding a single script file
|
||||
ql raw <file_url>
|
||||
# Add a specific script for a single repository
|
||||
ql repo <repo_url> <whitelist> <blacklist> <dependence> <branch>
|
||||
# Delete old logs
|
||||
ql rmlog <days>
|
||||
# Start bot
|
||||
ql bot
|
||||
# Detecting the Green Dragon environment and repairing it
|
||||
ql check
|
||||
# Reset the number of login errors
|
||||
ql resetlet
|
||||
# Disable two-step login
|
||||
ql resettfa
|
||||
```
|
||||
|
||||
1. parameter description
|
||||
|
||||
- file_url: Script address
|
||||
- repo_url: Repository address
|
||||
- whitelist: The whitelist when pulling the repository, i.e., the string contained in the path of the script to be pulled
|
||||
- blacklist: Blacklisting when pulling repositories, i.e. strings that are not included in the path of the script to be pulled
|
||||
- dependence: Pulling the dependencies needed for the repository will be copied directly from the repository to the repository directory under scripts, regardless of the blacklist
|
||||
- branch: Pull the branch of the repository
|
||||
- days: Number of days of logs to be kept
|
||||
- file_path: File path for task execution
|
||||
- env_name: The name of the environment variable that needs to be concurrent or specified at the time of task execution
|
||||
- account_number: Specify the account number of an environment variable to be executed when the task is executed
|
||||
- max_time: Timeout, suffix "s" for seconds (default), "m" for minutes, "h" for hours, "d" for days
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
|
|
|
|||
119
README.md
119
README.md
|
|
@ -38,6 +38,7 @@ Timed task management platform supporting Python3, JavaScript, Shell, Typescript
|
|||
- 支持手机端操作
|
||||
|
||||
## 版本
|
||||
|
||||
### docker
|
||||
|
||||
`latest` 镜像是基于 `alpine` 构建，`debian` 镜像是基于 `debian-slim` 构建。如果需要使用 `alpine` 不支持的依赖，建议使用 `debian` 镜像
|
||||
|
|
@ -55,6 +56,65 @@ npm 版本支持 `debian/ubuntu/centos/alpine` 系统，需要自行安装 `node
|
|||
npm i @whyour/qinglong
|
||||
```
|
||||
|
||||
## 内置命令
|
||||
|
||||
1. task
|
||||
|
||||
```bash
|
||||
# 依次执行，如果设置了随机延迟，将随机延迟一定秒数
|
||||
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>
|
||||
# 实时打印任务日志，创建定时任务时，不用携带此参数
|
||||
task -l <file_path>
|
||||
# 使用 -- 分割，-- 后面的参数会传给脚本，下面的例子，脚本就可接收到参数 -u whyour -p password
|
||||
task <file_path> -- -u whyour -p password
|
||||
```
|
||||
|
||||
1. ql
|
||||
|
||||
```bash
|
||||
# 更新并重启青龙
|
||||
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
|
||||
```
|
||||
|
||||
1. 参数说明
|
||||
|
||||
- file_url: 脚本地址
|
||||
- repo_url: 仓库地址
|
||||
- whitelist: 拉取仓库时的白名单，即就是需要拉取的脚本的路径包含的字符串，多个竖线分割
|
||||
- blacklist: 拉取仓库时的黑名单，即就是需要拉取的脚本的路径不包含的字符串，多个竖线分割
|
||||
- dependence: 拉取仓库需要的依赖文件，会直接从仓库拷贝到scripts下的仓库目录，不受黑名单影响，多个竖线分割
|
||||
- extensions: 拉取仓库的文件后缀，多个竖线分割
|
||||
- branch: 拉取仓库的分支
|
||||
- days: 需要保留的日志的天数
|
||||
- file_path: 任务执行时的文件路径
|
||||
- env_name: 任务执行时需要并发或者指定时的环境变量名称
|
||||
- account_number: 任务执行时指定某个环境变量需要执行的账号序号
|
||||
- max_time: 超时时间，后缀"s"代表秒(默认值), "m"代表分, "h"代表小时, "d"代表天
|
||||
|
||||
## 部署
|
||||
|
||||
### docker (推荐)
|
||||
|
|
@ -120,65 +180,6 @@ export QL_DATA_DIR=""
|
|||
qinglong
|
||||
```
|
||||
|
||||
## 内置命令
|
||||
|
||||
1. task
|
||||
|
||||
```bash
|
||||
# 依次执行，如果设置了随机延迟，将随机延迟一定秒数
|
||||
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>
|
||||
# 实时打印任务日志，创建定时任务时，不用携带此参数
|
||||
task -l <file_path>
|
||||
# 使用 -- 分割，-- 后面的参数会传给脚本，下面的例子，脚本就可接收到参数 -u whyour -p password
|
||||
task <file_path> -- -u whyour -p password
|
||||
```
|
||||
|
||||
1. ql
|
||||
|
||||
```bash
|
||||
# 更新并重启青龙
|
||||
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
|
||||
```
|
||||
|
||||
1. 参数说明
|
||||
|
||||
- file_url: 脚本地址
|
||||
- repo_url: 仓库地址
|
||||
- whitelist: 拉取仓库时的白名单，即就是需要拉取的脚本的路径包含的字符串，多个竖线分割
|
||||
- blacklist: 拉取仓库时的黑名单，即就是需要拉取的脚本的路径不包含的字符串，多个竖线分割
|
||||
- dependence: 拉取仓库需要的依赖文件，会直接从仓库拷贝到scripts下的仓库目录，不受黑名单影响，多个竖线分割
|
||||
- extensions: 拉取仓库的文件后缀，多个竖线分割
|
||||
- branch: 拉取仓库的分支
|
||||
- days: 需要保留的日志的天数
|
||||
- file_path: 任务执行时的文件路径
|
||||
- env_name: 任务执行时需要并发或者指定时的环境变量名称
|
||||
- account_number: 任务执行时指定某个环境变量需要执行的账号序号
|
||||
- max_time: 超时时间，后缀"s"代表秒(默认值), "m"代表分, "h"代表小时, "d"代表天
|
||||
|
||||
## 开发
|
||||
|
||||
```bash
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user