README

NexPloit CLI

NexPloit CLI is a Command Line Interface (CLI) tool for NeuraLegion's solutions. You can use NexPloit CLI for full control over scans such as: initialize, stop, poll, maintain and more. In addition, NexPloit CLI can serve as a Repeater to scan local targets, without exposing them to the internet.

Features:

Supports official API
Configurable using JSON / XML / YML / JS formats
Can generate real interaction data (.har files) from mock interactions (Unit Tests), more info about NexMock here
Can serve as a Repeater for communication from the cloud to a local target

🚀 Quick Start

Before you can use NexPloit CLI make sure you have the following:

An active user on app.neuralegion.com
A valid TOKEN
- For the quick start these scopes are required: bot, scans:run and scans:read
- More info about setting up an API key
An active ID
- More info about Setting up a New Repeater

1. Install NexPloit CLI globally

npm install @neuralegion/nexploit-cli -g

You can validate the installation by going to the directory of your project and running the command:

nexploit-cli -h

This will show you a list of possible commands for NexPloit CLI, for a full list go here

2. Activate the Repeater

nexploit-cli repeater \
  --token {TOKEN} \
  --id {ID} \
  --bus amqps://amq.app.neuralegion.com:5672

3. Start a new scan with a Crawler

nexploit-cli scan:run \
  --token {TOKEN} \
  --repeater {ID} \
  --name "My First Scan" \
  --crawler https://www.example.com \
  --smart

This command will initialize a new scan engine in the cloud, which will start scanning the target via the local Repeater.

4. Check out the scan results

You can follow the scan status here: https://app.neuralegion.com/scans, or by using the NexPloit CLI polling command.

📚 Full Documentation

NexPloit CLI can do so much more! A full documentation with usage examples is available on NeuraLegion's knowledgebase

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

Usage no npm install needed!