Documentation

Get started in
minutes.

Step-by-step setup for engineers. Start with the quickstart, then pick how you connect—code, terminal, or agent apps.

Quickstart

01

Create your workspace

Sign in to the Graphe console. We provision a workspace, project, and default actor automatically.

Sign up →
02

Issue an API key

Go to Settings → API keys. Copy the key immediately—it is only shown once.

API keys →
03

Install the library

Point your agents at Graphe Cloud using the connection details from your console.

pip install graphe-sdk
export GRAPHE_API_URL=https://api.graphe.dev
export GRAPHE_API_KEY=graphe_...
export GRAPHE_WORKSPACE_ID=<from console>
export GRAPHE_PROJECT_ID=<from console>
export GRAPHE_ACTOR_ID=<from console>
04

Instrument a run

Log tool calls and state changes inside a run. Activity is stored permanently and safe to retry.

from graphe_sdk import GrapheClient, start_run

client = GrapheClient.from_env()
with start_run(client, workspace_id=..., project_id=..., actor_id=..., goal="Fix auth bug") as run:
    run.log_tool("grep", lambda: ...)

Python & TypeScript

Use our client libraries to log runs, search project history, and explain failures. Package: graphe-sdk.

from graphe_sdk import GrapheClient, start_run

client = GrapheClient.from_env()
with start_run(client, workspace_id=..., project_id=..., actor_id=..., goal="...") as run:
    run.log_tool("grep", lambda: ...)

Cursor & agent apps

Add the Graphe integration to Cursor, Claude Desktop, or other supported agent hosts. Config details in docs/mcp.md.

Terminal

pip install graphe-cli
graphe health
graphe search -q "auth"
graphe runs list

Need an account first?

Create a free Graphe Cloud workspace, then return here for connection details.