更新 readme

2026-07-01 04:40:38 +08:00 · 2023-10-14 21:50:12 +08:00
parent 9fb9b3d121
commit 41befcc0a8
2 changed files with 120 additions and 119 deletions
@@ -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