Skip to content
DocsIntroduction

Get started

Graphide docs

How to install Graphide, map a project, connect your coding agents, and use the app, the gr command and plugins.

Graphide runs coding agents on your projects and draws your code as a map you can read while they work. These docs cover the three parts you use:

  • The app, a native window for Linux and macOS. Projects and agents sit on the left, conversations and files in the middle, and the map of your code on the right.
  • gr, the command line tool. It installs and updates the app, signs you in, builds maps, and connects agents you run in a terminal, such as Claude Code, Codex and Cursor.
  • Plugins, written in TypeScript, which add commands, panels, pickers and map badges to the app, and tools for your agents.

Behind both the app and gr runs one background service per user, the daemon. It keeps each project’s map up to date as the code changes, and the app, gr and your agents all read the map through it. You do not start it yourself.

Start here

  1. Install Graphide: one command for gr, one for the app, then sign in.
  2. Map your first project: open a folder and build its map.
  3. Connect your coding agent: give Claude Code, Codex or another agent the map, inside the app or in your own terminal.

The short version, on Linux or macOS:

curl -fsSL https://graphide.com/install.sh | sh
gr app install
gr login
gr app open .

Find your way

You want to Read
Learn the app’s parts and windows A tour of the app
Read and rearrange the map The map
Run and steer agents in the app Agents in the app
See and accept what agents changed Review changes
Look up a key Keys and mouse
Look up a gr command Command reference
Install or write a plugin Using plugins, Write a plugin
Know what leaves your computer Your code and data
Fix something Troubleshooting

For coding agents

An agent asked to install Graphide for someone can follow graphide.com/claude.md. The outline of these docs is at /llms.txt, and every page in one file is at /llms-full.txt.

These docs describe Graphide 0.2.16, the latest release. Something wrong or missing? Tell us onDiscord or at hello@graphide.com.