diff --git a/README.md b/README.md index 3870060ed..7874350f5 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,7 @@ We have also [open-sourced a dedicated repository](https://github.com/projectdis - [From Binary](#from-binary) - [From Source](#from-source) - [Running in a Docker Container](#running-in-a-docker-container) +- [Nuclei templates](#nuclei-templates) - [Running nuclei](#running-nuclei) - [1. Running nuclei with a single template.](#1-running-nuclei-with-a-single-template) - [2. Running nuclei with multiple templates.](#2-running-nuclei-with-multiple-templates) @@ -51,19 +52,23 @@ This will display help for the tool. Here are all the switches it supports. |-------------------|-------------------------------------------------------|----------------------------------------------------| | -c | Number of concurrent requests (default 10) | nuclei -c 100 | | -l | List of urls to run templates | nuclei -l urls.txt | +| -target | Target to scan using templates | nuclei -target hxxps://example.com | | -t | Templates input file/files to check across hosts | nuclei -t git-core.yaml | -| -t | Templates input file/files to check across hosts | nuclei -t nuclei-templates/cves/ | +| -t | Templates input file/files to check across hosts | nuclei -t nuclei-templates/cves/ | | -nC | Don't Use colors in output | nuclei -nC | +| -json | Prints and write output in json format | nuclei -json | | -o | File to save output result (optional) | nuclei -o output.txt | | -silent | Show only found results in output | nuclei -silent | | -retries | Number of times to retry a failed request (default 1) | nuclei -retries 1 | | -timeout | Seconds to wait before timeout (default 5) | nuclei -timeout 5 | | -debug | Allow debugging of request/responses. | nuclei -debug | -| -v | Shows verbose output of all sent requests | nuclei -v | +| -update-templates | Download and updates nuclei templates | nuclei -update-templates | +| -update-directory | Directory for storing nuclei-templates(optional) | nuclei -update-directory templates | +| -v | Shows verbose output of all sent requests | nuclei -v | | -version | Show version of nuclei | nuclei -version | -| -proxy-url | Proxy URL | nuclei -proxy-url http://user:pass@this.is.a.proxy:8080 | -| -proxy-socks-url | Proxy Socks URL | nuclei -proxy-socks-url socks5://user:pass@this.is.a.proxy.socks:9050 | -| -H | Custom Header | nuclei -H "x-bug-bounty: hacker" | +| -proxy-url | Proxy URL | nuclei -proxy-url hxxp://127.0.0.1:8080 | +| -proxy-socks-url | Socks proxy URL | nuclei -proxy-socks-url socks5://127.0.0.1:8080 | +| -H | Custom Header | nuclei -H "x-bug-bounty: hacker" | # Installation Instructions @@ -91,13 +96,13 @@ In order to update the tool, you can use -u flag with `go get` command. ### Running in a Docker Container -- Clone the repo using `git clone https://github.com/projectdiscovery/nuclei.git` -- Build your docker container +You can use the [nuclei dockerhub image](https://hub.docker.com/r/projectdiscovery/nuclei). Simply run - + ```bash -> docker build -t projectdiscovery/nuclei . +> docker pull projectdiscovery/nuclei ``` -- After building the container using either way, run the following: +- After downloading or building the container, run the following: ```bash > docker run -it projectdiscovery/nuclei ``` @@ -108,6 +113,20 @@ For example, this will run the tool against all the hosts in `urls.txt` and outp ``` Remember to change `/path-to-nuclei-templates` to the real path on your host file system. +# Nuclei templates + +You can download or update the nuclei templates using `update-templates` flag. + +```bash +> nuclei -update-templates +``` + +or download it from [nuclei templates](https://github.com/projectdiscovery/nuclei-templates) Github project. + +```bash +> git clone https://github.com/projectdiscovery/nuclei-templates.git +``` + # Running nuclei ### 1. Running nuclei with a single template.