diff --git a/README.md b/README.md index fd588a08..dff90e57 100644 --- a/README.md +++ b/README.md @@ -86,31 +86,40 @@ The DB is located at ~/.wpscan/db 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``` +Such feature 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 diff --git a/wpscan.gemspec b/wpscan.gemspec index 5bfc538f..64bf9b50 100644 --- a/wpscan.gemspec +++ b/wpscan.gemspec @@ -21,7 +21,7 @@ Gem::Specification.new do |s| s.executables = ['wpscan'] s.require_paths = ['lib'] - s.add_dependency 'cms_scanner', '~> 0.5.8' + s.add_dependency 'cms_scanner', '~> 0.6.0-dev' s.add_development_dependency 'bundler', '>= 1.6' s.add_development_dependency 'coveralls', '~> 0.8.0'