Skip to main content

Usage

Description

The npx wgc clients delete command deletes a registered GraphQL client from a federated graph or monograph. If the client has persisted operations or persisted operation traffic, the command asks for confirmation. Confirming deletes the client and its related persisted operations. Use --force to skip confirmation. Use --json to print structured JSON output.

Parameters

  • <client-name>: The name of the registered GraphQL client.

Options

  • -g, --graph-name <string> : The name of the federated graph or monograph the client belongs to. Required.
  • -n, --namespace <string> : The namespace of the federated graph or monograph. Defaults to default.
  • -j, --json : Prints structured JSON instead of text.
  • -f, --force : Deletes the client without confirmation. Required with --json if persisted operations would be deleted or have traffic.

Examples

Deletes the client named web from the graph named production.
Deletes the client named web from the graph named production in the staging namespace without prompting.
Deletes the client named web and prints JSON output.