Installing the CLI

Search…

Installing the CLI

Install the Graphite CLI using either npm or homebrew:
npm installation 
# Install Graphite from npm.
npm install -g @withgraphite/graphite-cli
gt --version
brew installation
# Install Graphite from Homebrew.
brew install withgraphite/tap/graphite
gt --version
See the following page instructions on setting up shell tab completion after installation.
Node.js versioning
We develop Graphite with and set the Homebrew dependency to Node.js v16 (active LTS version until October 2022), but Graphite should run with no major issues on any current version of Node.  If you run into any issues that seem Node-related, try using v16 if you're able to as a first workaround!
Windows
If you'd like to use Graphite on Windows, we recommend working within Windows Subsystem for Linux.  Follow the instructions here to set it up.  After setting up WSL, you can set up nvm/node/npm and then install Graphite as normal!  We are slowly working towards better native Windows support — if you'd like to stay up to date, the discussions are often found in our community Slack.

Guides - Previous

Graphite CLI

Shell completion setup

Last modified 3mo ago

Export as PDF

Copy link

On this page

Node.js versioning

Windows