OS Manuals

/opt/chainguard/dagster/bin/gql-cli

Dagster data orchestration platform for building and maintaining data assets

From dagster 1.13.29-r0 (enterprise-packages), captured 2026-11-08 by running gql-cli --help (exit 0). permalink

usage: gql-cli [-h] [-V [VARIABLES ...]] [-H [HEADERS ...]] [--version] [-d | -v]
               [-o OPERATION_NAME] [--print-schema] [--schema-download [SCHEMA_DOWNLOAD ...]]
               [--execute-timeout EXECUTE_TIMEOUT]
               [--transport {auto,aiohttp,httpx,phoenix,websockets,aiohttp_websockets,appsync_http,appsync_websockets}]
               [--api-key API_KEY | --jwt JWT]
               server

Send GraphQL queries from the command line using http(s) or websockets.
If used interactively, write your query, then use Ctrl-D (EOF) to execute it.

positional arguments:
  server                the server url starting with http://, https://, ws:// or wss://

options:
  -h, --help            show this help message and exit
  -V [VARIABLES ...], --variables [VARIABLES ...]
                        query variables in the form key:json_value
  -H [HEADERS ...], --headers [HEADERS ...]
                        http headers in the form key:value
  --version             show program's version number and exit
  -d, --debug           print lots of debugging statements (loglevel==DEBUG)
  -v, --verbose         show low level messages (loglevel==INFO)
  -o OPERATION_NAME, --operation-name OPERATION_NAME
                        set the operation_name value
  --print-schema        get the schema from instrospection and print it
  --schema-download [SCHEMA_DOWNLOAD ...]
                        select the introspection query arguments to download the schema.
                                    Only useful if --print-schema is used.
                                    By default, it will:

                                     - request field descriptions
                                     - request deprecated input fields

                                    Possible options:

                                     - descriptions:false             for a compact schema without comments
                                     - input_value_deprecation:false  to omit deprecated input fields
                                     - specified_by_url:true
                                     - schema_description:true
                                     - directive_is_repeatable:true
  --execute-timeout EXECUTE_TIMEOUT
                        set the execute_timeout argument of the Client (default: 10)
  --transport {auto,aiohttp,httpx,phoenix,websockets,aiohttp_websockets,appsync_http,appsync_websockets}
                        select the transport. 'auto' by default: aiohttp or websockets depending on url scheme

AWS AppSync options:

  By default, for an AppSync backend, the IAM authentication is chosen.

  If you want API key or JWT authentication, you can provide one of the
  following arguments:

  --api-key API_KEY     Provide an API key for authentication
  --jwt JWT             Provide an JSON Web token for authentication

EXAMPLES
========

# Simple query using https
echo 'query { continent(code:"AF") { name } }' | gql-cli https://countries.trevorblades.com

# Simple query using websockets
echo 'query { continent(code:"AF") { name } }' | gql-cli wss://countries.trevorblades.com/graphql

# Query with variable
echo 'query getContinent($code:ID!) { continent(code:$code) { name } }' | gql-cli https://countries.trevorblades.com --variables code:AF

# Interactive usage (insert your query in the terminal, then press Ctrl-D to execute it)
gql-cli wss://countries.trevorblades.com/graphql --variables code:AF

# Execute query saved in a file
cat query.gql | gql-cli wss://countries.trevorblades.com/graphql

# Print the schema of the backend
gql-cli https://countries.trevorblades.com/graphql --print-schema
Options (9)
OptionDescriptionSource
-h, --helpshow this help message and exithelp
--versionshow program's version number and exithelp
-d, --debugprint lots of debugging statements (loglevel==DEBUG)help
-v, --verboseshow low level messages (loglevel==INFO)help
--print-schemaget the schema from instrospection and print ithelp
--execute-timeout EXECUTE_TIMEOUTset the execute_timeout argument of the Client (default: 10)help
--transport autoselect the transport.help
--api-key API_KEYProvide an API key for authenticationhelp
--jwt JWTProvide an JSON Web token for authenticationhelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.