Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Examples in Help Output #3978

Merged
merged 4 commits into from
Oct 11, 2023
Merged

Examples in Help Output #3978

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
da7540f
Example text in help flag
kchason Jul 25, 2023
0c1f288
Merge branch 'dev' into 3359-examples-in-help-output
kchason Aug 31, 2023
e036cf8
Merge branch 'dev' into 3359-examples-in-help-output
kchason Sep 14, 2023
6e37e3e
misc update
ehsandeep Oct 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions v2/cmd/nuclei/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,6 +337,25 @@ on extensive configurability, massive extensibility and ease of use.`)
flagSet.IntVar(&options.OutputLimit, "limit", 100, "limit the number of output to display"),
)

flagSet.SetCustomHelpText(`EXAMPLES:
Run nuclei on single host:
$ nuclei -target example.com

Run nuclei with specific template directories:
$ nuclei -target example.com -t http/cves/ -t ssl

Run nuclei against a list of hosts:
$ nuclei -list hosts.txt

Run nuclei with a JSON output:
$ nuclei -target example.com -json-export output.json

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
`)

_ = flagSet.Parse()

gologger.DefaultLogger.SetTimestamp(options.Timestamp, levels.LevelDebug)
Expand Down
Loading