CLI

These are autogenerated CLI docs that reflect the latest PyPI release.

fides

__Command-line tool for the Fides privacy engineering platform.__

---

_Note: The common MANIFESTS_DIR argument _always_ defaults to ".fides/" if not specified._

Usage:

1	`fides [OPTIONS] COMMAND [ARGS]...`

Options:

  --version               Show the version and exit.
  -f, --config-path TEXT  Path to a Fides config file. _Defaults to
                          `.fides/fides.toml`._
  --local                 Run in `local_mode`. Where possible, this will force
                          commands to run without the need for a server.
  --help                  Show this message and exit.

fides annotate

1	`Interactively annotate Fides resources.`

Usage:

1	`fides annotate [OPTIONS] COMMAND [ARGS]...`

Options:

1	`--help Show this message and exit.`

fides annotate dataset

1	`Interactively annotate a dataset file in-place.`

Usage:

1	`fides annotate dataset [OPTIONS] INPUT_FILENAME`

Options:

  -a, --all-members  Annotate all parts of the dataset including schemas and
                     tables.
  -v, --validate     Validate annotation inputs.
  --help             Show this message and exit.

fides db

1	`Run actions against the application database.`

Usage:

1	`fides db [OPTIONS] COMMAND [ARGS]...`

Options:

1	`--help Show this message and exit.`

fides db init

Runs all upgrade migrations for the Fides database.

Will also automatically initialize a fresh database.

**WARNING**: Deprecated, use `upgrade` instead.

Usage:

1	`fides db init [OPTIONS]`

Options:

1	`--help Show this message and exit.`

fides db reset

1	`Reset the database back to its initial state.`

Usage:

1	`fides db reset [OPTIONS]`

Options:

  -y, --yes  Automatically responds `yes` to any prompts.
  --help     Show this message and exit.

fides db upgrade

Runs all upgrade migrations for the Fides database.

Will also automatically initialize a fresh database.

Usage:

1	`fides db upgrade [OPTIONS]`

Options:

1	`--help Show this message and exit.`

fides delete

1	`Delete an object from the server.`

Usage:

fides delete [OPTIONS] {data_category|data_qualifier|data_subject|data_use|dat
             aset|organization|policy|registry|system|evaluation} FIDES_KEY

Options:

1	`--help Show this message and exit.`

fides deploy

1	`Deploy a sample project locally to try out Fides.`

Usage:

1	`fides deploy [OPTIONS] COMMAND [ARGS]...`

Options:

1	`--help Show this message and exit.`

fides deploy down

1	`Stops the sample project and removes all volumes.`

Usage:

1	`fides deploy down [OPTIONS]`

Options:

1	`--help Show this message and exit.`

fides deploy up

1	`Starts a sample project via docker compose.`

Usage:

1	`fides deploy up [OPTIONS]`

Options:

  --no-pull        Use a local image instead of trying to pull from DockerHub.
  --no-init        Disable the initialization of the Fides CLI, to run in
                   headless mode.
  --env-file PATH  Use a custom ENV file for the Fides container to override
                   settings.
  --image TEXT     Use a custom image for the Fides container instead of the
                   default ('ethyca/fides').
  --help           Show this message and exit.

fides evaluate

Evaluate System-level Privacy Declarations against Organization-level Policy Rules.

Usage:

1	`fides evaluate [OPTIONS] [MANIFESTS_DIR]`

Options:

  -k, --fides-key TEXT  The fides_key of a specific policy to evaluate.
  -m, --message TEXT    Describe the context of this evaluation.
  -a, --audit           Validate that the objects in this evaluation produce a
                        valid data map.
  --dry                 Do not upload objects or results to the Fides
                        webserver.
  --help                Show this message and exit.

fides generate

1	`Programmatically generate Fides objects.`

Usage:

1	`fides generate [OPTIONS] COMMAND [ARGS]...`

Options:

1	`--help Show this message and exit.`

fides generate dataset

1	`Generate Fides datasets.`

Usage:

