console/packages/libraries/cli

GraphQL Hive CLI

A CLI util to manage and control your GraphQL Hive

• GraphQL Hive CLI
• Usage
• Commands
• Config

Usage

$ npm install -g @graphql-hive/cli
$ hive COMMAND
running command...
$ hive (--version)
@graphql-hive/cli/0.19.5 darwin-arm64 node-v16.18.0
$ hive --help [COMMAND]
USAGE
  $ hive COMMAND
...

Commands

• hive config:delete KEY
• hive config:get KEY
• hive config:reset
• hive config:set KEY VALUE
• hive help [COMMAND]
• hive operations:check FILE
• hive operations:publish FILE
• hive schema:check FILE
• hive schema:publish FILE
• hive update [CHANNEL]
• hive whoami

hive config:delete KEY

deletes specific cli configuration

USAGE
  $ hive config:delete [KEY]

ARGUMENTS
  KEY  config key

DESCRIPTION
  deletes specific cli configuration

See code: dist/commands/config/delete.js

hive config:get KEY

prints specific cli configuration

USAGE
  $ hive config:get [KEY]

ARGUMENTS
  KEY  config key

DESCRIPTION
  prints specific cli configuration

See code: dist/commands/config/get.js

hive config:reset

resets local cli configuration

USAGE
  $ hive config:reset

DESCRIPTION
  resets local cli configuration

See code: dist/commands/config/reset.js

hive config:set KEY VALUE

updates specific cli configuration

USAGE
  $ hive config:set [KEY] [VALUE]

ARGUMENTS
  KEY    config key
  VALUE  config value

DESCRIPTION
  updates specific cli configuration

See code: dist/commands/config/set.js

hive help [COMMAND]

Display help for hive.

USAGE
  $ hive 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 hive.

See code: @oclif/plugin-help

hive operations:check FILE

checks operations against a published schema

USAGE
  $ hive operations:check [FILE] [--registry <value>] [--token <value>] [--require <value>]

ARGUMENTS
  FILE  Glob pattern to find the operations

FLAGS
  --registry=<value>    registry address
  --require=<value>...  [default: ] Loads specific require.extensions before running the command
  --token=<value>       api token

DESCRIPTION
  checks operations against a published schema

See code: dist/commands/operations/check.js

hive operations:publish FILE

saves operations to the store

USAGE
  $ hive operations:publish [FILE] [--registry <value>] [--token <value>] [--require <value>]

ARGUMENTS
  FILE  Glob pattern to find the operations

FLAGS
  --registry=<value>    registry address
  --require=<value>...  [default: ] Loads specific require.extensions before running the codegen and reading the
                        configuration
  --token=<value>       api token

DESCRIPTION
  saves operations to the store

See code: dist/commands/operations/publish.js

hive schema:check FILE

checks schema

USAGE
  $ hive schema:check [FILE] [--service <value>] [--registry <value>] [--token <value>] [--forceSafe] [--github]
    [--require <value>]

ARGUMENTS
  FILE  Path to the schema file(s)

FLAGS
  --forceSafe           mark the check as safe, breaking changes are expected
  --github              Connect with GitHub Application
  --registry=<value>    registry address
  --require=<value>...  [default: ] Loads specific require.extensions before running the codegen and reading the
                        configuration
  --service=<value>     service name (only for distributed schemas)
  --token=<value>       api token

DESCRIPTION
  checks schema

See code: dist/commands/schema/check.js

hive schema:publish FILE

publishes schema

USAGE
  $ hive schema:publish [FILE] [--service <value>] [--url <value>] [--metadata <value>] [--registry <value>]
    [--token <value>] [--author <value>] [--commit <value>] [--github] [--force] [--experimental_acceptBreakingChanges]
    [--require <value>]

ARGUMENTS
  FILE  Path to the schema file(s)

FLAGS
  --author=<value>                      author of the change
  --commit=<value>                      associated commit sha
  --experimental_acceptBreakingChanges  (experimental) accept breaking changes and mark schema as valid (only if
                                        composable)
  --force                               force publish even on breaking changes
  --github                              Connect with GitHub Application
  --metadata=<value>                    additional metadata to attach to the GraphQL schema. This can be a string with a
                                        valid JSON, or a path to a file containing a valid JSON
  --registry=<value>                    registry address
  --require=<value>...                  [default: ] Loads specific require.extensions before running the codegen and
                                        reading the configuration
  --service=<value>                     service name (only for distributed schemas)
  --token=<value>                       api token
  --url=<value>                         service url (only for distributed schemas)

DESCRIPTION
  publishes schema

See code: dist/commands/schema/publish.js

hive update [CHANNEL]

update the hive CLI

USAGE
  $ hive update [CHANNEL] [-a] [-v <value> | -i] [--force]

FLAGS
  -a, --available        Install a specific version.
  -i, --interactive      Interactively select version to install. This is ignored if a channel is provided.
  -v, --version=<value>  Install a specific version.
  --force                Force a re-download of the requested version.

DESCRIPTION
  update the hive CLI

EXAMPLES
  Update to the stable channel:

    $ hive update stable

  Update to a specific version:

    $ hive update --version 1.0.0

  Interactively select version:

    $ hive update --interactive

  See available versions:

    $ hive update --available

See code: @oclif/plugin-update

hive whoami

checks schema

USAGE
  $ hive whoami [--registry <value>] [--token <value>]

FLAGS
  --registry=<value>  registry address
  --token=<value>     api token

DESCRIPTION
  checks schema

See code: dist/commands/whoami.js

Config

In addition to using the CLI args, you can also define your configuration in a JSON file which the CLI would pick up when it runs.

You can use the HIVE_CONFIG environment variable to define the path to the JSON file as follows:

HIVE_CONFIG=/path/to/hive.json hive schema:publish --author Vignesh path/to/file.gql

Note that the CLI args will override the values in config if both are specified.

This is how the structure of the config file should look like:

{
  "registry": "<yourRegistryURL>",
  "token": "<yourtoken>"
}