Documentation Home

Community

ProjectDiscovery Documentation

Getting Started

Tools

Templates

Cloud Platform

Help

Try Cloud

Get Template Data

X API Key

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

A fast and customisable vulnerability scanner powered by simple YAML-based templates

Nuclei Overview

Learn about how to install and get started with Nuclei

Install

Installing Nuclei

Learn about how to run Nuclei and produce results

Running

Running Nuclei

Common questions and answers about Nuclei

Nuclei FAQ

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

Usage

Subfinder Usage

Learn about running Subfinder with examples including commands and output

A multi-cloud tool to identify assets across cloud service providers

Cloudlist Overview

Learn how to install Cloudlist and get started

Cloudlist Install

Learn Cloudlist usage including flags and filters

Cloudlist Usage

Learn about running Cloudlist with examples and support details

Running Cloudlist

A Go-based port scanning tool to quickly enumerate valid ports

Naabu Overview

Learn about how to install Naabu and get started

Installing Naabu

Learn about running Naabu with examples and sample output

Running Naabu

A web crawling framework designed to navigate and parse for hidden details

Katana Overview

Installing Katana

Review Katana usage including flags, configs, and options

Katana Usage

Learn about running Katana with examples including commands and output

Running Katana

A fast DNS toolkit for running various probes with multiple features

dnsx Overview

Learn about how to install and get started with dnsx

Installing dnsx

Learn dnsx usage including queries, filters, and configurations

dnsx Usage

Learn about running dnsx with examples including commands and output

Running dnsx

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

Httpx Usage

Learn about running httpx with examples including commands and output

Running httpx

A structured and easy way to navigate public CVE sources

cvemap overview

Learn about how to install and get started with cvemap

Installing cvemap

Learn cvemap usage including flags and filters

cvemap usage

Learn about running cvemap with examples including commands and output

Running cvemap

YAML based universal language for describing exploitable vulnerabilities

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

Learn about using a headless browser with Nuclei

Headless

Network

Learn about using Nuclei to work with the local file system

File

Learn more about using JavaScript with Nuclei v3

JavaScript Protocol Introduction

Review examples of JavaScript with Nuclei v3

Protocol

JavaScript Protocol

Learn about using external code with Nuclei

Code

Learn about the template flow engine in Nuclei v3

Flow

Learn about multi-protocol support in Nuclei v3

Multi-protocol

Matchers

Extractors

Variables

Review details on helper functions for Nuclei

Helper Functions

Review details on pre-processors for Nuclei

Preprocessors

Review details on template signing for Nuclei

Template Signing

Understanding OOB testing with Nuclei Templates

OOB Testing

Template Workflows

Template Workflows Overview

Review some template workflow examples for Nuclei

Examples

Workflow Examples

A hosted enterprise product for continuous visibility and vulnerability scanning

Introducing ProjectDiscovery Cloud Platform

Connect your Nuclei scan results in ProjectDiscovery Cloud Platform

PDCP (Free)

ProjectDiscovery Cloud Platform (Free)

Teams provides an enterprise product for exploitable vulnerabilites

PDCP (Teams)

ProjectDiscovery Cloud Platform (Teams)

Learn about getting started for free with ProjectDiscovery Cloud Platform

Getting Started with PDCP Free

Walk through the steps to install Nuclei to connect to PDCP

Nuclei Setup

Setting up Nuclei

Review your Nuclei scan results in ProjectDiscovery Cloud Platform

PDCP Setup

Setting up PDCP

Review your Nuclei Scan Results in ProjectDiscovery Cloud Platform

Connect Your Scan

Connect Your Scan to PDCP

Implement Advanced Integration Settings for Your PDCP Setup

Advanced Integration

Template Editor Introduction

Review details on using AI to help generate templates for Nuclei and PDCP

AI Assistance

Template Sharing

Review keyboard shortcuts for Nuclei templates

Keyboard Shortcuts

Editor Keyboard Shortcuts

Cloud Scanning Introduction

Details on the ProjectDiscovery Cloud Platform API

API Reference

Get Template Data

Authorizations

Path Parameters

Response