@grizzlycbg/griz-cli
v0.0.3
Published
Command line interface for the Grizzly platform
Readme
@grizzlycbg/griz-cli
Command line interface for the Grizzly platform
Usage
$ npm install -g @grizzlycbg/griz-cli
$ griz COMMAND
running command...
$ griz (--version)
@grizzlycbg/griz-cli/0.0.3 linux-x64 node-v24.11.0
$ griz --help [COMMAND]
USAGE
$ griz COMMAND
...Commands
griz BaseCommandgriz creategriz create account UIDgriz create apikey ACCOUNTgriz create configgriz create keyring RINGgriz create profile NAMEgriz decrypt [TEXT]griz encrypt [TEXT]griz help [COMMAND]griz initgriz inspectgriz inspect file FILEgriz listgriz list accountgriz list activitygriz list keyringgriz list profilegriz profilegriz rotategriz showgriz show account UIDgriz show activity IDgriz show apikey KEYIDgriz show keyring [RING]griz show profile [NAME]
griz BaseCommand
USAGE
$ griz BaseCommandSee code: src/commands/BaseCommand.ts
griz create
Create resources
USAGE
$ griz create
DESCRIPTION
Create resourcesSee code: src/commands/create/index.ts
griz create account UID
Creates an Account
USAGE
$ griz create account UID [-c <value>] [--notes <value>]
ARGUMENTS
UID The Account UID
FLAGS
-c, --config=<value> The config file to use
--notes=<value> Create an Account
DESCRIPTION
Creates an Account
EXAMPLES
$ griz create account [account-name]
FLAG DESCRIPTIONS
--notes=<value> Create an Account
Additional notes on the AccountSee code: src/commands/create/account.ts
griz create apikey ACCOUNT
Creates an API Key
USAGE
$ griz create apikey ACCOUNT [-c <value>] [-f <value>...] [--file <value>]
ARGUMENTS
ACCOUNT The Account UID associated with this API Key
FLAGS
-c, --config=<value> The config file to use
-f, --flag=<value>... API Key flags
--file=<value> File path to a file containing the flags. Each line should only contain the flag name.
DESCRIPTION
Creates an API Key
EXAMPLES
$ griz create apikey [keyring]
FLAG DESCRIPTIONS
-f, --flag=<value>... API Key flags
An entitlement on an API KeySee code: src/commands/create/apikey.ts
griz create config
Setup an environment for the first time
USAGE
$ griz create config [--file <value> | -n <value>]
FLAGS
-n, --name=<value> AName of the config file
--file=<value> File path to a file containing the flags. Each line should only contain the flag name.
DESCRIPTION
Setup an environment for the first time
EXAMPLES
$ griz create config config
FLAG DESCRIPTIONS
-n, --name=<value> AName of the config file
The name of the config file saved in the default locationSee code: src/commands/create/config.ts
griz create keyring RING
Creates a KeyRing
USAGE
$ griz create keyring RING [-c <value>] [--createKeyPair <value>] [--publicKey <value>] [--privateKeyOut <value>]
ARGUMENTS
RING The KeyRing
FLAGS
-c, --config=<value> The config file to use
--createKeyPair=<value> Create KeyPair and export the Private Key
--privateKeyOut=<value> Path to the file where the Private Key will be exported
--publicKey=<value> Path to the Public Key file
DESCRIPTION
Creates a KeyRing
EXAMPLES
$ griz create keyring [keyring]
FLAG DESCRIPTIONS
--createKeyPair=<value> Create KeyPair and export the Private Key
If provided will create an RSA Key Pair, and export the Private Key.See code: src/commands/create/keyring.ts
griz create profile NAME
Creates a Profile
USAGE
$ griz create profile NAME -k <value> -a <value> [-c <value>]
ARGUMENTS
NAME The Profile name
FLAGS
-a, --apikey=<value> (required) The API Key to use
-c, --config=<value> The config file to use
-k, --keyring=<value> (required) The KeyRing to use
DESCRIPTION
Creates a Profile
EXAMPLES
$ griz create profile devopsSee code: src/commands/create/profile.ts
griz decrypt [TEXT]
Decrypts data
USAGE
$ griz decrypt [TEXT] [-c <value>] [-f <value>... | -d <value>] [-r] [-o <value>] [-o <value>]
[--overwrite] [--deleteSource] [--no-updates]
ARGUMENTS
TEXT Text to decrypt
FLAGS
-c, --config=<value> The config file to use
-d, --dir=<value> Directory to decrypt
-f, --file=<value>... File to decrypt
-o, --outDir=<value> The directory to export decrypted files to. Recursive files will preserve their relative paths.
-o, --outFile=<value> The File path to export encrypted files to. Recursive files will preserve their relative paths.
-r, --recursive If set, will decrypt∂ all subdirectories too
--deleteSource If set, will delete the encrypted source files after successful decryption
--no-updates If set, will not display live updates
--overwrite If set, will overwrite target files that already exist
DESCRIPTION
Decrypts data
EXAMPLES
$ griz decrypt <base64-encrypted-text>
$ griz decrypt <base64-encrypted-text> --ring finance
$ griz decrypt --file /path/to/file.txt.grenc --file /path/to/other.txt.grenc
$ griz decrypt --dir /path/to/dir --recursive --out-dir --overwrite --out-dir /outSee code: src/commands/decrypt/index.ts
griz encrypt [TEXT]
Encrypt data
USAGE
$ griz encrypt [TEXT] [-c <value>] [-k <value>] [--noAssetTag] [-f <value>... | -d <value>] [-r] [-o
<value>] [-o <value>] [--overwrite] [--cleanup] [--deleteSource] [--no-updates]
ARGUMENTS
TEXT String to encrypt
FLAGS
-c, --config=<value> The config file to use
-d, --dir=<value> Directory to encrypt
-f, --file=<value>... File to encrypt
-k, --keyring=<value> The KeyRing to use
-o, --out-file=<value> The file path to export encrypted files to. Recursive files will preserve their relative
paths.
-o, --outDir=<value> The directory to export encrypted files to. Recursive files will preserve their relative
paths.
-r, --recursive If set, will encrypt all subdirectories too
--cleanup If provided, it will cleanup a failed encryption process by removing all of the encrypted
files. This is useful when encrypting directories.
--deleteSource If set, will delete the original source files after successful encryption
--no-updates If set, will not display live updates
--noAssetTag If set, will not tag the encrypted Asset
--overwrite If set, will overwrite target files that already exist
DESCRIPTION
Encrypt data
EXAMPLES
$ griz encrypt "Some text to encrypt"
$ griz encrypt "Some text to encrypt" --keyring finance
$ griz encrypt --file /path/to/file.txt --file /path/to/other/file.txt
$ griz encrypt --dir /path/to/dir --recursive --out-dir --overwriteSee code: src/commands/encrypt/index.ts
griz help [COMMAND]
Display help for griz.
USAGE
$ griz help [COMMAND...] [-n]
ARGUMENTS
COMMAND... Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for griz.See code: @oclif/plugin-help
griz init
Setup an environment for the first time
USAGE
$ griz init
DESCRIPTION
Setup an environment for the first time
EXAMPLES
$ griz init initSee code: src/commands/init/index.ts
griz inspect
Inspect encrypted files
USAGE
$ griz inspect
DESCRIPTION
Inspect encrypted filesSee code: src/commands/inspect/index.ts
griz inspect file FILE
Displays the details of an API Key
USAGE
$ griz inspect file FILE [-c <value>] [--file <value>...]
ARGUMENTS
FILE The file to inspect
FLAGS
-c, --config=<value> The config file to use
--file=<value>... The file to inspect
DESCRIPTION
Displays the details of an API Key
EXAMPLES
$ griz inspect file file /path/to/file.grencSee code: src/commands/inspect/file.ts
griz list
List resources
USAGE
$ griz list
DESCRIPTION
List resourcesSee code: src/commands/list/index.ts
griz list account
Lists all Accounts
USAGE
$ griz list account [-c <value>]
FLAGS
-c, --config=<value> The config file to use
DESCRIPTION
Lists all Accounts
EXAMPLES
$ griz list accountSee code: src/commands/list/account.ts
griz list activity
Lists Activities
USAGE
$ griz list activity [-c <value>] [--accountuid <value>] [--end <value>] [--keyid <value>] [--limit <value>]
[--start <value>]
FLAGS
-c, --config=<value> The config file to use
--accountuid=<value> The Account UID filter
--end=<value> The end timestamp
--keyid=<value> The Key ID filter
--limit=<value> The max number of items
--start=<value> The start timestamp
DESCRIPTION
Lists Activities
EXAMPLES
$ griz list activity
FLAG DESCRIPTIONS
--accountuid=<value> The Account UID filter
The Account UID to filter on
--end=<value> The end timestamp
The end timestamp
--keyid=<value> The Key ID filter
The Key ID to filter on
--limit=<value> The max number of items
The max number of items to return
--start=<value> The start timestamp
The start timestampSee code: src/commands/list/activity.ts
griz list keyring
Lists all KeyRings
USAGE
$ griz list keyring [-c <value>]
FLAGS
-c, --config=<value> The config file to use
DESCRIPTION
Lists all KeyRings
EXAMPLES
$ griz list keyringSee code: src/commands/list/keyring.ts
griz list profile
Lists the Profiles available
USAGE
$ griz list profile [-c <value>]
FLAGS
-c, --config=<value> The config file to use
DESCRIPTION
Lists the Profiles available
EXAMPLES
$ griz list profile legalSee code: src/commands/list/profile.ts
griz profile
Lists the Profiles available
USAGE
$ griz profile [-c <value>] [--select <value> | --show <value> | --list | --delete <value> | [--create
<value> -k <value> -a <value>]]
FLAGS
-a, --apikey=<value> The API Key to use
-c, --config=<value> The config file to use
-k, --keyring=<value> The KeyRing to use
--create=<value> The new Profile name
--delete=<value> Deletes the specified Profile
--list List all available Profiles
--select=<value> The Profile to switch to
--show=<value> Display the specified profile details
DESCRIPTION
Lists the Profiles available
EXAMPLES
$ griz profile legalSee code: src/commands/profile.ts
griz rotate
Rotates the active Key on a KeyRing
USAGE
$ griz rotate [-k <value>]
FLAGS
-k, --keyring=<value> The KeyRing to use
DESCRIPTION
Rotates the active Key on a KeyRing
EXAMPLES
$ griz rotate legalSee code: src/commands/rotate/index.ts
griz show
Show resources
USAGE
$ griz show
DESCRIPTION
Show resourcesSee code: src/commands/show/index.ts
griz show account UID
Displays an Account
USAGE
$ griz show account UID [-c <value>] [--id]
ARGUMENTS
UID The Account UID
FLAGS
-c, --config=<value> The config file to use
--id If provided, treat the UID as the Account ID
DESCRIPTION
Displays an Account
EXAMPLES
$ griz show account account-nameSee code: src/commands/show/account.ts
griz show activity ID
Displays an Account
USAGE
$ griz show activity ID [-c <value>]
ARGUMENTS
ID The Activity ID
FLAGS
-c, --config=<value> The config file to use
DESCRIPTION
Displays an Account
EXAMPLES
$ griz show activity activity-idSee code: src/commands/show/activity.ts
griz show apikey KEYID
Displays the details of an API Key
USAGE
$ griz show apikey KEYID [-c <value>]
ARGUMENTS
KEYID The API Key ID
FLAGS
-c, --config=<value> The config file to use
DESCRIPTION
Displays the details of an API Key
EXAMPLES
$ griz show apikey [keyring]See code: src/commands/show/apikey.ts
griz show keyring [RING]
Displays a KeyRing
USAGE
$ griz show keyring [RING] [-c <value>]
ARGUMENTS
RING The KeyRing
FLAGS
-c, --config=<value> The config file to use
DESCRIPTION
Displays a KeyRing
EXAMPLES
$ griz show keyring [keyring]See code: src/commands/show/keyring.ts
griz show profile [NAME]
Lists the Profiles available
USAGE
$ griz show profile [NAME] [-c <value>]
ARGUMENTS
NAME The Profile name
FLAGS
-c, --config=<value> The config file to use
DESCRIPTION
Lists the Profiles available
EXAMPLES
$ griz show profile legalSee code: src/commands/show/profile.ts
