npm package: @grizzlycbg/griz-cli
Description: Command line interface for the Grizzly platform
Author: Cyber Bear Group
Latest version: 0.0.3

@grizzlycbg/griz-cli
=================

Command line interface for the Grizzly platform


[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/@grizzlycbg/griz-cli.svg)](https://npmjs.org/package/@grizzlycbg/griz-cli)
[![Downloads/week](https://img.shields.io/npm/dw/@grizzlycbg/griz-cli.svg)](https://npmjs.org/package/@grizzlycbg/griz-cli)


<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ 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
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`griz BaseCommand`](#griz-basecommand)
* [`griz create`](#griz-create)
* [`griz create account UID`](#griz-create-account-uid)
* [`griz create apikey ACCOUNT`](#griz-create-apikey-account)
* [`griz create config`](#griz-create-config)
* [`griz create keyring RING`](#griz-create-keyring-ring)
* [`griz create profile NAME`](#griz-create-profile-name)
* [`griz decrypt [TEXT]`](#griz-decrypt-text)
* [`griz encrypt [TEXT]`](#griz-encrypt-text)
* [`griz help [COMMAND]`](#griz-help-command)
* [`griz init`](#griz-init)
* [`griz inspect`](#griz-inspect)
* [`griz inspect file FILE`](#griz-inspect-file-file)
* [`griz list`](#griz-list)
* [`griz list account`](#griz-list-account)
* [`griz list activity`](#griz-list-activity)
* [`griz list keyring`](#griz-list-keyring)
* [`griz list profile`](#griz-list-profile)
* [`griz profile`](#griz-profile)
* [`griz rotate`](#griz-rotate)
* [`griz show`](#griz-show)
* [`griz show account UID`](#griz-show-account-uid)
* [`griz show activity ID`](#griz-show-activity-id)
* [`griz show apikey KEYID`](#griz-show-apikey-keyid)
* [`griz show keyring [RING]`](#griz-show-keyring-ring)
* [`griz show profile [NAME]`](#griz-show-profile-name)

## `griz BaseCommand`

```
USAGE
  $ griz BaseCommand
```

_See code: [src/commands/BaseCommand.ts](https://github.com/SpikedPunchVictim/key-master-core/blob/v0.0.3/src/commands/BaseCommand.ts)_

## `griz create`

Create resources

```
USAGE
  $ griz create

DESCRIPTION
  Create resources
```

_See code: [src/commands/create/index.ts](https://github.com/SpikedPunchVictim/key-master-core/blob/v0.0.3/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 Account
```

_See code: [src/commands/create/account.ts](https://github.com/SpikedPunchVictim/key-master-core/blob/v0.0.3/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 Key
```

_See code: [src/commands/create/apikey.ts](https://github.com/SpikedPunchVictim/key-master-core/blob/v0.0.3/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 location
```

_See code: [src/commands/create/config.ts](https://github.com/SpikedPunchVictim/key-master-core/blob/v0.0.3/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](https://github.com/SpikedPunchVictim/key-master-core/blob/v0.0.3/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 devops
```

_See code: [src/commands/create/profile.ts](https://github.com/SpikedPunchVictim/key-master-core/blob/v0.0.3/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 /out
```

_See code: [src/commands/decrypt/index.ts](https://github.com/SpikedPunchVictim/key-master-core/blob/v0.0.3/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 --overwrite
```

_See code: [src/commands/encrypt/index.ts](https://github.com/SpikedPunchVictim/key-master-core/blob/v0.0.3/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](https://github.com/oclif/plugin-help/blob/v6.2.32/src/commands/help.ts)_

## `griz init`

Setup an environment for the first time

```
USAGE
  $ griz init

DESCRIPTION
  Setup an environment for the first time

EXAMPLES
  $ griz init init
```

_See code: [src/commands/init/index.ts](https://github.com/SpikedPunchVictim/key-master-core/blob/v0.0.3/src/commands/init/index.ts)_

## `griz inspect`

Inspect encrypted files

```
USAGE
  $ griz inspect

DESCRIPTION
  Inspect encrypted files
```

_See code: [src/commands/inspect/index.ts](https://github.com/SpikedPunchVictim/key-master-core/blob/v0.0.3/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.grenc
```

_See code: [src/commands/inspect/file.ts](https://github.com/SpikedPunchVictim/key-master-core/blob/v0.0.3/src/commands/inspect/file.ts)_

## `griz list`

List resources

```
USAGE
  $ griz list

DESCRIPTION
  List resources
```

_See code: [src/commands/list/index.ts](https://github.com/SpikedPunchVictim/key-master-core/blob/v0.0.3/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 account
```

_See code: [src/commands/list/account.ts](https://github.com/SpikedPunchVictim/key-master-core/blob/v0.0.3/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 timestamp
```

_See code: [src/commands/list/activity.ts](https://github.com/SpikedPunchVictim/key-master-core/blob/v0.0.3/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 keyring
```

_See code: [src/commands/list/keyring.ts](https://github.com/SpikedPunchVictim/key-master-core/blob/v0.0.3/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 legal
```

_See code: [src/commands/list/profile.ts](https://github.com/SpikedPunchVictim/key-master-core/blob/v0.0.3/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 legal
```

_See code: [src/commands/profile.ts](https://github.com/SpikedPunchVictim/key-master-core/blob/v0.0.3/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 legal
```

_See code: [src/commands/rotate/index.ts](https://github.com/SpikedPunchVictim/key-master-core/blob/v0.0.3/src/commands/rotate/index.ts)_

## `griz show`

Show resources

```
USAGE
  $ griz show

DESCRIPTION
  Show resources
```

_See code: [src/commands/show/index.ts](https://github.com/SpikedPunchVictim/key-master-core/blob/v0.0.3/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-name
```

_See code: [src/commands/show/account.ts](https://github.com/SpikedPunchVictim/key-master-core/blob/v0.0.3/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-id
```

_See code: [src/commands/show/activity.ts](https://github.com/SpikedPunchVictim/key-master-core/blob/v0.0.3/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](https://github.com/SpikedPunchVictim/key-master-core/blob/v0.0.3/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](https://github.com/SpikedPunchVictim/key-master-core/blob/v0.0.3/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 legal
```

_See code: [src/commands/show/profile.ts](https://github.com/SpikedPunchVictim/key-master-core/blob/v0.0.3/src/commands/show/profile.ts)_
<!-- commandsstop -->