bbot

(β˜… 10,473)

The recursive internet scanner for hackers. 🧑

  • .gitattributes
  • .gitignore
  • .gitmodules
  • .pre-commit-config.yaml
  • AGENTS.md
  • bbot-docker.sh
  • CLAUDE.md
  • codecov.yml
  • CONTRIBUTIONS.md
  • Dockerfile
  • Dockerfile.full
  • funding.yml
  • LICENSE
  • mkdocs.yml
  • pyproject.toml
  • README.md
  • uv.lock

# Installation Guide

1. Get the code
git clone https://github.com/blacklanternsecurity/bbot

Downloads the entire project code from GitHub to your computer.

cd bbot

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • pipx Installs Python-based CLI tools into isolated environments.
pipx install bbot

Installs the CLI tool into an isolated environment via pipx.

pipx install --pip-args '\--pre' bbot

Installs the CLI tool into an isolated environment via pipx.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t bbot .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 bbot

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pipx install --pip-args '\--pre' bbot

Installs the CLI tool into an isolated environment via pipx.

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation