DarkLens CLI 🔍

Automated compliance scanning for Dark Patterns & Deceptive Design in your terminal and CI/CD pipelines.

DarkLens CLI detects illegal deceptive UX patterns, confirmshaming, hidden subscription renewals, interface interference, and compliance risks across GDPR, FTC Act Sec. 5, EU Digital Services Act (DSA), and CCPA/CPRA.

⚡ Quick Start

Run instantly without installation using npx:

npx darklens https://staging.myapp.com --key YOUR_DARKLENS_API_KEY

Or install globally:

npm install -g darklens
darklens https://staging.myapp.com --key YOUR_DARKLENS_API_KEY

🔑 Authentication

You can pass your API key directly via the --key flag or export it into your shell environment:

export DARKLENS_API_KEY="your_api_key_here"
darklens https://staging.myapp.com

Get your API key in the DarkLens Dashboard.

🛠️ CLI Options

| Option | Flag | Description | Default | | :--- | :--- | :--- | :--- | | Target URL | <url> | URL of the application to scan | Required | | API Key | -k, --key | Your DarkLens API key | $DARKLENS_API_KEY | | Threshold | -t, --threshold | Minimum passing score (0-100) | 70 | | Fail Criteria| -f, --fail-on | When to exit with error: score, critical, or any | score | | JSON Output | -j, --json | Output raw machine-readable JSON | false | | Help | -h, --help | Display help screen | — |

🚀 CI/CD Integration Examples

GitHub Actions

name: Dark Pattern Compliance Audit

on: [pull_request]

jobs:
  compliance_audit:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Run DarkLens CLI
        run: npx darklens https://staging.myapp.com --threshold 75
        env:
          DARKLENS_API_KEY: ${{ secrets.DARKLENS_API_KEY }}

(You can also use our native DarkLens GitHub Action.)

GitLab CI

darklens_scan:
  stage: test
  image: node:20
  script:
    - npx darklens "$CI_ENVIRONMENT_URL" --threshold 75
  rules:
    - if: $CI_PIPELINE_SOURCE == 'merge_request_event'

📋 Example Output

🔍 DarkLens Compliance Scanner v1.0.0

──────────────────────────────────────────────────
  Target:    https://staging.myapp.com
  Score:     88 / 100   PASS 
  Threshold: 70 / 100 (Criterion: fail on score)
  Breakdown: 0 Critical, 1 High, 0 Medium, 2 Low
──────────────────────────────────────────────────

Detected Findings (3):

  [1]  HIGH  Forced Continuity
      Category:    Subscription Deception
      Regulation:  FTC Act Sec. 5 | EU DSA Art. 25
      Details:     Pre-checked recurring auto-renewal box detected on checkout form.

✔ PASSED: Build criteria satisfied.

📄 License

MIT © DarkLens