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	`[1mfides[0m [[1;92mOPTIONS[0m] [1;92mCOMMAND[0m [[1;92mARGS[0m]...`

fides annotate

Interactively annotate Fides resources.

Usage:

1	`[1mfides annotate[0m [[1;92mOPTIONS[0m] [1;92mCOMMAND[0m [[1;92mARGS[0m]...`

fides annotate dataset

Interactively annotate a dataset file in-place.

Usage:

1	`[1mfides annotate dataset[0m [[1;92mOPTIONS[0m] [1;92mINPUT_FILENAME[0m`

fides db

Run actions against the application database.

Usage:

1	`[1mfides db[0m [[1;92mOPTIONS[0m] [1;92mCOMMAND[0m [[1;92mARGS[0m]...`

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	`[1mfides db init[0m [[1;92mOPTIONS[0m]`

fides db reset

Reset the database back to its initial state.

Usage:

1	`[1mfides db reset[0m [[1;92mOPTIONS[0m]`

fides db upgrade

Runs all upgrade migrations for the Fides database.

Will also automatically initialize a fresh database.

Usage:

1	`[1mfides db upgrade[0m [[1;92mOPTIONS[0m]`

fides delete

Delete an object from the server.

Usage:

[33m                                                                              [0m 
 [1mfides delete                                                                  [0m 
 [[1;92mOPTIONS[0m]                                                                      
 {[1;92mdata_category[0m|[1;92mdata_subject[0m|[1;92mdata_use[0m|[1;92mdataset[0m|[1;92morganization[0m|[1;92mpolicy[0m|[1;92msystem[0m|[1;92mevalu…[0m 
 [1;92mFIDES_KEY[0m

fides deploy

Deploy a sample project locally to try out Fides.

Usage:

1	`[1mfides deploy[0m [[1;92mOPTIONS[0m] [1;92mCOMMAND[0m [[1;92mARGS[0m]...`

fides deploy down

Stops the sample project and removes all volumes.

Usage:

1	`[1mfides deploy down[0m [[1;92mOPTIONS[0m]`

fides deploy up

Starts a sample project via docker compose.

Usage:

1	`[1mfides deploy up[0m [[1;92mOPTIONS[0m]`

fides evaluate

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

Usage:

1	`[1mfides evaluate[0m [[1;92mOPTIONS[0m] [[1;92mMANIFESTS_DIR[0m]`

fides generate

Programmatically generate Fides objects.

Usage:

1	`[1mfides generate[0m [[1;92mOPTIONS[0m] [1;92mCOMMAND[0m [[1;92mARGS[0m]...`

fides generate dataset

Generate Fides datasets.

Usage:

[1mfides generate dataset[0m [[1;92mOPTIONS[0m] [1;92mCOMMAND[0m [[1;92mARGS[0m]...

fides generate dataset aws

Generate Fides datasets from specific Amazon Web Services.

Usage:

[1mfides generate dataset aws[0m [[1;92mOPTIONS[0m] [1;92mCOMMAND[0m [[1;92mARGS[0m]...

fides generate dataset aws dynamodb

Generates a dataset object from DynamoDB using the AWS boto3 connection config.

Usage:

[1mfides generate dataset aws dynamodb[0m [[1;92mOPTIONS[0m] [1;92mOUTPUT_FILENAME[0m

fides generate dataset db

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

Usage:

1	`[1mfides generate dataset db[0m [[1;92mOPTIONS[0m] [1;92mOUTPUT_FILENAME[0m`

fides generate dataset gcp

Generate Fides datasets from Google Cloud Platform.

Usage:

[1mfides generate dataset gcp[0m [[1;92mOPTIONS[0m] [1;92mCOMMAND[0m [[1;92mARGS[0m]...

fides generate dataset gcp bigquery

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

Usage:

[1mfides generate dataset gcp bigquery[0m [[1;92mOPTIONS[0m] [1;92mDATASET_NAME[0m [1;92mOUTPUT_FILENAME[0m

fides generate system

Generate Fides systems.

Usage:

[1mfides generate system[0m [[1;92mOPTIONS[0m] [1;92mCOMMAND[0m [[1;92mARGS[0m]...

fides generate system aws

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

Usage:

1	`[1mfides generate system aws[0m [[1;92mOPTIONS[0m] [1;92mOUTPUT_FILENAME[0m`

fides generate system okta

Generates systems from your Okta applications. Connects via OAuth2 client credentials.

Usage:

1	`[1mfides generate system okta[0m [[1;92mOPTIONS[0m] [1;92mOUTPUT_FILENAME[0m`

fides get

View an object from the server.

Usage:

[33m                                                                              [0m 
 [1mfides get                                                                     [0m 
 [[1;92mOPTIONS[0m]                                                                      
 {[1;92mdata_category[0m|[1;92mdata_subject[0m|[1;92mdata_use[0m|[1;92mdataset[0m|[1;92morganization[0m|[1;92mpolicy[0m|[1;92msystem[0m|[1;92mevalu…[0m 
 [1;92mFIDES_KEY[0m

fides init

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

Usage:

1	`[1mfides init[0m [[1;92mOPTIONS[0m] [[1;92mFIDES_DIR[0m]`

fides ls

View all objects of a single type from the server.

Usage:

[33m                                                                              [0m 
 [1mfides ls                                                                      [0m 
 [[1;92mOPTIONS[0m]                                                                      
 {[1;92mdata_category[0m|[1;92mdata_subject[0m|[1;92mdata_use[0m|[1;92mdataset[0m|[1;92morganization[0m|[1;92mpolicy[0m|[1;92msystem[0m|[1;92mevalu…[0m

fides parse

Parse all Fides objects located in the supplied directory.

Usage:

1	`[1mfides parse[0m [[1;92mOPTIONS[0m] [[1;92mMANIFESTS_DIR[0m]`

fides pull

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

Usage:

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

Options:

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

fides pull all

Retrieve all resources from the server and update the local manifest files.

Usage:

1	`fides pull all [OPTIONS] [MANIFESTS_DIR]`

Options:

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

fides pull data_category

Retrieve a specific data_category from the server and update the local manifest files.

Usage:

1	`fides pull data_category [OPTIONS] FIDES_KEY [MANIFESTS_DIR]`

Options:

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

fides pull data_subject

Retrieve a specific data_subject from the server and update the local manifest files.

Usage:

1	`fides pull data_subject [OPTIONS] FIDES_KEY [MANIFESTS_DIR]`

Options:

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

fides pull data_use

Retrieve a specific data_use from the server and update the local manifest files.

Usage:

1	`fides pull data_use [OPTIONS] FIDES_KEY [MANIFESTS_DIR]`

Options:

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

fides pull dataset

Retrieve datasets from the server and update the local manifest files.

If FIDES_KEY is provided, only that dataset will be pulled. If --all-resources is specified, all datasets will be pulled. If --separate-files is specified, each dataset will be written to a separate file.

Usage:

1	`fides pull dataset [OPTIONS] [FIDES_KEY] [MANIFESTS_DIR]`

Options:

  -a, --all-resources  Pull all datasets from the server.
  --separate-files     Write each dataset to a separate file named after its
                       fides_key.
  -h, --help           Show this message and exit.

fides pull system

Retrieve a specific system from the server and update the local manifest files.

Usage:

1	`fides pull system [OPTIONS] FIDES_KEY [MANIFESTS_DIR]`

Options:

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

fides push

Parse local manifest files and upload them to the server.

Usage:

1	`[1mfides push[0m [[1;92mOPTIONS[0m] [[1;92mMANIFESTS_DIR[0m]`

fides scan

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

Usage:

1	`[1mfides scan[0m [[1;92mOPTIONS[0m] [1;92mCOMMAND[0m [[1;92mARGS[0m]...`

fides scan dataset

Scan and report on Fides Dataset resources.

Usage:

[1mfides scan dataset[0m [[1;92mOPTIONS[0m] [1;92mCOMMAND[0m [[1;92mARGS[0m]...

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	`[1mfides scan dataset db[0m [[1;92mOPTIONS[0m] [[1;92mMANIFESTS_DIR[0m]`

fides scan system

Scan and report on Fides System resources.

Usage:

[1mfides scan system[0m [[1;92mOPTIONS[0m] [1;92mCOMMAND[0m [[1;92mARGS[0m]...

fides scan system aws

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

Scannable resources: [Redshift, RDS, DynamoDb, S3]

Usage:

1	`[1mfides scan system aws[0m [[1;92mOPTIONS[0m] [[1;92mMANIFESTS_DIR[0m]`

fides scan system okta

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

Usage:

1	`[1mfides scan system okta[0m [[1;92mOPTIONS[0m] [[1;92mMANIFESTS_DIR[0m]`

fides status

Check Fides server availability.

Usage:

1	`[1mfides status[0m [[1;92mOPTIONS[0m]`

fides user

Click command group for interacting with user-related functionality.

Usage:

1	`[1mfides user[0m [[1;92mOPTIONS[0m] [1;92mCOMMAND[0m [[1;92mARGS[0m]...`

fides user create

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

Usage:

[1mfides user create[0m [[1;92mOPTIONS[0m] [1;92mUSERNAME[0m [1;92mPASSWORD[0m [1;92mEMAIL_ADDRESS[0m

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

Usage:

1	`[1mfides user login[0m [[1;92mOPTIONS[0m]`

fides user permissions

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

Usage:

1	`[1mfides user permissions[0m [[1;92mOPTIONS[0m]`

fides view

View various resources types.

Usage:

1	`[1mfides view[0m [[1;92mOPTIONS[0m] [1;92mCOMMAND[0m [[1;92mARGS[0m]...`

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	`[1mfides view config[0m [[1;92mOPTIONS[0m] [[1;92mSECTION[0m]`

fides view credentials

Prints the credentials file.

Usage:

1	`[1mfides view credentials[0m [[1;92mOPTIONS[0m]`

fides webserver

Start the Fides webserver.

Requires Redis and Postgres to be configured and running

Usage:

1	`[1mfides webserver[0m [[1;92mOPTIONS[0m]`

fides worker

Start a Celery worker for the Fides webserver.

Usage:

1	`[1mfides worker[0m [[1;92mOPTIONS[0m]`

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 pull all

fides pull data_category

fides pull data_subject

fides pull data_use

fides pull dataset

fides pull system

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