3 graphql - Command-line GraphQL client
11 graphql <URL> <QUERY> [ [--variables JSON] | [--variable KEY=VALUE]... ]
12 [--operation-name NAME] [--transport KEY=VALUE]...
13 [--[no-]unpack] [--format json|json:pretty|yaml|perl|csv|tsv|table]
16 graphql --version|--help|--manual
20 `graphql` is a command-line program for executing queries and mutations on
21 a [GraphQL](https://graphql.org/) server.
25 There are several ways to install `graphql` to your system.
29 You can install `graphql` using [cpanm](https://metacpan.org/pod/cpanm):
35 You can also choose to download `graphql` as a self-contained executable:
37 curl -OL https://raw.githubusercontent.com/chazmcgarvey/graphql-client/solo/graphql
40 To hack on the code, clone the repo instead:
42 git clone https://github.com/chazmcgarvey/graphql-client.git
44 make bootstrap # installs dependencies; requires cpanm
50 The URL of the GraphQL server endpoint.
52 If no `--url` option is given, the first argument is assumed to be the URL.
54 This option is required.
60 The query or mutation to execute.
62 If no `--query` option is given, the next argument (after URL) is assumed to be the query.
64 If the value is "-" (which is the default), the query will be read from `STDIN`.
66 See: [https://graphql.org/learn/queries/](https://graphql.org/learn/queries/)
72 Provide the variables as a JSON object.
74 Aliases: `--vars`, `-V`
76 ## `--variable KEY=VALUE`
78 An alternative way to provide variables one at a time. This option can be repeated to provide
81 If used in combination with ["--variables JSON"](#variables-json), this option is silently ignored.
83 See: [https://graphql.org/learn/queries/#variables](https://graphql.org/learn/queries/#variables)
85 Aliases: `--var`, `-d`
87 ## `--operation-name NAME`
89 Inform the server which query/mutation to execute.
95 Write the response to a file instead of STDOUT.
99 ## `--transport KEY=VALUE`
101 Key-value pairs for configuring the transport (usually HTTP).
107 Specify the output format to use. See ["FORMAT"](#format).
115 By default, the response structure is printed as-is from the server, and the program exits 0.
117 When unpack mode is enabled, if the response completes with no errors, only the data section of
118 the response is printed and the program exits 0. If the response has errors, the whole response
119 structure is printed as-is and the program exits 1.
121 See ["EXAMPLES"](#examples).
125 The argument for ["--format STR"](#format-str) can be one of:
127 - `csv` - Comma-separated values (requires [Text::CSV](https://metacpan.org/pod/Text%3A%3ACSV))
128 - `json:pretty` - Human-readable JSON (default)
130 - `perl` - Perl code (requires [Data::Dumper](https://metacpan.org/pod/Data%3A%3ADumper))
131 - `table` - Table (requires [Text::Table::Any](https://metacpan.org/pod/Text%3A%3ATable%3A%3AAny))
132 - `tsv` - Tab-separated values (requires [Text::CSV](https://metacpan.org/pod/Text%3A%3ACSV))
133 - `yaml` - YAML (requires [YAML](https://metacpan.org/pod/YAML))
135 The `csv`, `tsv`, and `table` formats will only work if the response has a particular shape:
160 If the response cannot be formatted, the default format will be used instead, an error message will
161 be printed to STDERR, and the program will exit 3.
163 Table formatting can be done by one of several different modules, each with its own features and
164 bugs. The default module is [Text::Table::Tiny](https://metacpan.org/pod/Text%3A%3ATable%3A%3ATiny), but this can be overridden using the
165 `PERL_TEXT_TABLE` environment variable if desired, like this:
167 PERL_TEXT_TABLE=Text::Table::HTML graphql ... -f table
169 The list of supported modules is at ["@BACKENDS" in Text::Table::Any](https://metacpan.org/pod/Text%3A%3ATable%3A%3AAny#BACKENDS).
173 Different ways to provide the query/mutation to execute:
175 graphql http://myserver/graphql {hello}
177 echo {hello} | graphql http://myserver/graphql
179 graphql http://myserver/graphql <<END
183 graphql http://myserver/graphql
184 Interactive mode engaged! Waiting for a query on <STDIN>...
188 Execute a query with variables:
190 graphql http://myserver/graphql <<END --var episode=JEDI
191 > query HeroNameAndFriends($episode: Episode) {
192 > hero(episode: $episode) {
201 graphql http://myserver/graphql --vars '{"episode":"JEDI"}'
203 Configure the transport:
205 graphql http://myserver/graphql {hello} -t headers.authorization='Basic s3cr3t'
207 This example shows the effect of ["--unpack"](#unpack):
209 graphql http://myserver/graphql {hello}
214 "hello" : "Hello world!"
218 graphql http://myserver/graphql {hello} --unpack
222 "hello" : "Hello world!"
227 Some environment variables affect the way `graphql` behaves:
229 - `GRAPHQL_CLIENT_DEBUG` - Set to 1 to print diagnostic messages to STDERR.
230 - `GRAPHQL_CLIENT_HTTP_USER_AGENT` - Set the HTTP user agent string.
231 - `GRAPHQL_CLIENT_OPTIONS` - Set the default set of options.
232 - `PERL_TEXT_TABLE` - Set table format backend; see ["FORMAT"](#format).
236 Here is a consolidated summary of what exit statuses mean:
239 - `1` - Client or server errors
240 - `2` - Option usage is wrong
241 - `3` - Could not format the response as requested
245 - [GraphQL::Client](https://metacpan.org/pod/GraphQL%3A%3AClient) - Programmatic interface
249 Please report any bugs or feature requests on the bugtracker website
250 [https://github.com/chazmcgarvey/graphql-client/issues](https://github.com/chazmcgarvey/graphql-client/issues)
252 When submitting a bug or request, please include a test-file or a
253 patch to an existing test-file that illustrates the bug or desired
258 Charles McGarvey <chazmcgarvey@brokenzipper.com>
260 # COPYRIGHT AND LICENSE
262 This software is copyright (c) 2020 by Charles McGarvey.
264 This is free software; you can redistribute it and/or modify it under
265 the same terms as the Perl 5 programming language system itself.