1	`fides generate dataset [OPTIONS] COMMAND [ARGS]...`

Options:

1	`--help Show this message and exit.`

fides generate dataset aws

1	`Generate Fides datasets from specific Amazon Web Services.`

Usage:

1	`fides generate dataset aws [OPTIONS] COMMAND [ARGS]...`

Options:

1	`--help Show this message and exit.`

fides generate dataset aws dynamodb

1	`Generate a dataset object from BigQuery using a SQLAlchemy connection string.`

Usage:

1	`fides generate dataset aws dynamodb [OPTIONS] OUTPUT_FILENAME`

Options:

  --credentials-id TEXT     Use credentials keys defined within Fides config.
  --access_key_id TEXT      Connect to AWS using an `Access Key ID`. _Requires
                            options `--access_key_id`, `--secret_access_key` &
                            `--region`._
  --secret_access_key TEXT  Connect to AWS using an `Access Key`. _Requires
                            options `--access_key_id`, `--secret_access_key` &
                            `--region`._
  --region TEXT             Connect to AWS using a specific `Region`.
                            _Requires options `--access_key_id`,
                            `--secret_access_key` & `--region`._
  --include-null            Include null attributes.
  --help                    Show this message and exit.

fides generate dataset db

Generate a Fides dataset by walking a database and recording every schema/table/field.

Usage:

1	`fides generate dataset db [OPTIONS] OUTPUT_FILENAME`

Options:

  --credentials-id TEXT     Use credentials keys defined within Fides config.
  --connection-string TEXT  Use the connection string option to connect to a
                            database.
  --include-null            Include null attributes.
  --help                    Show this message and exit.

fides generate dataset gcp

1	`Generate Fides datasets from Google Cloud Platform.`

Usage:

1	`fides generate dataset gcp [OPTIONS] COMMAND [ARGS]...`

Options:

1	`--help Show this message and exit.`

fides generate dataset gcp bigquery

1	`Generate a dataset object from BigQuery using a SQLAlchemy connection string.`

Usage:

1	`fides generate dataset gcp bigquery [OPTIONS] DATASET_NAME OUTPUT_FILENAME`

Options:

  --credentials-id TEXT  Use credentials keys defined within Fides config.
  --keyfile-path TEXT
  --include-null         Include null attributes.
  --help                 Show this message and exit.

fides generate system

1	`Generate Fides systems.`

Usage:

1	`fides generate system [OPTIONS] COMMAND [ARGS]...`

Options:

1	`--help Show this message and exit.`

fides generate system aws

Connect to an aws account and generate a system manifest file that consists of every
tracked resource.

Usage:

1	`fides generate system aws [OPTIONS] OUTPUT_FILENAME`

Options:

  --credentials-id TEXT     Use credentials keys defined within Fides config.
  --access_key_id TEXT      Connect to AWS using an `Access Key ID`. _Requires
                            options `--access_key_id`, `--secret_access_key` &
                            `--region`._
  --secret_access_key TEXT  Connect to AWS using an `Access Key`. _Requires
                            options `--access_key_id`, `--secret_access_key` &
                            `--region`._
  --region TEXT             Connect to AWS using a specific `Region`.
                            _Requires options `--access_key_id`,
                            `--secret_access_key` & `--region`._
  --include-null            Include null attributes.
  -k, --org-key TEXT        The `organization_fides_key` of the `Organization`
                            you want to specify.  [default:
                            default_organization]
  --help                    Show this message and exit.

fides generate system okta

Generates systems from your Okta applications. Connects via
an Okta admin account.

Usage:

1	`fides generate system okta [OPTIONS] OUTPUT_FILENAME`

Options:

  --credentials-id TEXT  Use credentials keys defined within Fides config.
  --org-url TEXT         Connect to Okta using an 'Org URL'. _Requires options
                         `--org-url` & `--token`._
  --token TEXT           Connect to Okta using a token. _Requires options
                         `--org-url` and `--token`._
  --include-null         Include null attributes.
  -k, --org-key TEXT     The `organization_fides_key` of the `Organization`
                         you want to specify.  [default: default_organization]
  --help                 Show this message and exit.

