0xgraph CLI

The 0xgraph CLI to deploy subgraphs, index & transform blockchain data, and access your data in real-time.

Usage

• 0xgraph init — Creates a new subgraph project from an example or an existing contract.
• 0xgraph create — Registers a subgraph name.
• 0xgraph remove — Unregisters a subgraph name.
• 0xgraph codegen — Generates AssemblyScript types for smart contract ABIs and the subgraph schema.
• 0xgraph build — Compiles a subgraph to WebAssembly.
• 0xgraph deploy — Deploys a subgraph to 0xgraph.

deploy command requires several flags to be provided to complete successfully. See below:

| Flag/Example | Required | Description | | ----------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --node http://65.109.19.223:8020 | Yes | URL of the valid Graph Node instance. | | --ipfs http://65.109.19.223:5001 | Yes | URL of the IPFS API. | | --version-pub-url http://95.217.114.57:8050/version | No | URL of the api-extensions-service endpoint for publishing deploy version. Skip publishing if not provided. |

• 0xgraph auth — Stores a Graph 0xgraph access token in the system's keychain.
• 0xgraph local — Runs tests against a test environment (using Ganache by default).
• 0xgraph test — Downloads and runs the Matchstick rust binary in order to test a subgraph.
• 0xgraph add - Adds a new datasource to the yaml file and writes the necessary changes to other files - schema.graphql, abi and mapping.

Installation

We recommend install the CLI using package manager npm or yarn or pnpm when developing subgraphs locally:

# NPM
npm install -g @0xgraph/cli

# Yarn
yarn global add @0xgraph/cli

# pnpm
pnpm add -g @0xgraph/cli

Linux

On linux, libsecret is used for managing access tokens, so it may be necessary to install it before running the cli.

• Debian/Ubuntu: sudo apt-get install libsecret-1-dev
• Red Hat: sudo yum install libsecret-devel
• Arch Linux: sudo pacman -S libsecret
• NixOS: nix-shell -p libsecret (or edit configuration.nix)