The Guild LogoThe Guild Monogram
GraphQL Mesh

GraphQL Mesh

Query anything, run anywhere.

Contact Us

Installation#

GraphQL Mesh comes in multiple packages, which you should install according to your needs.

Mesh CLI, the core package#

To get started, let's first install locally the Mesh CLI package (and dependencies):

yarn add graphql @graphql-mesh/cli

Note: Avoid installing Mesh CLI as a global dependency

 


 

Handlers and Transforms packages#

As stated previously, Mesh comes in many packages.

Each Source Handler and Transforms are shipped as dedicated packages, for example:

  • The Handler to configure a REST API Source requires the @graphql-mesh/openapi package
  • The naming convention Transforms requires the @graphql-mesh/transform-naming-convention package

Mesh will display a helpful error message when using a Handler or Transforms that is not properly installed.

The full list of Source Handler packages can be found here, same for Transforms packages.