Skip to content

Commit

Permalink
🚀 feat added cli publish command docs (graphprotocol#690)
Browse files Browse the repository at this point in the history
* 🚀 `feat` added cli publish command docs

* Update website/pages/en/publishing/publishing-a-subgraph.mdx

Co-authored-by: Idalith  <[email protected]>

---------

Co-authored-by: Idalith <[email protected]>
  • Loading branch information
mitchhs12 and idalithb authored Jun 3, 2024
1 parent e34dc41 commit f26fd90
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions website/pages/en/publishing/publishing-a-subgraph.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,24 @@ Alternatively, you can add GRT signal to a published subgraph from Graph Explore
## Updating metadata for a published subgraph

Once your subgraph has been published to the decentralized network, you can modify the metadata at any time by making the update in Subgraph Studio dashboard of the subgraph. After saving the changes and publishing your updates to the network, they will be reflected in Graph Explorer. This won’t create a new version, as your deployment hasn’t changed.

## Publishing from the CLI

As of version 0.73.0, you can also publish your subgraph with the `graph-cli`.

Simply type `graph publish` after doing `graph build && graph codegen` and a window will open, allowing you to connect your wallet, add metadata, and deploy your finalized subgraph to a network of your choice.

![cli-ui](/img/cli-ui.png)

You can also upload your build to a specific IPFS node and futher customize your deployment with the following flags:

```
USAGE
$ graph publish [SUBGRAPH-MANIFEST] [-h] [-i <value>] [--ipfs-hash <value>] [--webapp-url <value>]
FLAGS
-h, --help Show CLI help.
-i, --ipfs=<value> [default: https://api.thegraph.com/ipfs/api/v0] Upload build results to an IPFS node.
--ipfs-hash=<value> IPFS hash of the subgraph manifest to deploy.
--webapp-url=<value> [default: https://cli.thegraph.com/publish] URL of the web UI you want to use to deploy.
```
Binary file added website/public/img/cli-ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f26fd90

Please sign in to comment.