Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

← Back to Samyama Insight

Getting Started with Samyama Graph

A step-by-step guide to install, connect, and explore Samyama Graph using the web visualizer at graph.samyama.cloud.

Demo Video

The demo covers: local Samyama Graph setup, connecting graph.samyama.cloud to a local instance, connecting to the hosted endpoint at api.samyama.dev, running Cypher queries, exploring graph visualizations, and using the Schema Explorer and Dashboard.

Option A — Local Setup (Run on Your Machine)

Step 1 — Install Rust

Open your terminal and run:

Mac / Linux

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Windows

  1. Go to https://rustup.rs
  2. Download and run rustup-init.exe
  3. Follow the installer

After installation, restart your terminal. Verify it worked:

rustc --version
cargo --version

Step 2 — Clone the Repository

git clone https://github.com/samyama-ai/samyama-graph
cd samyama-graph

Step 3 — Build the Engine

cargo build --release

When complete you will see:

Finished `release` profile [optimized] target(s) in Xs

Step 4 — Start the Engine

Mac / Linux

./target/release/samyama

Windows

.\target\release\samyama.exe

You will see:

HTTP server starting on port 8080
Server ready. Press Ctrl+C to stop.

The engine is now running on:

  • Port 8080 — HTTP API (for the visualizer)
  • Port 6379 — Redis protocol (for redis-cli)

Step 5 — Open the Visualizer

  1. Open the Chrome browser

  2. Go to graph.samyama.cloud

  3. Sign up with your email and password (free)

  4. In the connection box, type:

    http://localhost:8080

  5. Click Connect

You should see:

  • Status: healthy ✅
  • Version: 1.0.0
  • Nodes and Edges count

Note: If you see a Failed to fetch error, go to the Chrome address bar → click the lock icon → Site Settings → Insecure Content → set to Allow → refresh the page.

Option B — No Local Setup (Explore Instantly)

If you do not want to install anything:

  1. Go to graph.samyama.cloud

  2. Sign up with your email and password (free)

  3. In the connection box, type:

    https://api.samyama.dev

  4. Click Connect

You are immediately connected to a live Samyama instance with real data. No installation required.

Running Your First Query

  1. Click Query Console in the left sidebar.

  2. Type this query in the editor:

    MATCH (n) RETURN labels(n), count(n)

  3. Click Run (or press Ctrl+Enter).

You will see results in the Table tab showing all node types and their counts.

Switch to Graph View

  1. Click the Graph tab in the results area.
  2. You will see an interactive force-directed graph:
    • Hover over any node to see its properties.
    • Drag nodes to rearrange.
    • Scroll to zoom in or out.

More Queries to Try

-- See all relationships
MATCH ()-[r]->() RETURN type(r), count(r)

-- Browse nodes with their properties
MATCH (n) RETURN n LIMIT 25

-- Find connected nodes
MATCH (n)-[r]->(m) RETURN n, r, m LIMIT 20

Schema Explorer

The Schema Explorer shows you the complete structure of your graph.

Click Schema Explorer in the left sidebar. You will see:

  • Total Nodes — total count across all labels
  • Total Edges — total count across all relationship types
  • Node Types — each label with its count
  • Edge Types — each relationship type with its count

This is useful for understanding what data is in your graph before writing queries.

Dashboard

The Dashboard auto-generates charts from your graph schema — no configuration needed.

Click Dashboard in the left sidebar. You will see panels including:

  • Total Nodes — big number card
  • Total Edges — big number card
  • Node Label Distribution — pie chart
  • Edge Type Distribution — pie chart
  • Top Labels by Count — bar chart
  • Graph Health — connected components, isolated nodes, average degree

Click Open in Console on any panel to see and edit the underlying Cypher query. Every chart is backed by a real Cypher query — you can modify and re-run them in the Query Console.

My Queries (Query History)

All queries you run are automatically saved.

Click My Queries in the left sidebar. You will see three tabs:

  • Recent — all queries grouped by date
  • Bookmarked — queries you starred
  • Frequent — queries you run most often

You can:

  • Click Run on any saved query to execute it again
  • Click the star icon to bookmark a query

Plan Visualizer

See how the query engine executes your query.

  1. Click Plan Visualizer in the left sidebar.
  2. Type a Cypher query.
  3. Click Explain to see the execution plan as a visual tree.
  4. Click Profile to see actual execution times per operator.

Common Issues

Failed to fetch on graph.samyama.cloud

Chrome → Lock Icon → Site Settings → Insecure Content → Allow

Port 8080 already in use

lsof -ti :8080 | xargs kill -9

Then restart Samyama.

Build takes too long

The first build normally takes 5–15 minutes on a typical laptop. Subsequent builds are much faster.

No data after connecting

Your graph is empty. Create a sample node:

CREATE (n:Person {name: 'Alice'}) RETURN n

Next Steps

That’s it — you’re up and running with Samyama Graph. Happy querying!