Quickstart
Scout is a single Go binary. Install it, point it at something, read the grade.
1. Install
Section titled “1. Install”go install github.com/MUKE-coder/scout/cmd/scout@latestThis puts scout on your PATH (in $(go env GOPATH)/bin). No account, no
config file required. See Installation for other ways.
2. Scan a running app
Section titled “2. Scan a running app”Start your app locally, then point Scout at it:
scout scan --target http://localhost:3000Scout crawls the surface, runs the safe-mode checks, and prints a graded report: findings grouped by severity, each with a CWE/OWASP tag and a fix.
3. Scan a repository
Section titled “3. Scan a repository”Point Scout at a checkout to find secrets, insecure Dockerfiles, weak crypto, dangerous sinks and reachable CVEs in your Go dependencies:
scout scan --repo .You can combine both in one scan:
scout scan --target http://localhost:3000 --repo . --mode active --env dev4. Gate your CI
Section titled “4. Gate your CI”Fail a pull request when Scout finds something at or above a severity:
scout ci --repo . --fail-on highIt exits non-zero on a qualifying finding, so the build turns red. See Gate your CI.
5. See it in the dashboard
Section titled “5. See it in the dashboard”scout serveOpens an embedded dashboard with scan history, findings and scheduled scans.
Where to go next
Section titled “Where to go next”- Try every check against the deliberately-vulnerable lab app.
- Learn the modes and environments that keep scans safe.
- Browse the full checks catalog.