Skip to content

CLI

These docs reflect the latest PyPI release.

fidescls

1
2
The Fidescls command line interface to interact
with the PII classification functionality

Usage:

1
fidescls [OPTIONS] COMMAND [ARGS]...

Options:

1
2
  --version  Show the version and exit.
  --help     Show this message and exit.

fidescls api

1
A CLI command group for server functionality.

Usage:

1
fidescls api [OPTIONS] COMMAND [ARGS]...

Options:

1
  --help  Show this message and exit.

fidescls api start

1
Start the fidescls api server

Usage:

1
fidescls api start [OPTIONS]

Options:

1
2
3
  -h, --host TEXT     host to run the api on
  -p, --port INTEGER  port number the api will use
  --help              Show this message and exit.

fidescls classify

1
A CLI command group focused on PII classification methods

Usage:

1
fidescls classify [OPTIONS] COMMAND [ARGS]...

Options:

1
  --help  Show this message and exit.

fidescls classify content

1
2
3
Detect and classify PII content

DATA: data string to be processed (comma separated)

Usage:

1
fidescls classify content [OPTIONS] DATA

Options:

1
2
3
4
  -l, --language TEXT         Text language for NLP processing
  -m, --model TEXT            ML model to use
  -d, --decision-method TEXT  Decision method [pass-through | direct-mapping]
  --help                      Show this message and exit.

fidescls classify context

1
2
3
4
PII context classification

DATA: data string to be processed (comma separated)
POSSIBLE_TARGETS: list of strings

Usage:

1
fidescls classify context [OPTIONS] POSSIBLE_TARGETS DATA

Options:

1
2
3
4
5
6
  -n, --top-n INTEGER RANGE  Number of results to return from the PII
                             classification process  [x>=1]
  -s, --remove-stop-words    Flag to remove stop words when processing
  -t, --pii-threshold TEXT   Minimum threshold for context pii classification.
                             No threshold by default
  --help                     Show this message and exit.

fidescls convert

1
A CLI command group focused on converting classification files

Usage:

1
fidescls convert [OPTIONS] COMMAND [ARGS]...

Options:

1
  --help  Show this message and exit.

fidescls convert cls2dataset

1
Convert a classification output json file to a Fides Dataset file

Usage:

1
fidescls convert cls2dataset [OPTIONS] CLASSIFICATION_FILE_NAME

Options:

1
2
3
4
5
  -o, --outfile TEXT      filename to save database classification output json
  -e, --exclude-none      Exclude null objects from classification output
  -u, --force-unique-key  Force Fides Dataset keys to be unique via appending
                          a uuid
  --help                  Show this message and exit.

fidescls scan

1
A CLI command group focused on scanning infrastructure for classification

Usage:

1
fidescls scan [OPTIONS] COMMAND [ARGS]...

Options:

1
  --help  Show this message and exit.

fidescls scan bigquery

1
Connects to and scans BigQuery infrastructure, returning proposed classifications

Usage:

1
fidescls scan bigquery [OPTIONS] DATASET_NAME [CONNECTION_KEYFILE_PATH]

Options:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
  --context                       Flag to use context classification
  --content                       Flag to use content classification
  -a, --aggregate                 Flag to use classification output
                                  aggregation
  -aa, --aggregation-method TEXT  Aggregation method to use for content and
                                  context classification output aggregation
                                  (default: weighted)
  -s, --samples INTEGER RANGE     Number of samples to use for content
                                  classification  [x>=1]
  -o, --outfile TEXT              filename to save database classification
                                  output json
  -q, --quiet BOOLEAN             Disable progress bars and feedback
  -y, --dataset-yaml              Output formatted as a Fides Dataset yaml
                                  file.
  -e, --exclude-none              Exclude null objects from classification
                                  output
  -v, --verbose BOOLEAN           The full output is returned instead of the
                                  default condensed.
  -u, --force-unique-key          Force Fides Dataset keys to be unique via
                                  appending a uuid
  -n, --top-n INTEGER RANGE       Number of results to return (aggregation
                                  only)  [x>=1]
  --help                          Show this message and exit.

fidescls scan db

1
Classify PII in each column of each table of a database

Usage:

1
fidescls scan db [OPTIONS] CONNECTION_STRING

Options:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
  -s, --samples INTEGER RANGE     Number of samples to use for content
                                  classification  [x>=1]
  --context                       Flag to use context classification
  --content                       Flag to use content classification
  -a, --aggregate                 Flag to use classification output
                                  aggregation
  -aa, --aggregation-method TEXT  Aggregation method to use for content and
                                  context classification output aggregation
                                  (default: weighted)
  -o, --outfile TEXT              filename to save database classification
                                  output json
  -q, --quiet BOOLEAN             Disable progress bars and feedback
  -t, --threads INTEGER RANGE     Number of threads to use for classification
                                  [x>=1]
  -v, --verbose BOOLEAN           The full output is returned instead of the
                                  default condensed.
  -y, --dataset-yaml              Output formatted as a Fides Dataset yaml
                                  file.
  -e, --exclude-none              Exclude null objects from classification
                                  output
  -u, --force-unique-key          Force Fides Dataset keys to be unique via
                                  appending a uuid
  -n, --top-n INTEGER RANGE       Number of results to return (aggregation
                                  only)  [x>=1]
  --help                          Show this message and exit.

fidescls scan snowflake

1
Connects to and scans BigQuery infrastructure, returning proposed classifications

Usage:

1
fidescls scan snowflake [OPTIONS] CONNECTION_STRING

Options:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
  -s, --samples INTEGER RANGE     Number of samples to use for content
                                  classification  [x>=1]
  --context                       Flag to use context classification
  --content                       Flag to use content classification
  -a, --aggregate                 Flag to use classification output
                                  aggregation
  -aa, --aggregation-method TEXT  Aggregation method to use for content and
                                  context classification output aggregation
                                  (default: weighted)
  -o, --outfile TEXT              filename to save database classification
                                  output json
  -q, --quiet BOOLEAN             Disable progress bars and feedback
  -t, --threads INTEGER RANGE     Number of threads to use for classification
                                  [x>=1]
  -v, --verbose BOOLEAN           The full output is returned instead of the
                                  default condensed.
  -y, --dataset-yaml              Output formatted as a Fides Dataset yaml
                                  file.
  -e, --exclude-none              Exclude null objects from classification
                                  output
  -db, --database TEXT            Optionally specify a single database
  -v, --verbose BOOLEAN           The full output is returned instead of the
                                  default condensed.
  --help                          Show this message and exit.
Back to top