Skip to main content

Usage

Description

Pushes the provided operations to the control plane, enabling them to be used from the router when using the given graph_name. Additionally, it registers the given client_name as a well-known client. The operations file might be one of the following formats: The operations are validated against the graph schema before registering them. If any of the operations is invalid, no operations will be registered.

Operation IDs

Apollo manifests and Relay query maps preserve supplied operation IDs. Plain GraphQL files receive a SHA256 ID computed from their contents. IDs must contain 1–250 printable ASCII characters (space through tilde), excluding forward slash and backslash. IDs are case-sensitive and are not trimmed or normalized. Control characters, DEL, and non-ASCII characters are rejected.

Options

  • -n, --namespace : The namespace of the federated graph (Default: “default”).
  • -c, --client-name <client-name> The client name / identifier to register these operations under. By default, the client name must be sent by the client at request time via the graphql-client-name HTTP header. When the router runs in manifest mode, the client name is used only for organizational structure in the Studio (e.g. you could use "default") and is not matched against incoming requests.
  • -f, --file <filename> Filename to read operations from. This argument can be used multiple times to read operations from multiple files. See Description for a list of the supported file formats.
  • -q, --quiet Don’t produce any output, just exit with success or error. Intended for use in CI checks.
  • --format <output-format> Specify an output format for the returned data. Support types include text (the default) and json.