Question 1

How do I migrate from GraphQL CLI 3 to version 4?

Accepted Answer

Follow the official migration guide linked in the README, which details syntax and structure changes. Be prepared to update your GraphQL Config files and plugin configurations, as many aspects have evolved.

Question 2

What plugins are available for GraphQL CLI?

Accepted Answer

Community plugins include codegen for type generation, diff for schema comparison, validate for document checking, and serve for local development. Check the README for a full list and installation via npm packages.

Question 3

How to generate TypeScript types using GraphQL CLI?

Accepted Answer

Use the codegen plugin integrated with GraphQL Code Generator. Configure it in your .graphqlrc.yml file to specify output paths and plugins like typescript and typescript-resolvers for automated type definitions.

Question 4

GraphQL CLI vs Apollo CLI: which should I use?

Accepted Answer

GraphQL CLI is more extensible and integrates with GraphQL Config for a unified ecosystem, while Apollo CLI is optimized for Apollo Server and Client workflows. Choose GraphQL CLI for plugin flexibility, or Apollo CLI for deep Apollo-specific features.

Question 5

Can I use GraphQL CLI without a YAML config file?

Accepted Answer

Basic commands might work with arguments, but advanced features like plugin configuration require a GraphQL Config file (e.g., .graphqlrc.yml). The init command can generate this for you, but manual setup is needed for customizations.

Question 6

How to create a custom plugin for GraphQL CLI?

Accepted Answer

Refer to the tutorial in the docs for writing custom extensions. You'll need to package your command as a separate npm package and understand GraphQL CLI's API, as outlined in the contribution section.

graphql-cli

What is graphql-cli?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions