Skip to content

Getting Started

Grizzly's CLI brings the grizzly functionality into your workflows. You can manage KeyRing access, disable user access, view activity logs, and much more.

Installation

Requirements

To install the CLI on Windows, macOS, or Linux, run:

npm install -g @grizzlycbg/cli

Configuration File

Access to the platform is managed through a config file. The configuration file stores the tenant URL, and Profiles that define differing levels of access. Multiple profiles can be setup within the configuration file, so that access management is done by switching profiles.

To get started, run:

griz init

This will walk you through the creation of a config file that provides access to your tenant. Once finished, you can test your access by running:

griz list keyring

You should see something like:

┌───────────┬───────────────┬─────────────┬───────────────────────┐
│ name      │ id            │ displayName │ activeKey             │
├───────────┼───────────────┼─────────────┼───────────────────────┤
│  default  │  ring-000000  │  default    │  key-000000-00000000  │
└───────────┴───────────────┴─────────────┴───────────────────────┘

Config File Locations

  • Windows: C:\Users\<username>\.grizzly\griz.yaml
  • macOS: /Users/<username>/.grizzly/griz.yaml
  • Linux: /home/<username>/.grizzly/griz.yaml

Environment Variables

Besides setting the Config file and Profile along when running commands, environment variables can be used to set them. The command line arguments will always override the environment variables set.

There sre 2 environment variables used:

  • GRIZZLY_CONFIG: Absolute path to the grizzly config file
  • GRIZZLY_PROFILE: The Profile to use

Command Structure

The CLI commands are designed with the verb first, then subject. For example:

# Show details for the "legal" KeyRing
gris show keyring legal

# List all Accounts
griz list account

# Show all Activity
griz list activity

Here's an overview of the commands:

  • griz init
  • griz encrypt
  • griz decrypt
  • griz rotate <keyring-name>
  • griz create
    • profile
    • keyring
    • account
    • apikey
    • config
  • griz list
    • profile
    • keyring
    • account
    • activity
  • griz show
    • profile
    • keyring
    • account
    • apikeys
    • activty