Welcome to Sentinel Docs

Sentinel is a free, open-source framework that streamlines your entire bug bounty workflow. It's a powerful, interactive command-line tool designed to automate the tedious parts of security testing, from initial discovery and reconnaissance to vulnerability scanning and reporting.

See It In Action

bash

Core Features

Interactive Shell

An intuitive, easy-to-use shell with command history and tab-completion for managing targets and scans.

Automated Recon

Performs comprehensive reconnaissance, including subdomain enumeration, port scanning, and service detection.

Vulnerability Scanning

Runs targeted scans for common vulnerabilities like XSS, SQLi, LFI, and misconfigurations.

Organized Output

Saves all results in a clean, structured directory format for easy analysis and reporting.

Dependency Management

Features a built-in command to automatically install all required third-party security tools.

Extensible by Design

A simple shell script at its core, Sentinel is easy to understand, modify, and extend with your own tools.

Installation Guide

Sentinel is packaged as a .deb file for easy, system-wide installation on Debian-based Linux distributions (like Ubuntu, Kali Linux, etc.).

Step 1: Download the Package

Download the latest version using the button below. This will give you the sentinel_2.4.0_amd64.deb file.

Download Sentinel v2.4.0 (.deb)

Step 2: Install via Command Line

Open your terminal and navigate to the directory where you downloaded the file. Use the dpkg command with sudo to install it.

sudo dpkg -i sentinel_2.4.0_amd64.deb

This command installs the sentinel script to /usr/local/bin, making it accessible from anywhere in your terminal.

Step 3: Install Dependencies

The first time you run Sentinel, you must install its core dependencies. These are the third-party tools Sentinel uses to perform its scans. Sentinel automates this for you.

sentinel

Once inside the Sentinel shell, run the following command:

sentinel> run install_deps

Follow the on-screen prompts to complete the installation. You are now ready to hunt!

Dependencies

The run install_deps command will attempt to install the following essential security tools:

  • Subfinder: For fast and passive subdomain enumeration.
  • Amass: For in-depth, active subdomain discovery.
  • Nmap: For network exploration and port scanning.
  • Naabu: A fast port scanner for finding open ports quickly.
  • Gospider: A fast web spider for crawling websites.
  • Waybackurls: For fetching known URLs from archive services.
  • Gf: A wrapper around grep to filter for potential vulnerability patterns.
  • Dalfox: A powerful scanner for finding XSS vulnerabilities.
  • SQLMap: The industry-standard tool for detecting and exploiting SQL injection flaws.

Directory Structure

Sentinel creates a well-organized directory named bugbounty-results in your home directory to store all its findings. The structure for each target looks like this:

~/bugbounty-results/
└── [target_name]/
    ├── recon/
    │   ├── subdomains/
    │   ├── ports/
    │   └── services/
    ├── web/
    │   ├── crawling/
    │   └── screenshots/
    └── vulnerabilities/
        ├── xss/
        ├── sqli/
        └── ...

Command Reference

The following commands are available within the Sentinel interactive shell.

Command Description
add target [url] Adds a new target to the session. The URL should be in the format example.com.
run all Executes the full workflow: reconnaissance, web analysis, and vulnerability scanning.
run recon Performs only the reconnaissance phase (subdomains, ports, services).
run web Runs web-specific enumeration like crawling and screenshotting.
run vulns Initiates all available vulnerability scans (XSS, SQLi, etc.).
run install_deps Installs all required third-party tools. Should be run on first use.
show options Displays the currently set target for the session.
help Displays the list of available commands.
exit Exits the Sentinel interactive shell.

Contributing & Community

Sentinel is an open-source project, and contributions are welcome! Whether you're fixing a bug, adding a new feature, or improving documentation, your help is appreciated.

Reporting Issues

Found a bug or have a suggestion? The best way to let us know is by creating an issue on our GitHub repository. This allows us to track problems and collaborate on solutions publicly.

Open a GitHub Issue

Submitting Pull Requests

If you've made a change you'd like to contribute, please fork the repository and submit a pull request with a clear description of your changes.

View Pull Requests

Support the Project

If you find Sentinel useful in your work, consider making a small donation. Your support helps cover server costs and fuels the development of new features and improvements. Every contribution, no matter the size, makes a difference.

Donate via BuyMeACoffee