cynic-cli

A CLI for Cynic, the code first GraphQL client for Rust

Documentation | Changelog

Overview

Cynic is a code first GraphQL client for Rust. cynic-cli is a CLI that provides utilities for working with cynic specifically and GraphQL in general.

Features

• Can introspect a remote server and dump it's schema.
• Detects GraphQL features the server supports and tailors introspection queries appropriately.

Usage

```console $ cynic help CLI for the cynic, the Rust GraphQL client library

Usage: cynic [COMMAND]

Commands: introspect Runs an introspection query against a GraphQL server and outputs the servers schema help Print this message or the help of the given subcommand(s)

Options: -h, --help Print help -V, --version Print version

```

Introspect

The introspect command runs an introspection query against a server and prints the schema to stdout/a file.

```console $ cynic help introspect Runs an introspection query against a GraphQL server and outputs the servers schema

Usage: cynic introspect [OPTIONS]

Arguments: The URL of the GraphQL schema that we should introspect

Options: -H, --header Any headers to send with the introspection request

      These should be in HTTP format e.g. `-H "Authorization: Bearer a_token_123"`

-o, --output

The name of a file we should output the schema into.

      By default we print to stdout.

  --server-version <SERVER_VERSION>
      The version of the GraphQL specificaiton that the remote GraphQL server implements

      Different versions of GraphQL expose different fields via introspection, so we need to know which set of fields to ask for.

      By default we run an additional query to figure out what the server we're talking to supports.

      [default: auto]

      Possible values:
      - 2018: Run an introspection query compatible with the 2018 GraphQL specification
      - 2021: Run an introspection query compatible with the 2021 GraphQL specification
      - auto: Run an additional query to determine what the GraphQL server supports

-h, --help Print help (see a summary with '-h')

```