External/nuclei
1
0
Fork 0
mirror of https://github.com/projectdiscovery/nuclei.git synced 2025-12-24 02:05:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

readme updates

Browse Source
This commit is contained in:
team-projectdiscovery 2020-12-22 00:37:52 +05:30
parent c07771747a
commit 9c237239ca
1 changed files with 45 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

89
README.md
View File

@ -53,6 +53,51 @@ We have also [open-sourced a template repository](https://github.com/projectdisc
- Handles edge cases doing retries, backoffs etc for handling WAFs. - Handles edge cases doing retries, backoffs etc for handling WAFs.
- Smart matching functionality for zero false positive scanning. - Smart matching functionality for zero false positive scanning.
## 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.
```sh
Download latest binary from https://github.com/projectdiscovery/nuclei/releases
▶ tar -xzvf nuclei-linux-amd64.tar.gz
▶ mv nuclei /usr/local/bin/
▶ nuclei -version
```
### From Source
nuclei requires **go1.14+** to install successfully. Run the following command to get the repo -
```sh
▶ GO111MODULE=on go get -v github.com/projectdiscovery/nuclei/v2/cmd/nuclei
```
### From Github
```sh
▶ git clone https://github.com/projectdiscovery/nuclei.git; cd nuclei/v2/cmd/nuclei/; go build; mv nuclei /usr/local/bin/; nuclei -version
```
## Nuclei templates
You can download or update the nuclei templates using `update-templates` flag.
```sh
▶ nuclei -update-templates
```
or download it from [nuclei templates](https://github.com/projectdiscovery/nuclei-templates) Github project.
```sh
▶ git clone https://github.com/projectdiscovery/nuclei-templates.git
```
**Please refer to nuclei [templating guide](https://nuclei.projectdiscovery.io/templating-guide/) to writing your own custom templates.**
## Usage ## Usage
```sh ```sh
@ -97,50 +142,6 @@ This will display help for the tool. Here are all the switches it supports.
| random-agent | Use random User-Agents | nuclei -random-agent | | random-agent | Use random User-Agents | nuclei -random-agent |
| H | Custom Header | nuclei -H "x-bug-bounty: hacker" | | 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.
```sh
Download latest binary from https://github.com/projectdiscovery/nuclei/releases
▶ tar -xzvf nuclei-linux-amd64.tar.gz
▶ mv nuclei /usr/local/bin/
▶ nuclei -version
```
### From Source
nuclei requires **go1.14+** to install successfully. Run the following command to get the repo -
```sh
▶ GO111MODULE=on go get -u -v github.com/projectdiscovery/nuclei/v2/cmd/nuclei
```
### From Github
```sh
▶ git clone https://github.com/projectdiscovery/nuclei.git; cd nuclei/v2/cmd/nuclei/; go build; mv nuclei /usr/local/bin/; nuclei -version
```
## Nuclei templates
You can download or update the nuclei templates using `update-templates` flag.
```sh
▶ nuclei -update-templates
```
or download it from [nuclei templates](https://github.com/projectdiscovery/nuclei-templates) Github project.
```sh
▶ git clone https://github.com/projectdiscovery/nuclei-templates.git
```
**Please refer to nuclei [templating guide](https://nuclei.projectdiscovery.io/templating-guide/) to writing your own custom templates.**
## Running Nuclei ## Running Nuclei
### Running with single template. ### Running with single template.