# Graphide

> Graphide runs coding agents (Claude Code, Codex) on your projects and draws your code as a map you can read while they work. It is a native app for Linux and macOS, with a command line tool, gr, and a plugin system in TypeScript.

To install Graphide for a user, follow https://graphide.com/claude.md. Every docs page below is also in one file at https://graphide.com/llms-full.txt. On a machine with gr installed, `gr help <command>` and `gr plugin api` answer for the version installed there.

## Get started

- [Introduction](https://graphide.com/docs/): How to install Graphide, map a project, connect your coding agents, and use the app, the gr command and plugins.
- [Install](https://graphide.com/docs/install/): Install the gr command line tool and the Graphide app, sign in, keep them up to date, and remove them.
- [Map your first project](https://graphide.com/docs/first-map/): Open a project, build its map, and keep the map up to date as the code changes.
- [Connect your coding agent](https://graphide.com/docs/agents/): Give Claude Code, Codex, Cursor and other agents the map of your code, in the app or in your own terminal.

## The app

- [A tour of the app](https://graphide.com/docs/app/): The parts of the Graphide window, the three windows you can choose between, and how to find any command.
- [The map](https://graphide.com/docs/app/map/): Read your whole codebase as cards inside cards, move around it, rearrange it, and see the Architecture diagram drawn from it.
- [Agents in the app](https://graphide.com/docs/app/agents/): Start Claude Code and Codex agents, steer them, answer what they ask, and keep several at work at once.
- [Review changes](https://graphide.com/docs/app/review/): See what your agents changed, drawn on the map, accept or reject it, and bring their work home.
- [Keys and mouse](https://graphide.com/docs/app/keys/): The keys of the Normal window and Standard layout, on the map, in the composer, and the mouse on the map.
- [The Vim window](https://graphide.com/docs/app/vim/): Vim's panes, modes and colon commands, with the map beside your code, and the map's own Vim keys.
- [Settings](https://graphide.com/docs/app/settings/): Where Graphide's settings live, the ones most people change, themes, and settings for one project.

## Command line

- [Using gr](https://graphide.com/docs/cli/): What the gr command does, how it finds your project, and the commands you will use most.
- [Command reference](https://graphide.com/docs/cli/reference/): Every documented gr command by task, each with its subcommands and flags.
  - [gr login](https://graphide.com/docs/cli/reference/login/): Log in to Graphide
  - [gr logout](https://graphide.com/docs/cli/reference/logout/): Log out of Graphide
  - [gr app](https://graphide.com/docs/cli/reference/app/): The Graphide app: whether a newer one is out, updating it, and going back
  - [gr version](https://graphide.com/docs/cli/reference/version/): Print this build, the daemon's, and whether a newer one exists
  - [gr terms](https://graphide.com/docs/cli/reference/terms/): Read, and accept, changes to Graphide's terms and privacy policy
  - [gr telemetry](https://graphide.com/docs/cli/reference/telemetry/): Show or change what this install reports
  - [gr uninstall](https://graphide.com/docs/cli/reference/uninstall/): Remove Graphide's settings, sign-in and cached data from this computer
  - [gr completion](https://graphide.com/docs/cli/reference/completion/): Generate the autocompletion script for the specified shell
  - [gr project](https://graphide.com/docs/cli/reference/project/): Start a project on this machine
  - [gr init](https://graphide.com/docs/cli/reference/init/): Initialize and build the project graph
  - [gr sync](https://graphide.com/docs/cli/reference/sync/): Bring the graph back in step with the code
  - [gr map](https://graphide.com/docs/cli/reference/map/): Show whether main's map and every worktree's are up to date
  - [gr status](https://graphide.com/docs/cli/reference/status/): Report whether the daemon is serving this project
  - [gr stop](https://graphide.com/docs/cli/reference/stop/): Close this project's workspace in the daemon, if it is open
  - [gr worktree](https://graphide.com/docs/cli/reference/worktree/): Create, list and land git worktrees that have a graph in them
  - [gr trust](https://graphide.com/docs/cli/reference/trust/): Show or change whether Graphide may run this project's own code
  - [gr clear](https://graphide.com/docs/cli/reference/clear/): Delete the entire graph for this project
  - [gr forget](https://graphide.com/docs/cli/reference/forget/): Delete this machine's record of what you have been looking at
  - [gr summary](https://graphide.com/docs/cli/reference/summary/): Print the graph's architecture, hubs, entry points and questions
  - [gr query](https://graphide.com/docs/cli/reference/query/): Ask the graph a question (search + typed walk, budgeted)
  - [gr impact](https://graphide.com/docs/cli/reference/impact/): List callers and users of a node, hop by hop
  - [gr code](https://graphide.com/docs/cli/reference/code/): Print a node's source code
  - [gr outline](https://graphide.com/docs/cli/reference/outline/): List a file's symbols with spans and signatures
  - [gr similar](https://graphide.com/docs/cli/reference/similar/): Find similar code using local embeddings
  - [gr recap](https://graphide.com/docs/cli/reference/recap/): Print what a finished turn or build did
  - [gr claude](https://graphide.com/docs/cli/reference/claude/): Run Claude Code with Graphide injected at launch; writes nothing to your files
  - [gr codex](https://graphide.com/docs/cli/reference/codex/): Run Codex with Graphide's MCP server injected at launch; writes nothing to your files
  - [gr harness](https://graphide.com/docs/cli/reference/harness/): Write a terminal agent's integration to disk (or run `gr claude` to write nothing)
  - [gr mcp](https://graphide.com/docs/cli/reference/mcp/): Serve this workspace's graph to an external agent harness over MCP (stdio)
  - [gr agent](https://graphide.com/docs/cli/reference/agent/): List, start, read, type into and stop this workspace's agents
  - [gr cloud](https://graphide.com/docs/cli/reference/cloud/): Your cloud projects, and building a local graph from one
  - [gr github](https://graphide.com/docs/cli/reference/github/): Connect GitHub and add cloud projects
  - [gr org](https://graphide.com/docs/cli/reference/org/): Your orgs, their people, invites and projects
  - [gr machine](https://graphide.com/docs/cli/reference/machine/): Manage the computers on your account
  - [gr plugin](https://graphide.com/docs/cli/reference/plugin/): Write, check, install and manage Graphide plugins
  - [gr doctor](https://graphide.com/docs/cli/reference/doctor/): Report what is wrong with this project, and fix what can be fixed
  - [gr report](https://graphide.com/docs/cli/reference/report/): Bundle logs and status for a bug report
  - [gr logs](https://graphide.com/docs/cli/reference/logs/): Show this machine's Graphide events
  - [gr daemon](https://graphide.com/docs/cli/reference/daemon/): Inspect and control the machine-wide daemon

## Plugins

- [Using plugins](https://graphide.com/docs/plugins/): Install plugins, read what each may do before it runs, approve it, and switch plugins off.
- [Write a plugin](https://graphide.com/docs/plugins/write/): Build a small plugin step by step, with a command, a statusline segment and a panel, then test it and run it in the app.
- [plugin.toml](https://graphide.com/docs/plugins/manifest/): The plugin manifest. Its root keys, what a plugin can add, default keys, settings and limits.
- [Permissions](https://graphide.com/docs/plugins/permissions/): How a plugin asks for what it needs, what a person approves, every request and what it allows, and what runs outside the sandbox.
- [Test and debug](https://graphide.com/docs/plugins/test/): Check a plugin, test it on fixtures with fake time, draw its views as text, work on it live, and read its logs and status.
- [Share a plugin](https://graphide.com/docs/plugins/share/): Share a plugin through a git repository, pin it for a team in the repository it serves, or publish it to the plugin store. Plus updates, rollback and importing VS Code and Zed extensions.
- [API reference](https://graphide.com/docs/plugins/reference/): Every element, event, method, command and limit of the plugin interface.
  - [Elements](https://graphide.com/docs/plugins/reference/elements/)
  - [Events](https://graphide.com/docs/plugins/reference/events/)
  - [Methods](https://graphide.com/docs/plugins/reference/methods/)
  - [Commands](https://graphide.com/docs/plugins/reference/commands/)
  - [Actions](https://graphide.com/docs/plugins/reference/actions/)
  - [Context keys](https://graphide.com/docs/plugins/reference/context/)
  - [Capabilities](https://graphide.com/docs/plugins/reference/capabilities/)
  - [Types](https://graphide.com/docs/plugins/reference/types/)
  - [Test API](https://graphide.com/docs/plugins/reference/testing/)
  - [Limits](https://graphide.com/docs/plugins/reference/limits/)
  - [Errors](https://graphide.com/docs/plugins/reference/errors/)

## Help

- [Your code and data](https://graphide.com/docs/privacy/): What Graphide keeps on your machine and on its servers, the telemetry levels and how to change them, and how to delete things.
- [Troubleshooting](https://graphide.com/docs/troubleshooting/): What to run first, the problems people hit most and their fixes, and how to report a bug.