Installation

Install the packages you need depending on your use case.

All-in-one (umbrella package)

If you plan to use all three packages (server + client + React hooks), install the umbrella package:

bun

bun add graphql-suite graphql drizzle-orm @tanstack/react-query react

npm

npm install graphql-suite graphql drizzle-orm @tanstack/react-query react

pnpm

pnpm add graphql-suite graphql drizzle-orm @tanstack/react-query react

yarn

yarn add graphql-suite graphql drizzle-orm @tanstack/react-query react

Then import from the scoped packages — this works with both install approaches:

import { buildSchema } from '@graphql-suite/schema'
import { createDrizzleClient } from '@graphql-suite/client'
import { GraphQLProvider, useEntity } from '@graphql-suite/query'

Individual packages

If you only need specific packages, install them separately. All three are published independently.

Server (schema builder)

bun

bun add @graphql-suite/schema graphql drizzle-orm

npm

npm install @graphql-suite/schema graphql drizzle-orm

pnpm

pnpm add @graphql-suite/schema graphql drizzle-orm

yarn

yarn add @graphql-suite/schema graphql drizzle-orm

This is the core package. It takes your Drizzle table definitions and produces a full GraphQL schema at runtime.

Client (type-safe GraphQL client)

bun

bun add @graphql-suite/client drizzle-orm

npm

npm install @graphql-suite/client drizzle-orm

pnpm

pnpm add @graphql-suite/client drizzle-orm

yarn

yarn add @graphql-suite/client drizzle-orm

A standalone client that builds type-safe GraphQL queries from your Drizzle schema. Works in any JavaScript environment (Node, Bun, browsers, React Native).

React hooks (optional)

bun

bun add @graphql-suite/query @tanstack/react-query react

npm

npm install @graphql-suite/query @tanstack/react-query react

pnpm

pnpm add @graphql-suite/query @tanstack/react-query react

yarn

yarn add @graphql-suite/query @tanstack/react-query react

Wraps the client in React hooks powered by TanStack Query. Use this if you are building a React frontend.

Peer dependencies

Each package has its own peer dependencies that you must install alongside it. This ensures your application uses a single copy of each library, avoiding version conflicts.

Package	Peer dependencies
@graphql-suite/schema	drizzle-orm >= 0.44.0, graphql >= 16.3.0
@graphql-suite/client	drizzle-orm >= 0.44.0
@graphql-suite/query	react >= 18.0.0, @tanstack/react-query >= 5.0.0