Installation¶

Grafeo supports Python, Node.js/TypeScript, Go, C#, Dart, Rust and WebAssembly. Choose the installation method for the preferred language.

Python¶

Using uv (Recommended)¶

uv is a fast Python package installer:

uv add grafeo

Using pip (alternative)¶

pip install grafeo  # If uv is not available

Verify Installation¶

import grafeo

# Print version
print(grafeo.__version__)

# Create an in-memory test database
db = grafeo.GrafeoDB()
print("Grafeo installed successfully!")

# Or create a persistent database on disk
db = grafeo.GrafeoDB("/path/to/my_graph.db")

Platform Support¶

Node.js / TypeScript¶

npm install @grafeo-db/js

Verify Installation¶

const { GrafeoDB } = require('@grafeo-db/js');

const db = await GrafeoDB.create();
console.log('Grafeo installed successfully!');
await db.close();

Go¶

go get github.com/GrafeoDB/grafeo/crates/bindings/go

Verify Installation¶

package main

import (
    "fmt"
    grafeo "github.com/GrafeoDB/grafeo/crates/bindings/go"
)

func main() {
    db, _ := grafeo.OpenInMemory()
    defer db.Close()
    fmt.Println("Grafeo installed successfully!")
}

WebAssembly¶

npm install @grafeo-db/wasm

Verify Installation¶

import init, { Database } from '@grafeo-db/wasm';

await init();
const db = new Database();
console.log('Grafeo WASM installed successfully!');

C# / .NET¶

dotnet add package GrafeoDB

Verify Installation¶

using Grafeo;

var db = new GrafeoDB();
Console.WriteLine("Grafeo installed successfully!");

Dart¶

Add to pubspec.yaml:

dependencies:
  grafeo: ^0.6.1

Verify Installation¶

import 'package:grafeo/grafeo.dart';

void main() {
  final db = GrafeoDB.memory();
  print('Grafeo installed successfully!');
  db.close();
}

Rust¶

Using Cargo¶

Add Grafeo to the project:

cargo add grafeo

Or add it manually to Cargo.toml:

[dependencies]
grafeo = "0.6"

Feature Flags¶

Grafeo uses persona-based feature profiles that describe use cases rather than deployment targets. Compose them freely to match your needs:

[dependencies]
# Default: GQL + AI + algorithms + parallel + the database file, without a write-ahead log
grafeo = "0.6"

# Add RDF/SPARQL support
grafeo = { version = "0.6", features = ["rdf"] }

# Graph analytics
grafeo = { version = "0.6", features = ["analytics"] }

# Full feature set
grafeo = { version = "0.6", default-features = false, features = ["enterprise"] }

# Minimal: GQL only
grafeo = { version = "0.6", default-features = false, features = ["gql"] }

# With ONNX embedding generation (opt-in, ~17MB)
grafeo = { version = "0.6", features = ["embed"] }

GrafeoDB::open(path) works with the default features, but they have no write-ahead log: commits reach the file when the database checkpoints (close(), dropping it, or wal_checkpoint()), and a process that crashes loses the commits since. For commits that survive a crash, add the wal feature (also in the storage group and the lpg profile):

grafeo = { version = "0.6", features = ["wal"] }

Persona Profiles¶

Convenience Groups¶

Individual Language Flags¶

Individual AI Flags¶

Verify Installation¶

use grafeo::GrafeoDB;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let db = GrafeoDB::new_in_memory();
    println!("Grafeo installed successfully!");
    Ok(())
}

Grafeo Server (Docker)¶

For a standalone database server accessible via REST API, use grafeo-server:

# Standard: all query languages, AI/search, web UI
docker run -p 7474:7474 grafeo/grafeo-server

Three image variants are available:

# Lite: minimal, GQL only
docker run -p 7474:7474 grafeo/grafeo-server:lite

# Full: production with auth and TLS
docker run -p 7474:7474 grafeo/grafeo-server:full \
  --auth-token my-secret --data-dir /data

Server at http://localhost:7474. Web UI (standard/full) at http://localhost:7474/studio/.

See the grafeo-server documentation for full API reference and configuration.

Building from Source¶

Clone the Repository¶

git clone https://github.com/GrafeoDB/grafeo.git
cd grafeo

Build Rust Crates¶

cargo build --workspace --release

Build Python Package¶

cd crates/bindings/python
uv add maturin
maturin develop --release

This build has the same features as the published wheel: maturin reads them from [tool.maturin] features in crates/bindings/python/pyproject.toml. A --features option replaces that list instead of adding to it, so maturin develop --features pyo3/extension-module builds only the default set, without Cypher, SPARQL, Gremlin, GraphQL and SQL/PGQ.

To test another project against an unreleased version, build a wheel the way the release does (from the repository root) and install it into that project's environment:

maturin build --release --out dist -m crates/bindings/python/Cargo.toml
uv pip install --python /path/to/project/.venv dist/grafeo-*.whl

Check what a build contains with grafeo.features() and grafeo.build_info():

import grafeo

print(grafeo.features())    # ['gql', 'cypher', 'sparql', ...]
print(grafeo.build_info())  # version, git commit, dirty, features, profile

Build Node.js Package¶

cd crates/bindings/node
npm install
npm run build

Build WASM Package¶

wasm-pack build crates/bindings/wasm --target web --release

Next Steps¶

With Grafeo installed, continue to the Quick Start guide.