First Steps with Hive Cloud

Create Hive Account

To get started with Hive, first sign up and create your Hive account if you haven’t already. You can use this page to login or sign up.

At the moment, Hive Cloud supports GitHub and Google authentication, or you can use a plain email/password combination.

Once you have your Hive account, you can create your Hive organization.

Create Hive Organization

A Hive organization is a group of users who share a common set of permissions, or who collaborate on GraphQL APIs. Hive organizations are used to manage access, integrations, and billing.

To create a new organization, you use this page.

Once you’ve successfully created your organization, you’ll be able to expand your organization by inviting other members to join and collaborate on projects.

You can create as many organizations as you want, and you can be a member of multiple organizations.

Install Hive CLI

Hive CLI is a command-line tool for managing your Hive projects and schemas from the terminal. It will be used for publishing schemas and apps to the Hive registry.

If you are running a non-JavaScript project, you can download the prebuilt binary of Hive CLI using the following command:

curl -sSL https://graphql-hive.com/install.sh | sh

To download a specific version, follow instructions from the “Hive CLI installation” chapter.

Run the following command to verify the installation:

hive --version

If you are running a JavaScript/NodeJS project, you can install Hive CLI from the npm registry:

npm i -D @graphql-hive/cli

pnpm add -D @graphql-hive/cli

yarn add --dev @graphql-hive/cli

bun add --dev @graphql-hive/cli

We recommend installing Hive CLI as part of your project, under devDependencies, instead of using a global installation.

Verify the downloaded image by running the following command:

npx hive --version

For a docker-based project, you can use the official Hive CLI Docker image.

docker pull ghcr.io/graphql-hive/cli

Verify the downloaded image by running the following command:

docker run --name graphql-hive-cli --rm ghcr.io/graphql-hive/cli --version

Create Hive Project

A Hive project represents a GraphQL API project running a GraphQL schema, created under an organization.

Hive supports the following project types:

Apollo Federation: composition of multiple GraphQL services following the Apollo Federation specification into a single unified graph.
Single Schema: a simple monolithic GraphQL schema
Schema Stitching: a form of remote schema merging allowing developers to merge any GraphQL schema(s), under one or many gateways using Schema Stitching

💡

Please note that a project type cannot be changed once it is created. However, you can always create an unlimited number of projects under your organization.

To get started with your Hive project, click on Create Project + button from the organization’s main page:

Continue with one of the following guide based on the type of project you selected.

Apollo Federation Single Schema Schema-Stitching

Introduction Apollo Federation