Privado
  • Privado
  • Getting Started With Privado
    • Quick Start
    • Running a Scan
    • Understanding Results
    • Command Reference
    • Understanding privado.json
      • Sources
      • Processing
      • Data Flow
      • Collections
      • Violations
  • Understanding Rules
    • What are Rules?
    • Sources
    • Sinks
      • Understanding Sinks
      • Storages
      • Third Parties
      • Leakages
      • Internal APIs
    • Collections
    • Policies
  • Tutorials
    • How to scan a repository using Privado
  • Customizing Privado
    • Add a new Source
    • Add a new Leakage Sink
    • Add a new Storage Sink
    • Add a new Third Party Sink
    • Add a new Policy
  • ROPA Report
    • Generating ROPA Report
  • Play Store Data Safety Report
    • Generate Play Store Data Safety Report
    • Uploading results to Play Store
  • Extra
    • Configurations
    • Contributing through GitHub
  • About Privado
    • LICENSING
    • Privacy Policy
    • Security
Powered by GitBook
On this page
Edit on GitHub
  1. Getting Started With Privado

Command Reference

Use privado --help for a list of available commands

Command
Description
Usage
Supported flags

scan

Scan a codebase or repository to identify privacy issues and generate compliance reports

privado scan <repository> [flags]

-c, --config string: Specifies the config (with rules) directory to be passed to privado-core for scanning. These external rules and configurations are merged with the default set that Privado defines --disable-deduplication When specified, the engine does not remove duplicate and subset dataflows. This option is useful if you wish to review all flows (including duplicates) manually -h, --help: help for scan -i, --ignore-default-rules: If specified, the default rules are ignored and only the specified rules (-r) are considered --overwrite: If specified, the warning prompt for existing scan results is disabled and any existing results are overwritten --skip-dependency-download: When specified, the engine skips downloading all locally unavailable dependencies. Skipping dependency download can yield incomplete results --upload : If specified, will automatically attempt to upload the scan result to Privado Dashboard --skip-upload : If specified, the result artifacts will not be uploaded to Privado Dashboard --debug: To enable process debug output for debugging purposes

config

List, enable, or disable telemetry for Privado CLI

privado config <List/enable/disable>

-h, --help: Help for config

help

Help provides help for any command in the application.

privado help [command]

-h, --help: Help for help

update

Check for latest release and update to the latest version Privado CLI

privado update [flags]

-h, --help: Help for update

version

Print the current version of Privado CLI

privado version [flags]

-h, --help: Help for version

upload

Sync the results of scan with Privado Dashboard

privado upload <repository> [flags]

-h, --help: Help for version

PreviousUnderstanding ResultsNextUnderstanding privado.json

Last updated 2 years ago