Skip to main content

Installation

Three commands. You are done.

Install​

pip install blackrainbow

Create a Workspace​

br init

This creates a blackrainbow.yaml config file in your current directory with a starter template.

Verify​

br --version
blackrainbow, version 1.0.0

Requirements​

  • Python 3.10+
  • Standard security tools on your PATH (nmap, gobuster, etc.) depending on which plugins you use
  • Network access to your target environment

Upgrade​

pip install --upgrade blackrainbow

What's Next​

You have a blackrainbow.yaml in your directory. Head to the Quickstart to run your first engagement.