On this page

Installation

GraphQL Mesh v0 documentation (superseded by v1): Install GraphQL Mesh and its various packages, including Mesh CLI, handlers, and transforms, to easily configure REST API sources and naming conventions. Learn more here.

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):

npm i @graphql-mesh/cli graphql

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.