README.md in wpscan-3.6.3 vs README.md in wpscan-3.7.0
- old
+ new
@@ -82,35 +82,48 @@
For more options, open a terminal and type ```wpscan --help``` (if you built wpscan from the source, you should type the command outside of the git repo)
The DB is located at ~/.wpscan/db
+## Load CLI options from file/s
+
WPScan can load all options (including the --url) from configuration files, the following locations are checked (order: first to last):
-- ~/.wpscan/cli_options.json
-- ~/.wpscan/cli_options.yml
-- pwd/.wpscan/cli_options.json
-- pwd/.wpscan/cli_options.yml
+- ~/.wpscan/scan.json
+- ~/.wpscan/scan.yml
+- pwd/.wpscan/scan.json
+- pwd/.wpscan/scan.yml
-If those files exist, options from them will be loaded and overridden if found twice.
+If those files exist, options from the `cli_options` key will be loaded and overridden if found twice.
e.g:
-~/.wpscan/cli_options.yml:
+~/.wpscan/scan.yml:
```yml
-proxy: 'http://127.0.0.1:8080'
-verbose: true
+cli_options:
+ proxy: 'http://127.0.0.1:8080'
+ verbose: true
```
-pwd/.wpscan/cli_options.yml:
+pwd/.wpscan/scan.yml:
```yml
-proxy: 'socks5://127.0.0.1:9090'
-url: 'http://target.tld'
+cli_options:
+ proxy: 'socks5://127.0.0.1:9090'
+ url: 'http://target.tld'
```
Running ```wpscan``` in the current directory (pwd), is the same as ```wpscan -v --proxy socks5://127.0.0.1:9090 --url http://target.tld```
+
+## Save API Token in a file
+
+The feature mentioned above is useful to keep the API Token in a config file and not have to supply it via the CLI each time. To do so, create the ~/.wpscan/scan.yml file containing the below:
+
+```yml
+cli_options:
+ api_token: YOUR_API_TOKEN
+```
Enumerating usernames
```shell
wpscan --url https://target.tld/ --enumerate u