@graphprotocol/graph-cli
Advanced tools
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.The Graph CLI takes a subgraph manifest (defaults to subgraph.yaml) with references to:
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
npm install -g @graphprotocol/graph-cli
# Yarn
yarn global add @graphprotocol/graph-cli
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:
sudo apt-get install libsecret-1-devsudo yum install libsecret-develsudo pacman -S libsecretThe 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.
FAQs
CLI for building for and deploying to The Graph
The npm package @graphprotocol/graph-cli receives a total of 17,274 weekly downloads. As such, @graphprotocol/graph-cli popularity was classified as popular.
We found that @graphprotocol/graph-cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.
Security News
Research
Socket researchers found a malicious Maven package impersonating the legitimate ‘XZ for Java’ library, introducing a backdoor for remote code execution.