@boringsec/cli
v0.1.2
Published
BoringSec Security Scanner CLI — scan your websites and code from the terminal
Maintainers
Readme
@boringsec/cli
BoringSec Security Scanner CLI — scan websites and code from your terminal.
Release 0.1.2 is approved for npm distribution under proprietary licensing. Hosted scans require an eligible BoringSec account, authorized targets, and available quota.
Install
npm install -g @boringsec/[email protected]
boringsec login
boringsec helpLocal development
Version 0.1.2 automatically retries safe reads only. It does not automatically replay scan submissions after an error or redirect. If a request times out or its response cannot be confirmed, it may already have been accepted; check scan history and usage before submitting again. Older installed clients must be updated to receive these corrections.
# Build from this repository
npm --prefix packages/cli run build
# Scan a URL with the local build
node packages/cli/dist/index.js scan https://myapp.com
# Scan code in the current directory
node packages/cli/dist/index.js scan-code
# Preview connected scanner engines from a manifest
node packages/cli/dist/index.js connected-scan --manifest boringsec.scan.json --dry-run
# Check usage
node packages/cli/dist/index.js usage
# Set API key
node packages/cli/dist/index.js loginCommands
| Command | Description |
| ---------------------------------------------- | ----------------------------------------------- |
| scan <url> | Scan a URL for 75+ security issues |
| scan-code | Scan code files for secrets and unsafe patterns |
| connected-scan --manifest <path> [--dry-run] | Run configured connected scanner engines |
| usage | Show current usage and quota |
| login | Set your API key |
| help | Show help |
connected-scan --dry-run validates the manifest and prints planned engine commands without requiring an API key or uploading artifacts.
Features
- 75+ security checks (headers, SSL, DNS, XSS, injection, secrets)
- Colorized terminal output with severity badges
- CI/CD friendly (exit code 1 on critical findings)
- Works with GitHub Actions, GitLab CI, any CI system
Requirements
- Node.js 18+
- An eligible BoringSec API key with the required permissions and available quota
