Skip to main content

infrahubctl graphql

Various GraphQL related commands.

Usage:

$ infrahubctl graphql [OPTIONS] COMMAND [ARGS]...

Options:

  • --install-completion: Install completion for the current shell.
  • --show-completion: Show completion for the current shell, to copy it or customize the installation.
  • --help: Show this message and exit.

Commands:

  • query-report: Run a GraphQL query through...
  • export-schema: Export the GraphQL schema to a file.
  • generate-return-types: Create Pydantic Models for GraphQL query...

infrahubctl graphql query-report​

Run a GraphQL query through InfrahubGraphQLQueryReport and report its analysis.

Usage:

$ infrahubctl graphql query-report [OPTIONS] NAME

Arguments:

  • NAME: Name of the GraphQL query to analyze. [required]

Options:

  • --online: Fetch the query from the Infrahub server (CoreGraphQLQuery by name) instead of reading it from the local .infrahub.yml file.
  • --branch TEXT: Branch on which to run the report.
  • --config-file TEXT: [env var: INFRAHUBCTL_CONFIG; default: infrahubctl.toml]
  • --help: Show this message and exit.

infrahubctl graphql export-schema​

Export the GraphQL schema to a file.

Usage:

$ infrahubctl graphql export-schema [OPTIONS]

Options:

  • --destination PATH: Path to the GraphQL schema file. [default: schema.graphql]
  • --config-file TEXT: [env var: INFRAHUBCTL_CONFIG; default: infrahubctl.toml]
  • --help: Show this message and exit.

infrahubctl graphql generate-return-types​

Create Pydantic Models for GraphQL query return types.

Usage:

$ infrahubctl graphql generate-return-types [OPTIONS] [QUERY]

Arguments:

  • [QUERY]: Location of the GraphQL query file(s). Defaults to current directory if not specified.

Options:

  • --schema PATH: Path to the GraphQL schema file. [default: schema.graphql]
  • --config-file TEXT: [env var: INFRAHUBCTL_CONFIG; default: infrahubctl.toml]
  • --help: Show this message and exit.