These are autogenerated CLI docs that reflect the latest PyPI release.
fides
12345
__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:
123456
--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:
1234
-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
12345
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:
12
-y, --yes Automatically responds `yes` to any prompts.
--help Show this message and exit.
fides db upgrade
123
Runs all upgrade migrations for the Fides database.
Will also automatically initialize a fresh database.
--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
1
Evaluate System-level Privacy Declarations against Organization-level Policy Rules.
Usage:
1
fides evaluate [OPTIONS] [MANIFESTS_DIR]
Options:
1234567
-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.
--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`._
--session_token TEXT Connect to AWS using a temporary `Access Key`.
_Requires options `--access_key_id`,
`--secret_access_key`, `--session_token`, &
`--region`._
--region TEXT Connect to AWS using a specific `Region`.
_Requires options `--access_key_id`,
`--secret_access_key` & `--region`._
--single-dataset BOOLEAN
--include-null Include null attributes.
--help Show this message and exit.
fides generate dataset db
1
Generate a Fides dataset by walking a database and recording every schema/table/field.
Usage:
1
fides generate dataset db [OPTIONS] OUTPUT_FILENAME
Options:
12345
--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.
--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
12
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:
1 2 3 4 5 6 7 8 910111213141516171819
--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`._
--session_token TEXT Connect to AWS using a temporary `Access Key`.
_Requires options `--access_key_id`,
`--secret_access_key`, `--session_token`, &
`--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
12
Generates systems from your Okta applications. Connects via
an Okta admin account.
Usage:
1
fides generate system okta [OPTIONS] OUTPUT_FILENAME
Options:
123456789
--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:
12
fides get [OPTIONS] {data_category|data_subject|data_use|dataset|organization|
policy|system|evaluation} FIDES_KEY
Options:
1
--help Show this message and exit.
fides init
12
Initializes a Fides instance by creating the default directory and
configuration file if not present.
Usage:
1
fides init [OPTIONS] [FIDES_DIR]
Options:
12
--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:
12
fides ls [OPTIONS] {data_category|data_subject|data_use|dataset|organization|p
olicy|system|evaluation}
Options:
12
-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:
12
-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] COMMAND [ARGS]...
Options:
1
--help Show this message and exit.
fides pull all
1
Retrieve all resources from the server and update the local manifest files.
Usage:
1
fides pull all [OPTIONS] [MANIFESTS_DIR]
Options:
123
-a, --all-resources TEXT Pulls all locally missing resources from the
server into this file.
--help Show this message and exit.
fides pull data_category
1
Retrieve a specific data_category from the server and update the local manifest files.
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
--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:
123
--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
1
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
1234
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:
12345678
--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
123
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:
1 2 3 4 5 6 7 8 910111213141516171819202122
--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`._
--session_token TEXT Connect to AWS using a temporary `Access
Key`. _Requires options `--access_key_id`,
`--secret_access_key`, `--session_token`, &
`--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:
1 2 3 4 5 6 7 8 910111213
--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
1
Use the credentials file to create a new user. Gives full permissions to the new user.
Usage:
1
fides user create [OPTIONS] USERNAME PASSWORD EMAIL_ADDRESS
Options:
123
-f, --first-name TEXT
-l, --last-name TEXT
--help Show this message and exit.
fides user login
12
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:
12345
-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
123
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:
12
--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
123
Start the Fides webserver.
_Requires Redis and Postgres to be configured and running_
Usage:
1
fides webserver [OPTIONS]
Options:
12
-p, --port INTEGER
--help Show this message and exit.