Command Line Reference¶
cryptoshred¶
cryptoshred [OPTIONS] COMMAND [ARGS]...
Options
-
-v,--verbose¶ Output more details on what is happening. Use multiple times for more details.
- Default
False
-
-p,--profile<profile>¶ The profile to use for the command that is about to run.
- Default
default
-
--install-completion<install_completion>¶ Install completion for the specified shell.
- Options
bash | zsh | fish | powershell | pwsh
-
--show-completion<show_completion>¶ Show completion for the specified shell, to copy it or customize the installation.
- Options
bash | zsh | fish | powershell | pwsh
decrypt¶
cryptoshred decrypt [OPTIONS] COMMAND [ARGS]...
container¶
Takes a cryptocontainer as string and will decrypt it.
cryptoshred decrypt container [OPTIONS] INPUT
Arguments
-
INPUT¶ Required argument
file¶
Will take a file containing a list of valid json objects and replace any cryptocontainer it can find within that list with the value of that container. Be aware that this can take quite some time for long fact streams or deeply nested structures as the decryptor has to check every entry in the structure.
cryptoshred decrypt file [OPTIONS] PATH
Arguments
-
PATH¶ Required argument
encrypt¶
cryptoshred encrypt [OPTIONS] COMMAND [ARGS]...
value¶
Takes a value and returns the cryptocontainer representing that value. If you provide a subject id it will use the key for that subject id if it exists or error out otherwise. If you do not provide an ID a new one will be created.
cryptoshred encrypt value [OPTIONS] VALUE
Options
-
--sid<sid>¶ The id of the subject to use for encryption.
Arguments
-
VALUE¶ Required argument
map¶
cryptoshred map [OPTIONS] COMMAND [ARGS]...
list¶
This function generates a mapping between subject IDs ans the PII found
in a given list of crytpocontainers for that PII. This is usefull if for example
you need to find the sid given the PII in a deletion request.
It will return a json object. See Mapping FAQ for
more info.
cryptoshred map list [OPTIONS] INPUT
Options
-
--out<out>¶ The output file. Defaults to stdout.
Arguments
-
INPUT¶ Required argument