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

readme update

Browse Source
This commit is contained in:
sandeep 2021-07-27 00:27:17 +05:30
parent cc2e141a5e
commit ca70aef78c
1 changed files with 78 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

158
README.md
View File

@ -76,102 +76,100 @@ This will display help for the tool. Here are all the switches it supports.
<summary> 👉 nuclei help menu 👈</summary> <summary> 👉 nuclei help menu 👈</summary>
```yaml ```yaml
Nuclei is a fast tool for configurable targeted scanning Nuclei is a fast, template based vulnerability scanner focusing
based on templates offering massive extensibility and ease of use. on extensive configurability, massive extensibility and ease of use.
Usage: Usage:
./nuclei [flags] ./nuclei [flags]
Flags: Flags:
INPUT OPTIONS: TARGET:
-u, -target string URL/Host to scan with nuclei templates -u, -target string target URL/host to scan
-l, -list string List of URLs/Hosts to scan with nuclei templates -l, -list string path to file containing a list of target URLs/hosts to scan (one per line)
TEMPLATES OPTIONS: TEMPLATES:
-t, -templates string[] Templates to run, supports single and multiple templates using directory. -tl list all available templates
-w, -workflows string[] Workflows to run for nuclei -t, -templates string[] template or template directory paths to include in the scan
-nt, -new-templates Only run newly added templates -w, -workflows string[] list of workflows to run
-nt, -new-templates run newly added templates only
-validate validate the passed templates to nuclei
TEMPLATE FILTERS OPTIONS: FILTERING:
-tags string[] Tags to execute templates for -tags string[] execute a subset of templates that contain the provided tags
-severity, -impact string[] Templates to run based on severity -include-tags string[] tags from the default deny list that permit executing more intrusive templates
-author string[] Templates to run based on author -etags, -exclude-tags string[] exclude templates with the provided tags
-exclude-templates, -exclude string[] Templates to exclude, supports single and multiple templates using directory. -include-templates string[] templates to be executed even if they are excluded either by default or configuration
-etags, -exclude-tags string[] Exclude templates with the provided tags -exclude-templates, -exclude string[] template or template directory paths to exclude
-include-templates string[] Templates to force run even if they are in denylist -severity, -impact string[] execute templates that match the provided severities only
-include-tags string[] Tags to force run even if they are in denylist -author string[] execute templates that are (co-)created by the specified authors
OUTPUT OPTIONS: OUTPUT:
-o, -output string File to write output to (optional) -o, -output string output file to write found issues/vulnerabilities
-json Write json output to files -silent display findings only
-irr, -include-rr Write requests/responses for matches in JSON output -v, -verbose show verbose output
-me, -markdown-export string Directory to export results in markdown format -vv display extra verbose information
-rc, -report-config string Nuclei Reporting Module configuration file -nc, -no-color disable output content coloring (ANSI escape codes)
-rdb, -report-db string Local Nuclei Reporting Database (Always use this to persistent report data) -json write output in JSONL(ines) format
-se, -sarif-export string File to export results in sarif format -irr, -include-rr include request/response pairs in the JSONL output (for findings only)
-nm, -no-meta don't display match metadata
-rdb, -report-db string local nuclei reporting database (always use this to persist report data)
-me, -markdown-export string directory to export results in markdown format
-se, -sarif-export string file to export results in SARIF format
RATE-LIMIT OPTIONS: CONFIGURATIONS:
-rl, -rate-limit int Maximum requests to send per second (default 150) -config string path to the nuclei configuration file
-bs, -bulk-size int Maximum Number of hosts analyzed in parallel per template (default 25) -rc, -report-config string nuclei reporting module configuration file
-c, -concurrency int Maximum Number of templates executed in parallel (default 10) -H, -header string[] custom headers in header:value format
-r, -resolvers string file containing resolver list for nuclei
-system-resolvers use system DNS resolving as error fallback
-passive enable passive HTTP response processing mode
ENGINE OPTIONS: INTERACTSH:
-config string Nuclei configuration file -no-interactsh do not use interactsh server for blind interaction polling
-H, -header string[] Custom Header. -interactsh-url string self-hosted Interactsh Server URL (default "https://interact.sh")
-nc, -no-color Disable colors in output -interactions-cache-size int number of requests to keep in the interactions cache (default 5000)
-retries int Number of times to retry a failed request (default 1) -interactions-eviction int number of seconds to wait before evicting requests from cache (default 60)
-timeout int Time to wait in seconds before timeout (default 5) -interactions-poll-duration int number of seconds to wait before each interaction poll request (default 5)
-nm, -no-meta Don't display metadata for the matches -interactions-cooldown-period int extra time for interaction polling before exiting (default 5)
-spm, -stop-at-first-path Stop processing http requests at first match (this may break template/workflow logic)
-passive Enable Passive HTTP response processing mode
-r, -resolvers string File containing resolver list for nuclei
-system-resolvers Use system dns resolving as error fallback
INTERACTSH OPTIONS: RATE-LIMIT:
-interactsh-url string Self Hosted Interactsh Server URL (default "https://interact.sh") -rl, -rate-limit int maximum number of requests to send per second (default 150)
-interactions-cache-size int Number of requests to keep in interactions cache (default 5000) -bs, -bulk-size int maximum number of hosts to be analyzed in parallel per template (default 25)
-interactions-eviction int Number of seconds to wait before evicting requests from cache (default 60) -c, -concurrency int maximum number of templates to be executed in parallel (default 10)
-interactions-poll-duration int Number of seconds before each interaction poll request (default 5)
-interactions-cooldown-period int Extra time for interaction polling before exiting (default 5)
-no-interactsh Do not use interactsh server for blind interaction polling
HEADLESS OPTIONS: OPTIMIZATIONS:
-headless Enable headless browser based templates support -timeout int time to wait in seconds before timeout (default 5)
-page-timeout int Seconds to wait for each page in headless mode (default 20) -retries int number of times to retry a failed request (default 1)
-show-browser Show the browser on the screen in headless mode -project use a project folder to avoid sending same request multiple times
-project-path string set a specific project path (default "/var/folders/ml/m31ysb5x73l1s3kjlyn5g4180000gn/T/")
-spm, -stop-at-first-path stop processing HTTP requests after the first match (may break template/workflow logic)
PROXY OPTIONS: HEADLESS:
-proxy, -proxy-url string URL of the proxy server -headless enable templates that require headless browser support
-proxy-socks-url string URL of the proxy socks server -page-timeout int seconds to wait for each page in headless mode (default 20)
-show-browser show the browser on the screen when running templates with headless mode
STATS OPTIONS: DEBUG:
-stats Display stats of the running scan -debug show all requests and responses
-stats-json Write stats output in JSON format -debug-req show all sent requests
-si, -stats-interval int Number of seconds between each stats line (default 5) -debug-resp show all received responses
-metrics Expose nuclei metrics on a port -proxy, -proxy-url string URL of the HTTP proxy server
-metrics-port int Port to expose nuclei metrics on (default 9092) -proxy-socks-url string URL of the SOCKS proxy server
-trace-log string file to write sent requests trace log
-version show nuclei version
-tv, -templates-version shows the version of the installed nuclei-templates
DEBUG OPTIONS: UPDATE:
-v, -verbose Show verbose output -update update nuclei to the latest released version
-vv Display Extra Verbose Information -ut, -update-templates update the community templates to latest released version
-debug Debugging request and responses -ud, -update-directory string overwrite the default nuclei-templates directory (default "$HOME/nuclei-templates")
-debug-req Debugging request
-debug-resp Debugging response
-silent Show only results in output
-version Show version of nuclei
-tv, -templates-version Shows the installed nuclei-templates version
-trace-log string File to write sent requests trace log
UPDATE OPTIONS: STATISTICS:
-update Self Update the nuclei engine to latest -stats display statistics about the running scan
-ut, -update-templates Download / updates nuclei community templates -stats-json write statistics data to and output file in JSONL(ines) format
-ud, -update-directory string Directory storing nuclei-templates (default "$HOME/nuclei-templates") -si, -stats-interval int number of seconds to wait between showing a statistics update (default 5)
-metrics expose nuclei metrics on a port
OTHER OPTIONS: -metrics-port int port to expose nuclei metrics on (default 9092)
-project Use a project folder to avoid sending same request multiple times
-project-path string Use a user defined project folder, temporary folder is used if not specified but enabled
-tl List available templates
-validate Validate the passed templates to nuclei
``` ```
</details> </details>