2 # ABSTRACT: Command-line GraphQL client
7 graphql <URL> <QUERY> [ [--variables JSON] | [--variable KEY=VALUE]... ]
8 [--operation-name NAME] [--transport KEY=VALUE]...
9 [--[no-]unpack] [--format json|json:pretty|yaml|perl|csv|tsv|table]
12 graphql --version|--help|--manual
16 C<graphql> is a command-line program for executing queries and mutations on
17 a L<GraphQL|https://graphql.org/> server.
21 There are several ways to install F<graphql> to your system.
25 You can install F<graphql> using L<cpanm>:
31 You can also choose to download F<graphql> as a self-contained executable:
33 curl -OL https://raw.githubusercontent.com/chazmcgarvey/graphql-client/solo/graphql
36 To hack on the code, clone the repo instead:
38 git clone https://github.com/chazmcgarvey/graphql-client.git
40 make bootstrap # installs dependencies; requires cpanm
46 The URL of the GraphQL server endpoint.
48 If no C<--url> option is given, the first argument is assumed to be the URL.
50 This option is required.
56 The query or mutation to execute.
58 If no C<--query> option is given, the next argument (after URL) is assumed to be the query.
60 If the value is "-" (which is the default), the query will be read from C<STDIN>.
62 See: L<https://graphql.org/learn/queries/>
66 =head2 C<--variables JSON>
68 Provide the variables as a JSON object.
70 Aliases: C<--vars>, C<-V>
72 =head2 C<--variable KEY=VALUE>
74 An alternative way to provide variables one at a time. This option can be repeated to provide
77 If used in combination with L</"--variables JSON">, this option is silently ignored.
79 See: L<https://graphql.org/learn/queries/#variables>
81 Aliases: C<--var>, C<-d>
83 =head2 C<--operation-name NAME>
85 Inform the server which query/mutation to execute.
89 =head2 C<--output FILE>
91 Write the response to a file instead of STDOUT.
95 =head2 C<--transport KEY=VALUE>
97 Key-value pairs for configuring the transport (usually HTTP).
101 =head2 C<--format STR>
103 Specify the output format to use. See L</FORMAT>.
111 By default, the response structure is printed as-is from the server, and the program exits 0.
113 When unpack mode is enabled, if the response completes with no errors, only the data section of
114 the response is printed and the program exits 0. If the response has errors, the whole response
115 structure is printed as-is and the program exits 1.
121 The argument for L</"--format STR"> can be one of:
124 * C<csv> - Comma-separated values (requires L<Text::CSV>)
125 * C<json:pretty> - Human-readable JSON (default)
127 * C<perl> - Perl code (requires L<Data::Dumper>)
128 * C<table> - Table (requires L<Text::Table::Any>)
129 * C<tsv> - Tab-separated values (requires L<Text::CSV>)
130 * C<yaml> - YAML (requires L<YAML>)
132 The C<csv>, C<tsv>, and C<table> formats will only work if the response has a particular shape:
157 If the response cannot be formatted, the default format will be used instead, an error message will
158 be printed to STDERR, and the program will exit 3.
160 Table formatting can be done by one of several different modules, each with its own features and
161 bugs. The default module is L<Text::Table::Tiny>, but this can be overridden using the
162 C<PERL_TEXT_TABLE> environment variable if desired, like this:
164 PERL_TEXT_TABLE=Text::Table::HTML graphql ... -f table
166 The list of supported modules is at L<Text::Table::Any/@BACKENDS>.
170 Different ways to provide the query/mutation to execute:
172 graphql http://myserver/graphql {hello}
174 echo {hello} | graphql http://myserver/graphql
176 graphql http://myserver/graphql <<END
180 graphql http://myserver/graphql
181 Interactive mode engaged! Waiting for a query on <STDIN>...
185 Execute a query with variables:
187 graphql http://myserver/graphql <<END --var episode=JEDI
188 > query HeroNameAndFriends($episode: Episode) {
189 > hero(episode: $episode) {
198 graphql http://myserver/graphql --vars '{"episode":"JEDI"}'
200 Configure the transport:
202 graphql http://myserver/graphql {hello} -t headers.authorization='Basic s3cr3t'
204 This example shows the effect of L</--unpack>:
206 graphql http://myserver/graphql {hello}
211 "hello" : "Hello world!"
215 graphql http://myserver/graphql {hello} --unpack
219 "hello" : "Hello world!"
224 Some environment variables affect the way C<graphql> behaves:
227 * C<GRAPHQL_CLIENT_DEBUG> - Set to 1 to print diagnostic messages to STDERR.
228 * C<GRAPHQL_CLIENT_HTTP_USER_AGENT> - Set the HTTP user agent string.
229 * C<GRAPHQL_CLIENT_OPTIONS> - Set the default set of options.
230 * C<PERL_TEXT_TABLE> - Set table format backend; see L</FORMAT>.
234 Here is a consolidated summary of what exit statuses mean:
238 * C<1> - Client or server errors
239 * C<2> - Option usage is wrong
240 * C<3> - Could not format the response as requested
245 * L<GraphQL::Client> - Programmatic interface
249 # FATPACK - Do not remove this line.
254 use GraphQL::Client::CLI;
256 our $VERSION = '999.999'; # VERSION
258 GraphQL::Client::CLI->main(@ARGV);