Skip to content

Commit 50f2ff5

Browse files
committed
readme updates
1 parent 5f0b7eb commit 50f2ff5

File tree

1 file changed

+47
-35
lines changed

1 file changed

+47
-35
lines changed

README.md

+47-35
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,7 @@ TEMPLATES:
157157
-as, -automatic-scan automatic web scan using wappalyzer technology detection to tags mapping
158158
-t, -templates string[] list of template or template directory to run (comma-separated, file)
159159
-turl, -template-url string[] template url or list containing template urls to run (comma-separated, file)
160+
-ai, -prompt string generate and run template using ai prompt
160161
-w, -workflows string[] list of workflow or workflow directory to run (comma-separated, file)
161162
-wurl, -workflow-url string[] workflow url or list containing workflow urls to run (comma-separated, file)
162163
-validate validate the passed templates to nuclei
@@ -167,6 +168,9 @@ TEMPLATES:
167168
-sign signs the templates with the private key defined in NUCLEI_SIGNATURE_PRIVATE_KEY env variable
168169
-code enable loading code protocol-based templates
169170
-dut, -disable-unsigned-templates disable running unsigned templates or templates with mismatched signature
171+
-esc, -enable-self-contained enable loading self-contained templates
172+
-egm, -enable-global-matchers enable loading global matchers templates
173+
-file enable loading file templates
170174

171175
FILTERING:
172176
-a, -author string[] templates to run based on authors (comma-separated, file)
@@ -178,10 +182,10 @@ FILTERING:
178182
-it, -include-templates string[] path to template file or directory to be executed even if they are excluded either by default or configuration
179183
-et, -exclude-templates string[] path to template file or directory to exclude (comma-separated, file)
180184
-em, -exclude-matchers string[] template matchers to exclude in result
181-
-s, -severity value[] templates to run based on severity. Possible values - info, low, medium, high, critical, unknown
182-
-es, -exclude-severity value[] templates to exclude based on severity. Possible values - info, low, medium, high, critical, unknown
183-
-pt, -type value[] templates to run based on protocol type. Possible values - dns, file, http, headless, tcp, workflow, ssl, websocket, whois, code, javascript
184-
-ept, -exclude-type value[] templates to exclude based on protocol type. Possible values - dns, file, http, headless, tcp, workflow, ssl, websocket, whois, code, javascript
185+
-s, -severity value[] templates to run based on severity. Possible values: info, low, medium, high, critical, unknown
186+
-es, -exclude-severity value[] templates to exclude based on severity. Possible values: info, low, medium, high, critical, unknown
187+
-pt, -type value[] templates to run based on protocol type. Possible values: dns, file, http, headless, tcp, workflow, ssl, websocket, whois, code, javascript
188+
-ept, -exclude-type value[] templates to exclude based on protocol type. Possible values: dns, file, http, headless, tcp, workflow, ssl, websocket, whois, code, javascript
185189
-tc, -template-condition string[] templates to run based on expression condition
186190

187191
OUTPUT:
@@ -226,7 +230,7 @@ CONFIGURATIONS:
226230
-ca, -client-ca string client certificate authority file (PEM-encoded) used for authenticating against scanned hosts
227231
-sml, -show-match-line show match lines for file templates, works with extractors only
228232
-ztls use ztls library with autofallback to standard one for tls13 [Deprecated] autofallback to ztls is enabled by default
229-
-sni string tls sni hostname to use (default - input domain name)
233+
-sni string tls sni hostname to use (default: input domain name)
230234
-dka, -dialer-keep-alive value keep-alive duration for network requests.
231235
-lfa, -allow-local-file-access allows file (payload) access anywhere on the system
232236
-lna, -restrict-local-network-access blocks connections to the local / private network
@@ -240,7 +244,7 @@ CONFIGURATIONS:
240244
-hae, -http-api-endpoint string experimental http api endpoint
241245

242246
INTERACTSH:
243-
-iserver, -interactsh-server string interactsh server url for self-hosted instance (default - oast.pro,oast.live,oast.site,oast.online,oast.fun,oast.me)
247+
-iserver, -interactsh-server string interactsh server url for self-hosted instance (default: oast.pro,oast.live,oast.site,oast.online,oast.fun,oast.me)
244248
-itoken, -interactsh-token string authentication token for self-hosted interactsh server
245249
-interactions-cache-size int number of requests to keep in the interactions cache (default 5000)
246250
-interactions-eviction int number of seconds to wait before evicting requests from cache (default 60)
@@ -249,13 +253,19 @@ INTERACTSH:
249253
-ni, -no-interactsh disable interactsh server for OAST testing, exclude OAST based templates
250254

