aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authornico <nico@magicbroccoli.de>2019-11-04 14:59:58 +0100
committerGitHub <noreply@github.com>2019-11-04 14:59:58 +0100
commitb957dbc82c551c9119e77bcce6fc868ca1d09320 (patch)
treede4044d7a6b5f5f3c82796ad176a5aac7cfafd93 /README.md
parentad43e2117fdf000d599e7653053ef4ee8c67f1c3 (diff)
feature: custom timeperiod (#3)
+ add ability to define a custom time period This feature enables users to further narrow the expected query result by customizing the time period. Every script feature is able to handle the custom timestamps, but beware no further consistency checks are done. Thus if you provide a stop timestamp that is prior to the start timestamp the output will be empty, no error whatsoever. Timestamps must be conformal to the Python [datetime](https://docs.python.org/3/library/datetime.html#strftime-strptime-behavior) module. The easiest way to achieve that is to use the ISO-8601 format from the unix date function: ```bash $date -Ins -d "3 weeks ago" $date --iso-8601 -d "3 weeks ago" ```
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 8 insertions, 1 deletions
diff --git a/README.md b/README.md
index c8cb3e2..016aba7 100644
--- a/README.md
+++ b/README.md
@@ -34,7 +34,7 @@ $ cat config.json
## usage main.py
```
-usage: main.py [-h] [-in INFILE [INFILE ...]] [-d DOMAIN] [-r]
+usage: main.py [-h] [-in INFILE [INFILE ...]] [-d DOMAIN] [-r] [-f A] [-t B]
optional arguments:
-h, --help show this help message and exit
@@ -43,6 +43,8 @@ optional arguments:
-d DOMAIN, --domain DOMAIN
specify report domain
-r, --report toggle report output to file
+ -f A, --from A ISO-8601 timestamp where to start the search
+ -t B, --to B ISO-8601 timestamp up until where to start the search
```
#### run with no argument
@@ -95,3 +97,8 @@ $ ./main.py --d example.tld -d example.com
#### -r / --report
This flag will only take effect if the `-d` or `--domain` argument is used. If that is the case, the script will
automatically gather information about the specified domain and write them to the `report` directory.
+
+#### -f / --from and -t / --to
+With this flag it is possible to provide an [ISO-8601](https://www.w3.org/TR/NOTE-datetime) timestamp with the specified
+query, to further narrow the expected result.
+All outputting querys support the custom time period flags.