This repository is an implementation of Ostorlab Agent for the Nuclei Scanner by Project Discovery.

Getting Started

To perform your first scan, simply run the following command:

ostorlab scan run --install --agent agent/ostorlab/nuclei ip 8.8.8.8

This command will download and install agent/ostorlab/nuclei and target the ip 8.8.8.8. For more information, please refer to the Ostorlab Documentation

Usage

Agent Nuclei can be installed directly from the ostorlab agent store or built from this repository.

Install directly from ostorlab agent store

ostorlab agent install agent/ostorlab/nuclei

You can then run the agent with the following command:

ostorlab scan run --agent agent/ostorlab/nuclei ip 8.8.8.8

Build directly from the repository

1. To build the nuclei agent you need to have ostorlab installed in your machine. if you have already installed ostorlab, you can skip this step.

pip3 install ostorlab

2. Clone this repository.

git clone https://github.com/Ostorlab/agent_nuclei.git && cd agent_nuclei

3. Build the agent image using ostorlab cli.

ostortab agent build --file=ostorlab.yaml

You can pass the optional flag --organization to specify your organisation. The organization is empty by default.

4. Run the agent using on of the following commands:

• If you did not specify an organization when building the image:

```shell
ostorlab scan run --agent agent//nuclei ip 8.8.8.8
```

• If you specified an organization when building the image:

```shell
ostorlab scan run --agent agent/[ORGANIZATION]/nuclei ip 8.8.8.8
```

License

Apache