Updated readme with the new switch
@@ -18,6 +18,7 @@ Nuclei is used to send requests across targets based on a template leading to ze
We have also [open-sourced a template repository](https://github.com/projectdiscovery/nuclei-templates) to maintain various type of templates, we hope that you will contribute there too. Templates are provided in hopes that these will be useful and will allow everyone to build their own templates for the scanner. Checkout the templating guide at [**nuclei.projectdiscovery.io**](https://nuclei.projectdiscovery.io/templating-guide/) for a primer on nuclei templates.
# Resources
+
- [Resources](#resources)
- [Features](#features)
- [Usage](#usage)
@@ -54,7 +55,7 @@ nuclei -h
This will display help for the tool. Here are all the switches it supports.
| Flag | Description | Example |
-|:-------------------:|:-------------------------------------------------------:|:----------------------------------------------------:|
+| :---------------: | :---------------------------------------------------: | :---------------------------------------------: |
| -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 |
@@ -71,16 +72,15 @@ This will display help for the tool. Here are all the switches it supports.
| -debug | Allow debugging of request/responses. | nuclei -debug |
| -update-templates | Download and updates nuclei templates | nuclei -update-templates |
| -update-directory | Directory for storing nuclei-templates(optional) | nuclei -update-directory templates |
+| -lt | List available templates | nuclei -lt |
| -v | Shows verbose output of all sent requests | nuclei -v |
| -version | Show version of nuclei | nuclei -version |
| -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
-
### From Binary
The installation is easy. You can download the pre-built binaries for your platform from the [Releases](https://github.com/projectdiscovery/nuclei/releases/) page. Extract them using tar, move it to your `$PATH`and you're ready to go.
@@ -102,7 +102,6 @@ nuclei requires **go1.14+** to install successfully. Run the following command t
In order to update the tool, you can use -u flag with `go get` command.
-
### From Github
```bash
@@ -157,7 +156,6 @@ This will run the tool against all the hosts in `urls.txt` with all the template
### 3. Automating nuclei with subfinder and any other similar tool.
-
```bash
> subfinder -d hackerone.com -silent | httpx -silent | nuclei -t cves/ -o results.txt
```
@@ -171,19 +169,20 @@ You can use the [nuclei dockerhub image](https://hub.docker.com/r/projectdiscove
```
- After downloading or building the container, run the following:
+
```bash
> docker run -it projectdiscovery/nuclei
```
For example, this will run the tool against all the hosts in `urls.txt` and output the results to your host file system:
+
```bash
> cat urls.txt | docker run -v /path-to-nuclei-templates:/go/src/app/ -i projectdiscovery/nuclei -t ./files/git-config.yaml > results.txt
```
-Remember to change `/path-to-nuclei-templates` to the real path on your host file system.
+Remember to change `/path-to-nuclei-templates` to the real path on your host file system.
--------
-
+* * *
# Thanks
