nuclei

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.

• Simple YAML format for creating and customizing vulnerability templates.
• Contributed by thousands of security professionals to tackle trending vulnerabilities.
• Reduce false positives by simulating real-world steps to verify a vulnerability.
• Ultra-fast parallel scan processing and request clustering.
• Integrate into CI/CD pipelines for vulnerability detection and regression testing.
• Supports multiple protocols like TCP, DNS, HTTP, SSL, WHOIS, JavaScript, Code and more.
• Integrate with Jira, Splunk, GitHub, Elastic, GitLab.

Table of Contents

• Get Started
  • 1. Nuclei CLI
  • 2. Pro and Enterprise Editions
• Documentation
  • Command Line Flags
  • Single target scan
  • Scanning multiple targets
  • Network scan
  • Scanning with your custom template
  • Connect Nuclei to ProjectDiscovery_
• Nuclei Templates, Community and Rewards 💎
• Our Mission
• Contributors ❤
• License

Get Started

1. Nuclei CLI

Install Nuclei on your machine. Get started by following the installation guide here. Additionally, We provide a free cloud tier and comes with a generous monthly free limits:

• Store and visualize your vulnerability findings
• Write and manage your nuclei templates
• Access latest nuclei templates
• Discover and store your targets

[!Important]

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:

• 50x faster scans
• Large scale scanning with high accuracy
• Integrations with cloud services (AWS, GCP, Azure, Cloudflare, Fastly, Terraform, Kubernetes)
• Jira, Slack, Linear, APIs and Webhooks
• Executive and compliance reporting
• Plus: Real-time scanning, SAML SSO, SOC 2 compliant platform (with EU and US hosting options), shared team workspaces, and more
• We're constantly adding new features!
• Ideal for: Pentesters, security teams, and enterprises

Sign up to Pro or Talk to our team if you have large organization and complex requirements.

Documentation

Browse the full Nuclei documentation here. If you’re new to Nuclei, check out our foundational YouTube series.

Installation

nuclei requires go >= 1.24.2 to install successfully. Run the following command to get the repo:

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:

nuclei -h

Nuclei is a fast, template based vulnerability scanner focusing
on extensive configurability, massive extensibility and ease of use.

Usage:
  ./nuclei [flags]