unveilr-cli 0.3.0

Unveilr Security Intelligence Platform — CLI

Unveilr CLI

Security Intelligence from the terminal.

Unveilr CLI connects to your Unveilr platform and lets you run scans, triage findings, and generate compliance reports — all without leaving the terminal or your CI/CD pipeline.

Install

pip install unveilr-cli

Or with pipx (recommended for isolated installs):

pipx install unveilr-cli

Requires Python 3.10+.

Quick Start

# 1. Authenticate
unveilr login --url https://api.your-company.unveilr.com --username [e-mail]

# 2. Connect an AWS account
unveilr connect aws --role-arn arn:aws:iam::123456789012:role/UnveilrReadOnly

# 3. Run a unified scan
unveilr scan

# 4. Run a specific scan type against a repo
unveilr scan --type iac --repo https://github.com/org/infra

# 5. Check scan status
unveilr status

# 6. List critical findings
unveilr findings --severity critical

# 7. Generate a compliance report
unveilr compliance report --framework CIS-AWS --output report.pdf

Commands

Command	Description
unveilr login	Authenticate with the Unveilr API
unveilr logout	Clear stored credentials
unveilr whoami	Show current auth state
unveilr connect aws	Connect an AWS account via IAM role
unveilr scan	Run a unified scan (SAST, SCA, IaC, secrets, containers)
unveilr scan --type <type>	Run a specific scan (sast, sca, iac, secrets, container, dast)
unveilr status	Check the status of running scans
unveilr findings	List and filter security findings
unveilr compliance report	Generate compliance reports (CIS-AWS, SOC2, PCI-DSS, NIST, HIPAA, GDPR)

CI/CD Integration

GitHub Actions

- name: Unveilr Security Scan
  run: |
    pip install unveilr-cli
    unveilr login --url ${{ secrets.UNVEILR_API_URL }} --username ${{ secrets.UNVEILR_USER }} --password ${{ secrets.UNVEILR_PASS }}
    unveilr scan --type sast --repo ${{ github.server_url }}/${{ github.repository }}
    unveilr findings --severity critical --exit-code 1

GitLab CI

security_scan:
  image: python:3.12-slim
  script:
    - pip install unveilr-cli
    - unveilr login --url $UNVEILR_API_URL --username $UNVEILR_USER --password $UNVEILR_PASS
    - unveilr scan --type sast --repo $CI_PROJECT_URL
    - unveilr findings --severity critical --exit-code 1

Authentication

Credentials are stored locally at ~/.config/unveilr/config.json. The CLI uses JWT tokens to authenticate with the Unveilr API. Tokens refresh automatically.

You can also set environment variables:

export UNVEILR_API_URL=https://api.your-company.unveilr.com
export UNVEILR_TOKEN=your-api-token

Links

• Website: unveilr.com
• Documentation: docs.unveilr.com
• Support: [e-mail]