mirror of
https://github.com/whyour/qinglong.git
synced 2025-05-23 14:56:07 +08:00
更新 readme
This commit is contained in:
whyour
parent
53346a3962
commit
5c393fef36
3
.github/workflows/build_docker_image.yml
vendored
3
.github/workflows/build_docker_image.yml
vendored
|
|
@ -2,6 +2,9 @@ name: Build And Push Docker Image
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
|
paths-ignore:
|
||||||
|
- '.github/**'
|
||||||
|
- '*.md'
|
||||||
branches:
|
branches:
|
||||||
- 'master'
|
- 'master'
|
||||||
- 'develop'
|
- 'develop'
|
||||||
|
|
|
||||||
28
README-en.md
28
README-en.md
|
|
@ -56,7 +56,7 @@ npm i @whyour/qinglong
|
||||||
|
|
||||||
## Built-in commands
|
## Built-in commands
|
||||||
|
|
||||||
1. task
|
- task
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Execute in sequence, if a random delay is set, it will be randomly delayed by a certain number of seconds
|
# Execute in sequence, if a random delay is set, it will be randomly delayed by a certain number of seconds
|
||||||
|
|
@ -75,7 +75,7 @@ task -m <max_time> <file_path>
|
||||||
task <file_path> -- -u whyour -p password
|
task <file_path> -- -u whyour -p password
|
||||||
```
|
```
|
||||||
|
|
||||||
1. ql
|
- ql
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Update and restart Green Dragon
|
# Update and restart Green Dragon
|
||||||
|
|
@ -98,19 +98,17 @@ ql resetlet
|
||||||
ql resettfa
|
ql resettfa
|
||||||
```
|
```
|
||||||
|
|
||||||
1. parameter description
|
| Parameter | Description |
|
||||||
|
|---|---|
|
||||||
- file_url: Script address
|
| file_url | Script address |
|
||||||
- repo_url: Repository 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
|
| 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
|
| 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
|
| 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
|
| extensions | Pull the branch of the repository |
|
||||||
- days: Number of days of logs to be kept
|
| branch | Number of days of logs to be kept |
|
||||||
- file_path: File path for task execution
|
| days | 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
|
| file_path | 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
|
## Deployment
|
||||||
|
|
||||||
|
|
|
||||||
31
README.md
31
README.md
|
|
@ -58,7 +58,7 @@ npm i @whyour/qinglong
|
||||||
|
|
||||||
## 内置命令
|
## 内置命令
|
||||||
|
|
||||||
1. task
|
- task
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# 依次执行，如果设置了随机延迟，将随机延迟一定秒数
|
# 依次执行，如果设置了随机延迟，将随机延迟一定秒数
|
||||||
|
|
@ -75,7 +75,7 @@ task -m <max_time> <file_path>
|
||||||
task <file_path> -- -u whyour -p password
|
task <file_path> -- -u whyour -p password
|
||||||
```
|
```
|
||||||
|
|
||||||
1. ql
|
- ql
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# 更新并重启青龙
|
# 更新并重启青龙
|
||||||
|
|
@ -98,20 +98,17 @@ ql resetlet
|
||||||
ql resettfa
|
ql resettfa
|
||||||
```
|
```
|
||||||
|
|
||||||
1. 参数说明
|
| **参数** | **说明** |
|
||||||
|
|------------|---------------------------------------------------|
|
||||||
- file_url: 脚本地址
|
| file_url | 脚本地址 |
|
||||||
- repo_url: 仓库地址
|
| repo_url | 仓库地址 |
|
||||||
- whitelist: 拉取仓库时的白名单，即就是需要拉取的脚本的路径包含的字符串，多个竖线分割
|
| whitelist | 拉取仓库时的白名单，即就是需要拉取的脚本的路径包含的字符串，多个竖线分割 |
|
||||||
- blacklist: 拉取仓库时的黑名单，即就是需要拉取的脚本的路径不包含的字符串，多个竖线分割
|
| blacklist | 拉取仓库时的黑名单，即就是需要拉取的脚本的路径不包含的字符串，多个竖线分割 |
|
||||||
- dependence: 拉取仓库需要的依赖文件，会直接从仓库拷贝到scripts下的仓库目录，不受黑名单影响，多个竖线分割
|
| dependence | 拉取仓库需要的依赖文件，会直接从仓库拷贝到scripts下的仓库目录，不受黑名单影响，多个竖线分割 |
|
||||||
- extensions: 拉取仓库的文件后缀，多个竖线分割
|
| extensions | 拉取仓库的文件后缀，多个竖线分割 |
|
||||||
- branch: 拉取仓库的分支
|
| branch | 拉取仓库的分支 |
|
||||||
- days: 需要保留的日志的天数
|
| days | 需要保留的日志的天数 |
|
||||||
- file_path: 任务执行时的文件路径
|
| file_path | 任务执行时的文件路径 |
|
||||||
- env_name: 任务执行时需要并发或者指定时的环境变量名称
|
|
||||||
- account_number: 任务执行时指定某个环境变量需要执行的账号序号
|
|
||||||
- max_time: 超时时间，后缀"s"代表秒(默认值), "m"代表分, "h"代表小时, "d"代表天
|
|
||||||
|
|
||||||
## 部署
|
## 部署
|
||||||
|
|
||||||
|
|
@ -190,7 +187,7 @@ $ pnpm install
|
||||||
$ pnpm start
|
$ pnpm start
|
||||||
```
|
```
|
||||||
|
|
||||||
打开你的浏览器，访问 http://127.0.0.1:5700
|
打开你的浏览器，访问 <http://127.0.0.1:5700>
|
||||||
|
|
||||||
## 链接
|
## 链接
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue
Block a user