Skip to content

Commit f26fd90

Browse files
mitchhs12idalithb
andauthored
🚀 feat added cli publish command docs (#690)
* 🚀 `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]>
1 parent e34dc41 commit f26fd90

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

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

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,3 +49,24 @@ Alternatively, you can add GRT signal to a published subgraph from Graph Explore
4949
## Updating metadata for a published subgraph
5050

5151
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.
52+
53+
## Publishing from the CLI
54+
55+
As of version 0.73.0, you can also publish your subgraph with the `graph-cli`.
56+
57+
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.
58+
59+
![cli-ui](/img/cli-ui.png)
60+
61+
You can also upload your build to a specific IPFS node and futher customize your deployment with the following flags:
62+
63+
```
64+
USAGE
65+
$ graph publish [SUBGRAPH-MANIFEST] [-h] [-i <value>] [--ipfs-hash <value>] [--webapp-url <value>]
66+
67+
FLAGS
68+
-h, --help Show CLI help.
69+
-i, --ipfs=<value> [default: https://api.thegraph.com/ipfs/api/v0] Upload build results to an IPFS node.
70+
--ipfs-hash=<value> IPFS hash of the subgraph manifest to deploy.
71+
--webapp-url=<value> [default: https://cli.thegraph.com/publish] URL of the web UI you want to use to deploy.
72+
```

website/public/img/cli-ui.png

345 KB
Loading

0 commit comments

Comments
 (0)