Install and sign in
Install the BreachLine CLI on macOS or Linux, sign in with your browser or an API key, and run your first session.
On this page
The BreachLine CLI is a terminal client for Nebula. It recons, tests and gathers evidence against targets you are authorized to test, on scope you confirm. Every model runs on your BreachLine account: there are no provider keys to configure.
Install
The installer downloads the prebuilt client for your platform from BreachLine’s release server, verifies its SHA-256 checksum before making it executable, and installs it to ~/.breachline/bin.
curl -fsSL https://dl.breachline.io/install.sh | sh
| Variable | Effect |
|---|---|
BREACHLINE_VERSION |
Install a specific release tag instead of the latest. |
BREACHLINE_INSTALL_DIR |
Install somewhere other than ~/.breachline/bin. |
The installer puts one command, breachline, in ~/.breachline/bin. Add that folder to your PATH if your shell does not find it. Upgrade later with breachline upgrade.
Sign in
Browser
breachline auth login
Choose browser sign-in, or email and password. Your credentials are stored on this machine for the CLI only.
API key
breachline auth login --key "$BREACHLINE_API_KEY"
The key is checked against your account and stored for later runs. Alternatively set BREACHLINE_API_KEY in the environment.
Sign out with breachline auth logout, which also clears all BreachLine data stored on the machine.
Run a session
breachline
The first launch asks for a project folder and signs you in if needed. To run a single prompt without the interactive interface:
breachline run "Map the public attack surface of staging.example.com. Scope: staging.example.com only."