fides get

1	`View an object from the server.`

Usage:

fides get [OPTIONS] {data_category|data_qualifier|data_subject|data_use|datase
          t|organization|policy|registry|system|evaluation} FIDES_KEY

Options:

1	`--help Show this message and exit.`

fides init

Initializes a Fides instance by creating the default directory and
configuration file if not present.

Usage:

1	`fides init [OPTIONS] [FIDES_DIR]`

Options:

  --opt-in  Automatically opt-in to anonymous usage analytics.
  --help    Show this message and exit.

fides ls

1	`View all objects of a single type from the server.`

Usage:

fides ls [OPTIONS] {data_category|data_qualifier|data_subject|data_use|dataset
         |organization|policy|registry|system|evaluation}

Options:

  -v, --verbose  Displays the entire object list as YAML.
  --help         Show this message and exit.

fides parse

1	`Parse all Fides objects located in the supplied directory.`

Usage:

1	`fides parse [OPTIONS] [MANIFESTS_DIR]`

Options:

  -v, --verbose  Enable verbose output.
  --help         Show this message and exit.

fides pull

1	`Update local resource files based on the state of the objects on the server.`

Usage:

1	`fides pull [OPTIONS] [MANIFESTS_DIR]`

Options:

  -a, --all-resources TEXT  Pulls all locally missing resources from the
                            server into this file.
  --help                    Show this message and exit.

fides push

1	`Parse local manifest files and upload them to the server.`

Usage:

1	`fides push [OPTIONS] [MANIFESTS_DIR]`

Options:

  --dry   Do not upload results to the Fides webserver.
  --diff  Print any diffs between the local & server objects
  --help  Show this message and exit.

fides scan

Scan and report on discrepancies between Fides resource files and real infrastructure.

Usage:

1	`fides scan [OPTIONS] COMMAND [ARGS]...`

Options:

1	`--help Show this message and exit.`

fides scan dataset

1	`Scan and report on Fides Dataset resources.`

Usage:

1	`fides scan dataset [OPTIONS] COMMAND [ARGS]...`

Options:

1	`--help Show this message and exit.`

fides scan dataset db

Scan a database directly using a SQLAlchemy-style connection string.

_If there are fields within the database that aren't listed and categorized
within one of the datasets, this counts as lacking coverage._

Usage:

1	`fides scan dataset db [OPTIONS] [MANIFESTS_DIR]`

Options:

  --credentials-id TEXT           Use credentials keys defined within Fides
                                  config.
  --connection-string TEXT        Use the connection string option to connect
                                  to a database.
  -c, --coverage-threshold INTEGER RANGE
                                  Set the coverage percentage for a passing
                                  scan.  [0<=x<=100]
  --help                          Show this message and exit.

fides scan system

1	`Scan and report on Fides System resources.`

Usage:

1	`fides scan system [OPTIONS] COMMAND [ARGS]...`

Options:

1	`--help Show this message and exit.`

fides scan system aws

Scan an AWS account and compare objects with annotated Fides Systems.

_Scannable resources: [Redshift, RDS, DynamoDb, S3]_

Usage:

1	`fides scan system aws [OPTIONS] [MANIFESTS_DIR]`

Options:

  --credentials-id TEXT           Use credentials keys defined within Fides
                                  config.
  --access_key_id TEXT            Connect to AWS using an `Access Key ID`.
                                  _Requires options `--access_key_id`,
                                  `--secret_access_key` & `--region`._
  --secret_access_key TEXT        Connect to AWS using an `Access Key`.
                                  _Requires options `--access_key_id`,
                                  `--secret_access_key` & `--region`._
  --region TEXT                   Connect to AWS using a specific `Region`.
                                  _Requires options `--access_key_id`,
                                  `--secret_access_key` & `--region`._
  -k, --org-key TEXT              The `organization_fides_key` of the
                                  `Organization` you want to specify.
                                  [default: default_organization]
  -c, --coverage-threshold INTEGER RANGE
                                  Set the coverage percentage for a passing
                                  scan.  [0<=x<=100]
  --help                          Show this message and exit.

