CLI for building for and deploying to The Graph


0.22.0a day ago3 years agoMinified + gzip package size for @graphprotocol/graph-cli in KB


The Graph CLI (graph-cli)

npm (scoped) Build Status

The Graph Command Line Interface

As of today, the command line interface supports the following commands:

  • graph init — Creates a new subgraph project from an example or an existing contract.
  • graph create — Registers a subgraph name with a Graph Node.
  • graph remove — Unregisters a subgraph name with a Graph Node.
  • graph codegen — Generates AssemblyScript types for smart contract ABIs and the subgraph schema.
  • graph build — Compiles a subgraph to WebAssembly.
  • graph deploy — Deploys a subgraph to a Graph Node.
  • graph auth — Stores a Graph Node access token in the system's keychain.
  • graph local — Runs tests against a Graph Node test environment (using Ganache by default).
  • graph test — Downloads and runs the Matchstick rust binary in order to test a subgraph.

How It Works

The Graph CLI takes a subgraph manifest (defaults to subgraph.yaml) with references to:

  • A GraphQL schema,
  • Smart contract ABIs, and
  • Mappings written in AssemblyScript.

It compiles the mappings to WebAssembly, builds a ready-to-use version of the subgraph saved to IPFS or a local directory for debugging, and deploys the subgraph to a Graph Node.


The Graph CLI can be installed with npm or yarn:

npm install -g @graphprotocol/graph-cli

# Yarn
yarn global add @graphprotocol/graph-cli

On Linux

libsecret is used for storing access tokens, so you may need to install it before getting started. Use one of the following commands depending on your distribution:

  • Debian/Ubuntu: sudo apt-get install libsecret-1-dev
  • Red Hat: sudo yum install libsecret-devel
  • Arch Linux: sudo pacman -S libsecret

Getting Started

The Graph CLI can be used with a local or self-hosted Graph Node or with the Hosted Service. To help you get going, there are quick start guides available for both.

If you are ready to dive into the details of building a subgraph from scratch, there is a detailed walkthrough for that as well, along with API documentation for the AssemblyScript API.


Copyright © 2018-2019 Graph Protocol, Inc. and contributors.

The Graph CLI is dual-licensed under the MIT license and the Apache License, Version 2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either expressed or implied. See the License for the specific language governing permissions and limitations under the License.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.