@gr4vy/cli
v0.2.0
Published
The Gr4vy CLI
Keywords
Readme
Gr4vy CLI
The Gr4vy CLI is a useful tool for developers to quickly generate tokens, query data, and perform basic API manipulation.
Usage
The Gr4vy CLI is a Node library that can be installed as follows.
$ npm install -g @gr4vy/cli
$ gr4vy COMMAND
running command...
$ gr4vy (--version)
@gr4vy/cli/0.1.4 darwin-arm64 node-v22.15.0
$ gr4vy --help [COMMAND]
USAGE
$ gr4vy COMMAND
...Getting started
The main use for this CLI is to create an API key. Download your API key and then initialize the SDK with the name of your instance, the target environment, and the filename your key is in.
gr4vy init acme sandbox private_key.pemThis will create a ~/.gr4vyrc.json file with your config ready for use.
Next, you can create a JWT for use in Embed as well as for server-to-server use.
gr4vy token expiresIn=10d --scope=buyers.read --scope=buyers.write
gr4vy embed 1299 USD buyer_external_identifier=user-123Additionally, you can inspect each token by passing the --debug flag.
gr4vy token expiresIn=10d --scope=buyers.read --scope=buyers.write --debug
gr4vy embed 1299 USD buyer_external_identifier=user-123 --debugMore details on each command is available below.
Commands
gr4vy autocomplete [SHELL]
Display autocomplete installation instructions.
USAGE
$ gr4vy autocomplete [SHELL] [-r]
ARGUMENTS
SHELL (zsh|bash|powershell) Shell type
FLAGS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
DESCRIPTION
Display autocomplete installation instructions.
EXAMPLES
$ gr4vy autocomplete
$ gr4vy autocomplete bash
$ gr4vy autocomplete zsh
$ gr4vy autocomplete powershell
$ gr4vy autocomplete --refresh-cacheSee code: @oclif/plugin-autocomplete
gr4vy help [COMMAND]
Display help for gr4vy.
USAGE
$ gr4vy 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 gr4vy.See code: @oclif/plugin-help
