Skip to content

Commit

Permalink
docs: install cli as binary (#1556)
Browse files Browse the repository at this point in the history
  • Loading branch information
saihaj authored Jan 9, 2024
1 parent 2b3edbc commit 79474d9
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 14 deletions.
18 changes: 15 additions & 3 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,26 @@ or a local directory for debugging, and deploys the subgraph to a

## Installation

The Graph CLI can be installed with `npm` or `yarn`:
We recommend install the CLI using package manager `npm` or `yarn` or `pnpm` when developing
subgraphs locally:

```sh
# NPM
npm install -g @graphprotocol/graph-cli
npm install @graphprotocol/graph-cli

# Yarn
yarn global add @graphprotocol/graph-cli
yarn add @graphprotocol/graph-cli

# pnpm
pnpm install @graphprotocol/graph-cli
```

You can install the CLI globally using a binary. Eventually this will become the default mechanism
for installing the CLI and building subgraphs because users do not need to install `Node.js` or any
other external dependencies.

```sh
curl -LS https://cli.thegraph.com/install.sh | sudo sh
```

### On Linux
Expand Down
22 changes: 11 additions & 11 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 79474d9

Please sign in to comment.