Skip to content

README.md

Latest commit

 

History

History
47 lines (29 loc) · 964 Bytes

README.md

File metadata and controls

47 lines (29 loc) · 964 Bytes

Nuclei API

The Nuclei API package provides a simple gRPC wrapper around the Nuclei scanner, allowing easy integration with other tools.

Installation

go install -v github.com/pyneda/nuclei-api@latest

or

git clone https://github.com/pyneda/nuclei-api
cd nuclei-api
go build

Usage

Start the server:

nuclei-api start -h

Configuration

Most of the options available in Nuclei to choose and filter templates are available as a part of the scan request.

Other options such as rate limits, interactsh configuration, etc are available as a part of the server configuration which can be configured using a YAML file. The following command is available to dump the default configuration:

nuclei-api dumpconfig

Example client

An example client is provided in the cmd/example directory.

It can be built with:

go build cmd/example/client.go