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.

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

Examples in Help Output #3978

Merged
merged 4 commits into from
Oct 11, 2023

Conversation

kchason
Copy link
Contributor

@kchason kchason commented Jul 25, 2023

Proposed changes

Addresses #3359 by adding the following text to the -help command:

EXAMPLES:
Run nuclei on single host:
	$ nuclei -target example.com

Run a scan with specific template directories:
	$ nuclei -target example.com -t cves/ -t panels/

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 markdown/

Additional documentation is available at: https://nuclei.projectdiscovery.io/nuclei/get-started/#running-nuclei

Checklist

  • Pull request is created against the dev branch
  • All checks passed (lint, unit/integration/regression tests etc.) with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

@tarunKoyalwar tarunKoyalwar deleted the branch projectdiscovery:dev August 4, 2023 14:51
@tarunKoyalwar tarunKoyalwar reopened this Aug 4, 2023
@kchason kchason changed the title examples in help output Examples in Help Output Sep 15, 2023
@kchason
Copy link
Contributor Author

kchason commented Oct 10, 2023

Is anything else needed on this?

@ehsandeep ehsandeep merged commit 2248c63 into projectdiscovery:dev Oct 11, 2023
9 of 11 checks passed
@ehsandeep ehsandeep linked an issue Oct 11, 2023 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add example section to bottom of help output
3 participants