Getting started with Garphield

Garphield is a workbench for exploring, analysing, and presenting networks. It runs locally in the browser and comes with bindings for Python & R. Garphield can also be embedded on any website.

The Three Laws of Garphield

1. No distracting layout animations. Garphield builds the best graph it can, as fast as possible.
2. Agent-ready. Anything you can do, agents can do too. Don’t want to use the UI? That’s fine.
3. No bad views. Garphield protects you from the hairball. We’re working towards a future with no bad views. If you see something you don’t like, report it and we’ll work hard to prevent it in the future.

Open Garphield or follow the Quick start.

Automation

Choose the surface that matches the work you need to do:

Surface	Capability boundary
HTTP-only agents	Read documentation, LLM files, the command schema, and fetch graph files by URL.
Python and R	Validate, convert, fingerprint, and save .gph project documents without mounting a view.
Mounted browser renderer	window.garphield, WebMCP, embeds, and notebook widgets require a mounted browser renderer.
Playwright	Automates the mounted renderer in a headless browser; it is not browser-free.

Point your agent at the concise Garphield documentation index:

https://garphield.com/llms.txt

The complete manual contains every documentation page and a build-time snapshot of the automation command schema.

Then ask for what you need, for example:

• Load this CSV and show me the most connected nodes.
• Build a graph from the entities on this page and run community detection.
• Download a PNG of this network for my presentation.

Projects can be validated, saved, fingerprinted, and turned into complete Garphield links without opening a browser. Analysis, layout, visual inspection, and PNG export run in the live workbench or notebook renderer. See the automation API to choose the right surface.

Integrations

Garphield provides bindings for all environments.

• Jupyter
• marimo
• Snowpark
• pandas
• NetworkX
• R
• Raphtory

Supported file types

Garphield imports common graph and table formats. Here is the smallest useful example of each:

Format	Extension	Tiny example
Garphield project	.gph	A saved Garphield workspace
GEXF	.gexf	<gexf><graph>…
GraphML	.graphml	<graphml><graph>…
GML	.gml	graph [ node [ id 0 ] ]
Graphviz DOT	.dot, .gv	graph { a -- b }
Node-link JSON	.json	{"nodes": […], "edges": […]}
CSV or TSV	.csv, .tsv	source,target
Edge list	.edges, .txt	a b
Matrix Market	.mtx	%%MatrixMarket matrix coordinate…

See Supported file formats for details.

Contact

Questions, ideas, or something not working? Email [email protected].