Skip to content

Commit a4a8aa5

Browse files
committed
update readme
1 parent 878cd2d commit a4a8aa5

1 file changed

Lines changed: 10 additions & 6 deletions

File tree

readme.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ The `jobsdir` in `configs/crawl.yaml` points to the directory where the job conf
5151

5252
Spec of the job configuration file is as follows:
5353
```yaml
54+
enable: true
5455
fqljobs:
5556
-name: zhihu/hotlist
5657
desc: Know the hot list
@@ -66,22 +67,25 @@ fqljobs:
6667
cron: "* 3 18/1 * * 5 *" # Every Friday 18:00-23:00
6768
```
6869

69-
name
70+
enable:
71+
: Required, default false. So, you can disable/enable all the jobs in one yaml.
72+
73+
job.name
7074
: Required, job name, it needs to be unique in a single yaml configuration file
7175

72-
desc
76+
job.desc
7377
: Optional, description information, help memorize and understand
7478

75-
script
79+
job.script
7680
: Required, the relative path of the ferret query script. The program will search from the directory specified by `configs/crawl.yaml#fqldir`
7781

78-
output
82+
job.output
7983
: Optional, the relative path of the files saved in the fql result. These files will be saved in the directory specified by `config/crawl.yaml#output`. If it is missing, the program will task default value to the format of `config/crawl.yaml#fqldir + '_' + script + .json`, such as *bilibili/weekly* above does not specify *output*, then the default name of the output file automatically generated by the program is `configs_fql_bilibili_weekly.json `
8084

81-
enable
85+
job.enable
8286
: Optional, default false. So, only jobs with `enable=true` would be loaded.
8387

84-
schedule
88+
job.schedule
8589
: Read `cron` first, if missing, try to read `every`. If boths none exists, the default is *7m*. Because this program uses the [*go-co-op/gocron*](https://github.com/go-co-op/gocron) scheduling library, you can use the *cron expression* when filling in `cron` ; When filling in `every`, you can choose to the following units to define the time frequency, s->seconds, m->minutes, h->hours. If the time interval is very long, such as many days or one month, it is recommended to use *cron expression* to control the time more accurately
8690

8791

0 commit comments

Comments
 (0)