UNPKG

@graphql-hive/cli

Version:

A CLI util to manage and control your GraphQL Hive

363 lines • 10.2 kB
{ "version": "0.20.3-alpha-20230417164110-27210cbf", "commands": { "whoami": { "id": "whoami", "description": "shows information about the current token", "strict": true, "pluginName": "@graphql-hive/cli", "pluginAlias": "@graphql-hive/cli", "pluginType": "core", "aliases": [], "flags": { "registry": { "name": "registry", "type": "option", "description": "registry address", "multiple": false }, "token": { "name": "token", "type": "option", "description": "api token", "multiple": false } }, "args": {} }, "config:delete": { "id": "config:delete", "description": "deletes specific cli configuration", "strict": true, "pluginName": "@graphql-hive/cli", "pluginAlias": "@graphql-hive/cli", "pluginType": "core", "aliases": [], "flags": {}, "args": { "key": { "name": "key", "description": "config key", "required": true } } }, "config:get": { "id": "config:get", "description": "prints specific cli configuration", "strict": true, "pluginName": "@graphql-hive/cli", "pluginAlias": "@graphql-hive/cli", "pluginType": "core", "aliases": [], "flags": {}, "args": { "key": { "name": "key", "description": "config key", "required": true } } }, "config:reset": { "id": "config:reset", "description": "resets local cli configuration", "strict": true, "pluginName": "@graphql-hive/cli", "pluginAlias": "@graphql-hive/cli", "pluginType": "core", "aliases": [], "flags": {}, "args": {} }, "config:set": { "id": "config:set", "description": "updates specific cli configuration", "strict": true, "pluginName": "@graphql-hive/cli", "pluginAlias": "@graphql-hive/cli", "pluginType": "core", "aliases": [], "flags": {}, "args": { "key": { "name": "key", "description": "config key", "required": true }, "value": { "name": "value", "description": "config value", "required": true } } }, "operations:check": { "id": "operations:check", "description": "checks operations against a published schema", "strict": true, "pluginName": "@graphql-hive/cli", "pluginAlias": "@graphql-hive/cli", "pluginType": "core", "aliases": [], "flags": { "registry": { "name": "registry", "type": "option", "description": "registry address", "multiple": false }, "token": { "name": "token", "type": "option", "description": "api token", "multiple": false }, "require": { "name": "require", "type": "option", "description": "Loads specific require.extensions before running the command", "multiple": true, "default": [] } }, "args": { "file": { "name": "file", "description": "Glob pattern to find the operations", "required": true, "hidden": false } } }, "operations:publish": { "id": "operations:publish", "description": "saves operations to the store", "strict": true, "pluginName": "@graphql-hive/cli", "pluginAlias": "@graphql-hive/cli", "pluginType": "core", "aliases": [], "flags": { "registry": { "name": "registry", "type": "option", "description": "registry address", "multiple": false }, "token": { "name": "token", "type": "option", "description": "api token", "multiple": false }, "require": { "name": "require", "type": "option", "description": "Loads specific require.extensions before running the codegen and reading the configuration", "multiple": true, "default": [] } }, "args": { "file": { "name": "file", "description": "Glob pattern to find the operations", "required": true, "hidden": false } } }, "schema:check": { "id": "schema:check", "description": "checks schema", "strict": true, "pluginName": "@graphql-hive/cli", "pluginAlias": "@graphql-hive/cli", "pluginType": "core", "aliases": [], "flags": { "service": { "name": "service", "type": "option", "description": "service name (only for distributed schemas)", "multiple": false }, "registry": { "name": "registry", "type": "option", "description": "registry address", "multiple": false }, "token": { "name": "token", "type": "option", "description": "api token", "multiple": false }, "forceSafe": { "name": "forceSafe", "type": "boolean", "description": "mark the check as safe, breaking changes are expected", "allowNo": false }, "github": { "name": "github", "type": "boolean", "description": "Connect with GitHub Application", "allowNo": false }, "require": { "name": "require", "type": "option", "description": "Loads specific require.extensions before running the codegen and reading the configuration", "multiple": true, "default": [] } }, "args": { "file": { "name": "file", "description": "Path to the schema file(s)", "required": true, "hidden": false } } }, "schema:delete": { "id": "schema:delete", "description": "deletes a schema", "strict": true, "pluginName": "@graphql-hive/cli", "pluginAlias": "@graphql-hive/cli", "pluginType": "core", "aliases": [], "flags": { "registry": { "name": "registry", "type": "option", "description": "Address of the registry", "multiple": false }, "token": { "name": "token", "type": "option", "description": "API token", "multiple": false }, "dryRun": { "name": "dryRun", "type": "boolean", "description": "Does not delete the service, only reports what it would have done.", "allowNo": false }, "confirm": { "name": "confirm", "type": "boolean", "description": "Confirm deletion of the service", "allowNo": false } }, "args": { "service": { "name": "service", "description": "name of the service", "required": true, "hidden": false } } }, "schema:publish": { "id": "schema:publish", "description": "publishes schema", "strict": true, "pluginName": "@graphql-hive/cli", "pluginAlias": "@graphql-hive/cli", "pluginType": "core", "aliases": [], "flags": { "service": { "name": "service", "type": "option", "description": "service name (only for distributed schemas)", "multiple": false }, "url": { "name": "url", "type": "option", "description": "service url (only for distributed schemas)", "multiple": false }, "metadata": { "name": "metadata", "type": "option", "description": "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", "multiple": false }, "registry": { "name": "registry", "type": "option", "description": "registry address", "multiple": false }, "token": { "name": "token", "type": "option", "description": "api token", "multiple": false }, "author": { "name": "author", "type": "option", "description": "author of the change", "multiple": false }, "commit": { "name": "commit", "type": "option", "description": "associated commit sha", "multiple": false }, "github": { "name": "github", "type": "boolean", "description": "Connect with GitHub Application", "allowNo": false }, "force": { "name": "force", "type": "boolean", "description": "force publish even on breaking changes", "allowNo": false, "deprecated": { "message": "--force is enabled by default for newly created projects" } }, "experimental_acceptBreakingChanges": { "name": "experimental_acceptBreakingChanges", "type": "boolean", "description": "(experimental) accept breaking changes and mark schema as valid (only if composable)", "allowNo": false, "deprecated": { "message": "--experimental_acceptBreakingChanges is enabled by default for newly created projects" } }, "require": { "name": "require", "type": "option", "description": "Loads specific require.extensions before running the codegen and reading the configuration", "multiple": true, "default": [] } }, "args": { "file": { "name": "file", "description": "Path to the schema file(s)", "required": true, "hidden": false } } } } }