Quickstart

This guide walks you from a fresh install to your first graph query.

Prerequisites

• A Kubernetes cluster (any of: GKE, EKS, AKS, on-prem k3s, or a local dev cluster like OrbStack / minikube / kind).
• A data source — Starburst, Snowflake, BigQuery, Databricks, S3, GCS, or a CSV file.
• kubectl configured to talk to your cluster.

1. Install with Helm

helm repo add viograph https://helm.viograph.io
helm repo update
helm install viograph viograph/viograph --namespace viograph --create-namespace

The chart installs the control plane, export worker, and a Postgres metadata store. Everything runs in your cluster under your identity.

2. Open the dashboard

kubectl port-forward svc/dashboard 3000:3000 -n viograph
open http://localhost:3000

3. Connect a data source

• Go to Connect Source.
• Pick your warehouse type (Snowflake / BigQuery / Databricks / Starburst / S3 / GCS / CSV).
• Fill in credentials — they’re stored in your cluster, never sent to us.
• Click Test connection.

4. Map your tables

• Go to Connect Data.
• Pick one or more tables to become nodes (e.g. customers, accounts, transactions).
• Pick one or more tables to become edges (e.g. transfers with from_account_id / to_account_id columns).
• Save the mapping.

5. Launch a graph

• Go to Launch Graphs → New instance.
• Select the mapping you just created.
• The control plane will spin up a wrapper pod, load your data, and make the graph queryable.

6. Run your first query

• Go to Explore Graphs.
• Click Pattern Library → pick a pattern that matches your data.
• Or open the Cypher Editor and write your own:

MATCH (n)-[r]->(m)
RETURN n, r, m
LIMIT 25

Click Run (or Cmd+Enter). You should see your graph rendered on the canvas within seconds.

Next steps

• Dashboard features — Pattern Library, Cypher Editor, AI assistant, Schema Browser, Workspaces, Sharing.
• Cypher for SQL people — ramp-up guide if you know SQL and want to map it to Cypher.
• Use cases — fraud, supply chain, citation networks, patent intelligence.