fides scan system okta

1	`Scan an Okta account and compare applications with annotated Fides Systems.`

Usage:

1	`fides scan system okta [OPTIONS] [MANIFESTS_DIR]`

Options:

  --credentials-id TEXT           Use credentials keys defined within Fides
                                  config.
  --org-url TEXT                  Connect to Okta using an 'Org URL'.
                                  _Requires options `--org-url` & `--token`._
  --token TEXT                    Connect to Okta using a token. _Requires
                                  options `--org-url` and `--token`._
  -k, --org-key TEXT              The `organization_fides_key` of the
                                  `Organization` you want to specify.
                                  [default: default_organization]
  -c, --coverage-threshold INTEGER RANGE
                                  Set the coverage percentage for a passing
                                  scan.  [0<=x<=100]
  --help                          Show this message and exit.

fides status

1	`Check Fides server availability.`

Usage:

1	`fides status [OPTIONS]`

Options:

1	`--help Show this message and exit.`

fides user

1	`Click command group for interacting with user-related functionality.`

Usage:

1	`fides user [OPTIONS] COMMAND [ARGS]...`

Options:

1	`--help Show this message and exit.`

fides user create

Use the credentials file to create a new user. Gives full permissions to the new user.

Usage:

1	`fides user create [OPTIONS] USERNAME PASSWORD`

Options:

  -f, --first-name TEXT
  -l, --last-name TEXT
  --help                 Show this message and exit.

Authenticate with the webserver and generate a user access token.
Then store those credentials in a credentials file.

Usage:

1	`fides user login [OPTIONS]`

Options:

  -u, --username TEXT  If not provided, will be pulled from the config file or
                       prompted for.
  -p, --password TEXT  If not provided, will be pulled from the config file or
                       prompted for.
  --help               Show this message and exit.

fides user permissions

1	`List the directly-assigned scopes and roles available to the current user.`

Usage:

1	`fides user permissions [OPTIONS]`

Options:

1	`--help Show this message and exit.`

fides view

1	`View various resources types.`

Usage:

1	`fides view [OPTIONS] COMMAND [ARGS]...`

Options:

1	`--help Show this message and exit.`

fides view config

Prints the configuration values being used for this command-line instance.

_Note: To see the configuration values being used by the webserver, `GET` the `/api/v1/config` endpoint._

Usage:

1	`fides view config [OPTIONS] [SECTION]`

Options:

  --exclude-unset  Only print configuration values explicitly set by the user.
  --help           Show this message and exit.

fides view credentials

1	`Prints the credentials file.`

Usage:

1	`fides view credentials [OPTIONS]`

Options:

1	`--help Show this message and exit.`

fides webserver

Start the Fides webserver.

_Requires Redis and Postgres to be configured and running_

Usage:

1	`fides webserver [OPTIONS]`

Options:

  -p, --port INTEGER
  --help              Show this message and exit.

fides worker

1	`Start a Celery worker for the Fides webserver.`

Usage:

1	`fides worker [OPTIONS]`

Options:

1	`--help Show this message and exit.`

CLI

fides

fides annotate

fides annotate dataset

fides db

fides db init

fides db reset

fides db upgrade

fides delete

fides deploy

fides deploy down

fides deploy up

fides evaluate

fides generate

fides generate dataset

fides generate dataset aws

fides generate dataset aws dynamodb

fides generate dataset db

fides generate dataset gcp

fides generate dataset gcp bigquery

fides generate system

fides generate system aws

fides generate system okta

fides get

fides init

fides ls

fides parse

fides pull

fides push

fides scan

fides scan dataset

fides scan dataset db

fides scan system

fides scan system aws

fides scan system okta

fides status

fides user

fides user create

fides user login

fides user permissions

fides view

fides view config

fides view credentials

fides webserver

fides worker