Get started

Deployed in minutes. On your infrastructure.

Five steps from clone to your first organization-wide scan. Everything runs on your servers — nothing leaves your network.

✓ Docker + Docker Compose✓ git on PATH✓ a GitHub token (optional, for private repos)

Clone the repository

bash

git clone https://github.com/YOUR_USERNAME/perryscope.git
cd perryscope

Set LOG_LEVEL, REPORTS_DIR, and optionally GITHUB_TOKEN — the .env.example documents 40+ variables.

bash

cp backend/.env.example backend/.env
nano backend/.env

Deploying to a remote server? Update the two frontend build args in docker-compose.yml (VITE_API_BASE_URL, VITE_WS_BASE_URL) first.

bash

docker compose up -d --build

bash

curl -X POST http://localhost:8001/scan/github/org \
  -H "Content-Type: application/json" \
  -d '{"org": "your-github-org"}'

Watch findings arrive live over WebSocket, triage by severity and validation outcome, and export evidence.

UI → http://localhost:3001API → http://localhost:8001API docs → http://localhost:8001/docs

Block secrets at commit time in every developer's local workflow.

Publish scan results to GitHub Code Scanning via SARIF 2.1.0.

make up GOVERNANCE_PROVIDER=… wires SimpleRisk or CISO Assistant.

Get started

Five steps from clone to your first organization-wide scan. Everything runs on your servers — nothing leaves your network.

✓ Docker + Docker Compose✓ git on PATH✓ a GitHub token (optional, for private repos)

bash

git clone https://github.com/YOUR_USERNAME/perryscope.git
cd perryscope

Set LOG_LEVEL, REPORTS_DIR, and optionally GITHUB_TOKEN — the .env.example documents 40+ variables.

bash

cp backend/.env.example backend/.env
nano backend/.env

Deploying to a remote server? Update the two frontend build args in docker-compose.yml (VITE_API_BASE_URL, VITE_WS_BASE_URL) first.

bash

docker compose up -d --build

bash

curl -X POST http://localhost:8001/scan/github/org \
  -H "Content-Type: application/json" \
  -d '{"org": "your-github-org"}'

Watch findings arrive live over WebSocket, triage by severity and validation outcome, and export evidence.

UI → http://localhost:3001API → http://localhost:8001API docs → http://localhost:8001/docs