Documentation Home

Community

ProjectDiscovery Documentation

Getting Started

Tools

Templates

Cloud

Help

Try Cloud

Learn about how to install and get started with Nuclei

Install

Installing Nuclei

Rishi

Welcome to the ProjectDiscovery documentation site

Introduction

Details on navigating our documentation site and the content available here

Using the docs

Learn about ProjectDiscovery and our open source tools

What is ProjectDiscovery?

ProjectDiscovery Introduction

New to ProjectDiscovery and looking to get started?

Start Here!

Start Here

Follow the steps below to setup and try out Nuclei

Example Walkthrough

You successfully completed the Getting Started example, what's next?

What's Next?

Learn about ProjectDiscovery's Open Source Tools

Overview

Open Source Tools

Fast and customisable vulnerability scanner based on simple YAML based DSL

Nuclei Overview

Learn about how to run Nuclei and produce results

Running

Running Nuclei

Common questions and answers about using Nuclei

Nuclei FAQ

An HTTP toolkit that probes services, web servers, and other valuable metadata

httpx Overview

Learn about how to install and get started with httpx

Installing httpx

Learn httpx usage including flags, probes, and options

Usage

Httpx Usage

Learn about running httpx with examples including commands and output

Running httpx

A robust discovery tool for passive enumeration on valid subdomains

Subfinder Overview

Learn about how to install and get started with Subfinder

Installing Subfinder

Learn Subfinder usage including input, flags, and filters

Subfinder Usage

Learn about running Subfinder with examples including commands and output

YAML based universal language for describing exploitable vulnerabilties

Introduction to Nuclei Templates

Learn the common elements required to create a Nuclei Template

Structure

Nuclei Template Structure

Some common questions and answers about Nuclei templates

Templates FAQ

Basic HTTP

Raw HTTP

Headless

Network

File

JavaScript Protocol Introduction

Protocol

JavaScript Protocol

Code

Flow

Multi-protocol

Matchers

Extractors

Variables

Helper Functions

Preprocessors

Template Signing

OOB Testing

Template Workflows

Template Workflows Overview

Examples

Workflow Examples

Introduction to ProjectDiscovery Cloud Platform

Template Editor Introduction

AI Assistance

Template Sharing

Keyboard Shortcuts

Editor Keyboard Shortcuts

Cloud Scanning Introduction

Scan target host using a specified nuclei template.

Scan Template

Generate Template (AI)

Review your options for getting help from ProjectDiscovery

Tools

Nuclei

httpx

Subfinder

Installing Nuclei

Go

Brew

Docker

GitHub

Binary

Helm