diff --git a/README.md b/README.md
index 02cacb9cc..5bd41aafe 100644
--- a/README.md
+++ b/README.md
@@ -24,7 +24,7 @@
---
-
+
Nuclei is a modern, high-performance vulnerability scanner that leverages simple YAML-based templates. It empowers you to design custom vulnerability detection scenarios that mimic real-world conditions, leading to zero false positives.
@@ -54,12 +54,6 @@ Nuclei is a modern, high-performance vulnerability scanner that leverages simple
- [Contributors ❤️](#contributors-️)
- [License](#license)
----
-
-| :exclamation: **Disclaimer** |
-|---------------------------------|
-| **This project is in active development**. Expect breaking changes with releases. Review the release changelog before updating. |
-| This project is primarily built to be used as a standalone CLI tool. **Running nuclei as a service may pose security risks.** It's recommended to use with caution and additional security measures. |
## Get Started
@@ -72,6 +66,11 @@ Install Nuclei on your machine. Get started by following the installation guide
- Access latest nuclei templates
- Discover and store your targets
+| :exclamation: **Disclaimer** |
+|:--------------------------------|
+| **This project is in active development**. Expect breaking changes with releases. Review the release changelog before updating. |
+| This project is primarily built to be used as a standalone CLI tool. **Running nuclei as a service may pose security risks.** It's recommended to use with caution and additional security measures. |
+
### **2. Pro and Enterprise Editions**
For security teams and enterprises, we provide a cloud-hosted service built on top of Nuclei OSS, fine-tuned to help you continuously run vulnerability scans at scale with your team and existing workflows:
@@ -85,6 +84,8 @@ For security teams and enterprises, we provide a cloud-hosted service built on t
- We're constantly [adding new features](https://feedback.projectdiscovery.io/changelog)!
- **Ideal for:** Pentesters, security teams, and enterprises
+[Sign up to Pro](https://projectdiscovery.io/pricing?utm_source=github&utm_medium=web&utm_campaign=nuclei_readme) or [Talk to our team](https://projectdiscovery.io/request-demo?utm_source=github&utm_medium=web&utm_campaign=nuclei_readme) if you have large organization and complex requirements.
+
## Documentation
Browse the full Nuclei [documentation here](https://docs.projectdiscovery.io/tools/nuclei/running). If you’re new to Nuclei, check out our [foundational Youtube series.](https://www.youtube.com/playlist?list=PLZRbR9aMzTTpItEdeNSulo8bYsvil80Rl)
@@ -95,6 +96,16 @@ Browse the full Nuclei [documentation here](https://docs.projectdiscovery.io/too
+### Installation
+
+`nuclei` requires **go1.21** to install successfully. Run the following command to get the repo:
+
+```sh
+go install -v github.com/projectdiscovery/nuclei/v3/cmd/nuclei@latest
+```
+
+To learn more about installing nuclei, see https://docs.projectdiscovery.io/tools/nuclei/install.
+
### Command Line Flags
To display all the flags for the tool:
@@ -278,24 +289,23 @@ HEADLESS:
-lha, -list-headless-action list available headless actions
DEBUG:
- -debug show all requests and responses
- -dreq, -debug-req show all sent requests
- -dresp, -debug-resp show all received responses
- -p, -proxy string[] list of http/socks5 proxy to use (comma separated or file input)
- -pi, -proxy-internal proxy all internal requests
- -ldf, -list-dsl-function list all supported DSL function signatures
- -tlog, -trace-log string file to write sent requests trace log
- -elog, -error-log string file to write sent requests error log
- -version show nuclei version
- -hm, -hang-monitor enable nuclei hang monitoring
- -v, -verbose show verbose output
- -profile-mem string generate memory (heap) profile & trace files
- -vv display templates loaded for scan
- -svd, -show-var-dump show variables dump for debugging
- -vdl, -var-dump-limit int limit the number of characters displayed in var dump (default 255)
- -ep, -enable-pprof enable pprof debugging server
- -tv, -templates-version shows the version of the installed nuclei-templates
- -hc, -health-check run diagnostic check up
+ -debug show all requests and responses
+ -dreq, -debug-req show all sent requests
+ -dresp, -debug-resp show all received responses
+ -p, -proxy string[] list of http/socks5 proxy to use (comma separated or file input)
+ -pi, -proxy-internal proxy all internal requests
+ -ldf, -list-dsl-function list all supported DSL function signatures
+ -tlog, -trace-log string file to write sent requests trace log
+ -elog, -error-log string file to write sent requests error log
+ -version show nuclei version
+ -hm, -hang-monitor enable nuclei hang monitoring
+ -v, -verbose show verbose output
+ -profile-mem string optional nuclei memory profile dump file
+ -vv display templates loaded for scan
+ -svd, -show-var-dump show variables dump for debugging
+ -ep, -enable-pprof enable pprof debugging server
+ -tv, -templates-version shows the version of the installed nuclei-templates
+ -hc, -health-check run diagnostic check up
UPDATE:
-up, -update update nuclei engine to the latest released version
@@ -340,6 +350,7 @@ Run nuclei with sorted Markdown outputs (with environment variables):
$ MARKDOWN_EXPORT_SORT_MODE=template nuclei -target example.com -markdown-export nuclei_report/
Additional documentation is available at: https://docs.nuclei.sh/getting-started/running
+
```
Additional documentation is available at: [https://docs.nuclei.sh/getting-started/running](https://docs.nuclei.sh/getting-started/running?utm_source=github&utm_medium=web&utm_campaign=nuclei_readme)
@@ -367,7 +378,7 @@ nuclei -targets urls.txt
This will scan the entire subnet for network-related issues, such as open ports or misconfigured services.
```sh
-nuclei -target 192.168.1.0/24
+nuclei -target 192.168.1.0/24
```
### Scanning with your custom template
@@ -460,6 +471,100 @@ Thanks to all the amazing [community contributors for sending PRs](https://githu
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