251255
FUZZING:
252-
-ft, -fuzzing-type string overrides fuzzing type set in template (replace, prefix, postfix, infix)
253-
-fm, -fuzzing-mode string overrides fuzzing mode set in template (multiple, single)
254-
-fuzz enable loading fuzzing templates (Deprecated; use -dast instead)
255-
-dast enable / run dast (fuzz) nuclei templates
256-
-dfp, -display-fuzz-points display fuzz points in the output for debugging
257-
-fuzz-param-frequency int frequency of uninteresting parameters for fuzzing before skipping (default 10)
258-
-fa, -fuzz-aggression string fuzzing aggression level controls payload count for fuzz (low, medium, high) (default "low")
256+
-ft, -fuzzing-type string overrides fuzzing type set in template (replace, prefix, postfix, infix)
257+
-fm, -fuzzing-mode string overrides fuzzing mode set in template (multiple, single)
258+
-fuzz enable loading fuzzing templates (Deprecated: use -dast instead)
259+
-dast enable / run dast (fuzz) nuclei templates
260+
-dts, -dast-server enable dast server mode (live fuzzing)
261+
-dtr, -dast-report write dast scan report to file
262+
-dtst, -dast-server-token string dast server token (optional)
263+
-dtsa, -dast-server-address string dast server address (default "localhost:9055")
264+
-dfp, -display-fuzz-points display fuzz points in the output for debugging
265+
-fuzz-param-frequency int frequency of uninteresting parameters for fuzzing before skipping (default 10)
266+
-fa, -fuzz-aggression string fuzzing aggression level controls payload count for fuzz (low, medium, high) (default "low")
267+
-cs, -fuzz-scope string[] in scope url regex to be followed by fuzzer
268+
-cos, -fuzz-out-scope string[] out of scope url regex to be excluded by fuzzer
259269

260270
UNCOVER:
261271
-uc, -uncover enable uncover engine
@@ -302,23 +312,24 @@ HEADLESS:
302312
-lha, -list-headless-action list available headless actions
303313

304314
DEBUG:
305-
-debug show all requests and responses
306-
-dreq, -debug-req show all sent requests
307-
-dresp, -debug-resp show all received responses
308-
-p, -proxy string[] list of http/socks5 proxy to use (comma separated or file input)
309-
-pi, -proxy-internal proxy all internal requests
310-
-ldf, -list-dsl-function list all supported DSL function signatures
311-
-tlog, -trace-log string file to write sent requests trace log
312-
-elog, -error-log string file to write sent requests error log
313-
-version show nuclei version
314-
-hm, -hang-monitor enable nuclei hang monitoring
315-
-v, -verbose show verbose output
316-
-profile-mem string optional nuclei memory profile dump file
317-
-vv display templates loaded for scan
318-
-svd, -show-var-dump show variables dump for debugging
319-
-ep, -enable-pprof enable pprof debugging server
320-
-tv, -templates-version shows the version of the installed nuclei-templates
321-
-hc, -health-check run diagnostic check up
315+
-debug show all requests and responses
316+
-dreq, -debug-req show all sent requests
317+
-dresp, -debug-resp show all received responses
318+
-p, -proxy string[] list of http/socks5 proxy to use (comma separated or file input)
319+
-pi, -proxy-internal proxy all internal requests
320+
-ldf, -list-dsl-function list all supported DSL function signatures
321+
-tlog, -trace-log string file to write sent requests trace log
322+
-elog, -error-log string file to write sent requests error log
323+
-version show nuclei version
324+
-hm, -hang-monitor enable nuclei hang monitoring
325+
-v, -verbose show verbose output
326+
-profile-mem string generate memory (heap) profile & trace files
327+
-vv display templates loaded for scan
328+
-svd, -show-var-dump show variables dump for debugging
329+
-vdl, -var-dump-limit int limit the number of characters displayed in var dump (default 255)
330+
-ep, -enable-pprof enable pprof debugging server
331+
-tv, -templates-version shows the version of the installed nuclei-templates
332+
-hc, -health-check run diagnostic check up
322333

323334
UPDATE:
324335
-up, -update update nuclei engine to the latest released version
@@ -331,6 +342,7 @@ STATISTICS:
331342
-sj, -stats-json display statistics in JSONL(ines) format
332343
-si, -stats-interval int number of seconds to wait between showing a statistics update (default 5)
333344
-mp, -metrics-port int port to expose nuclei metrics on (default 9092)
345+
-hps, -http-stats enable http status capturing (experimental)
334346

335347
CLOUD:
336348
-auth configure projectdiscovery cloud (pdcp) api key (default true)
@@ -348,19 +360,19 @@ AUTHENTICATION:
348360

349361
EXAMPLES:
350362
Run nuclei on single host:
351-
$ nuclei -target example.com
363+
$ nuclei -target example.com
352364

353365
Run nuclei with specific template directories:
354-
$ nuclei -target example.com -t http/cves/ -t ssl
366+
$ nuclei -target example.com -t http/cves/ -t ssl
355367

356368
Run nuclei against a list of hosts:
357-
$ nuclei -list hosts.txt
369+
$ nuclei -list hosts.txt
358370

359371
Run nuclei with a JSON output:
360-
$ nuclei -target example.com -json-export output.json
372+
$ nuclei -target example.com -json-export output.json
361373

362374
Run nuclei with sorted Markdown outputs (with environment variables):
363-
$ MARKDOWN_EXPORT_SORT_MODE=template nuclei -target example.com -markdown-export nuclei_report/
375+
$ MARKDOWN_EXPORT_SORT_MODE=template nuclei -target example.com -markdown-export nuclei_report/
364376

365377
Additional documentation is available at: https://docs.nuclei.sh/getting-started/running
366378

0 commit comments

Comments
 (0)