guarddog-cli

Privacy and compliance scanning CLI -- PII detection, data flow tracing, cookie audit, GDPR checklist from your terminal.

Architecture

graph TD
    CLI[guarddog CLI] --> FREE[Free Commands]
    CLI --> PRO[Pro Commands]

    FREE --> SP[scan-pii]
    FREE --> SF[scan-flow]
    FREE --> CK[cookies]
    FREE --> RT[retention]
    FREE --> CN[consent]
    FREE --> SC[score]
    FREE --> DP[deps]

    PRO --> GC[gdpr-check]
    PRO --> RO[ropa]
    PRO --> DI[dpia]
    PRO --> DF[diff]
    PRO --> PL[policy]
    PRO --> MR[multi-repo]

    SP --> LIB[Scanning Engine]
    SF --> LIB
    CK --> LIB
    RT --> LIB
    CN --> LIB
    SC --> LIB
    DP --> LIB
    GC --> LIB
    RO --> LIB
    DI --> LIB
    DF --> LIB
    PL --> LIB

    LIB --> PII[pii-scanner]
    LIB --> DFT[data-flow-tracer]
    LIB --> CSC[cookie-scanner]
    LIB --> RA[retention-analyzer]
    LIB --> CA[consent-analyzer]
    LIB --> DC[dependency-checker]
    LIB --> PS[project-scanner]

Install

npm install -g guarddog-cli

Commands

| Command | Description | Tier | |:--------|:-----------|:-----| | guarddog scan-pii [path] | Scan for PII fields (12 categories) | Free | | guarddog scan-flow [path] | Trace PII data flows (collection -> storage -> external) | Free | | guarddog cookies [path] | Audit cookie usage and consent-before-set | Free | | guarddog retention [path] | Check data retention (TTL, soft-delete, deletion endpoints) | Free | | guarddog consent [path] | Scan consent management patterns | Free | | guarddog score [path] | Privacy readiness score 0-100 | Free | | guarddog deps [path] | Audit dependencies for data-sharing concerns | Free | | guarddog gdpr-check [path] | GDPR article compliance checklist | Pro | | guarddog ropa [path] | Generate ROPA template (draft) | Pro | | guarddog dpia [path] | Generate DPIA template (draft) | Pro | | guarddog diff <from> <to> | Privacy posture diff between git refs | Pro | | guarddog policy [path] | Generate privacy/cookie policy drafts | Pro | | guarddog multi-repo <repos...> | Cross-repo privacy scan (requires GITHUB_TOKEN) | Pro |

All commands support --json for machine-readable output.

Usage

# Scan for PII fields
guarddog scan-pii ./my-project

# Privacy readiness score
guarddog score ./my-project

# JSON output for CI
guarddog score ./my-project --json

# Cookie audit
guarddog cookies ./my-frontend

# GDPR checklist (Pro)
PRO_LICENSE=your-key guarddog gdpr-check ./my-project

# Privacy posture diff (Pro)
PRO_LICENSE=your-key guarddog diff main feature-branch

# Generate policies (Pro)
PRO_LICENSE=your-key guarddog policy ./my-project --company "Acme Inc" --website "https://acme.com"

PII Categories (12)

| Category | Example Fields | |:---------|:--------------| | email | email, user_email, contact_email | | phone | phone, mobile, telephone | | address | address, street, zip, postal | | ip_address | ip_address, remote_addr, client_ip | | ssn | ssn, social_security, tax_id | | dob | dob, date_of_birth, birthday | | name | first_name, last_name, full_name | | location | latitude, longitude, coordinates | | device_id | device_id, user_agent, fingerprint | | financial | credit_card, card_number, iban | | health | diagnosis, medical, prescription | | biometric | face_id, retina, voice_print |

Pro License

Pro commands require a PRO_LICENSE environment variable:

export PRO_LICENSE=your-license-key

Disclaimer

Not a substitute for qualified legal counsel. guarddog-cli provides automated pattern detection to assist with privacy compliance. Always consult qualified legal professionals for compliance decisions.

License

MIT