Skip to content

chntnm/akasha

Repository files navigation

Akasha

Your Vault as a navigable 3D universe.

A vault of ~2,000 notes rendered as a 3D particle galaxy, clusters colored by domain

Above: a vault of ~2,000 interlinked markdown files as a force-directed particle galaxy. The layout engine builds the clusters from the links alone, with zero configuration; each color is a knowledge domain, and the bright strands between clusters are real cross-domain links.

Flythrough

Camera orbiting the whole graph, then diving into a cluster as note labels fade in

Orbit the whole graph, then dive into a cluster; the note labels fade in as the camera approaches. Watch in HD (mp4).

What it is

Akasha (Sanskrit: ākāśa, "the ether, the space that holds everything") scans any folder of Markdown files connected by links and renders the link graph as an interactive force-directed map in WebGL: rotate it, fly through it, read any note without leaving the map. It reads both link styles: Obsidian [[wiki links]] resolved by basename, and standard markdown links to .md files ([text](path.md)) resolved by relative path. An Obsidian vault is the natural fit, but Obsidian itself is never required: the only contract is markdown files in folders, and deep links into Obsidian are an optional convenience.

Why I made it

Obsidian renders vaults and notes in 2d. When visualizing large data sets, 3d visualizations are often needed for seeing patterns at scale or discovering intersections. Akasha seeks to solve that problem by providing the ability to traverse and visualize your second brain in a 3d navigatable space.

Reads Google's Open Knowledge Format

Point Akasha at an Open Knowledge Format bundle — Google Cloud's open spec for markdown knowledge — and it renders like any vault: concepts become nodes, the [name](path.md) links become edges, and the whole bundle becomes a navigable 3D graph.

npx akasha-graph "C:/path/to/okf-bundle"

Akasha reads OKF frontmatter fully: each concept is labeled by its title (falling back to the filename), and its type, tags, and description are carried into the graph. Markdown links between concepts become the edges; the folder hierarchy becomes the pillars.

Quickstart

npx akasha-graph "C:/path/to/YourVault"     # scan, serve, open in one command

Or from a clone:

npm install
npm run scan -- "C:/path/to/YourVault" --exclude "Private/Drafts"
npm run build
npm start          # → http://localhost:5175

For development (hot reload): npm run dev and open http://localhost:5173.

Desktop app

npm run desktop

Builds the frontend, bundles the Electron main process, and opens Akasha as a native window with hardware acceleration unlocked (GPU rasterization, zero-copy uploads, no GPU blocklist, powerPreference: high-performance). The 20k-link scene, bloom, and particles all render on the dedicated GPU.

Desktop-only conveniences: File → Open Vault… (Ctrl+O) picks any vault directory and scans it on the spot; Rescan Current Vault (Ctrl+Shift+R) refreshes the graph after you've added notes; the server binds a random localhost-only port.

How it works

scanner/   walks the vault, resolves [[wiki links]] by basename (case-
           insensitive, like Obsidian) and standard [markdown](links.md) by
           relative path (the OKF link style), emits data/graph.json: nodes,
           links, pillars, degrees, phantom targets
server/    Express on localhost: /api/graph + /api/note (markdown read live
           from disk, path-confined to the vault root)
web/       Vite + TypeScript + three.js (3d-force-graph): the map, the reader
           panel, search, legend, focus mode

The scanner is vault-agnostic: point it at any Obsidian vault and the pillars, colors, and clusters derive from your folder structure and your links.

What it does

  • Navigate: drag to rotate, scroll to zoom, right-drag to pan; arrow keys fly the camera (a tap nudges, holding accelerates to ~6× cruise, and speed scales with distance so long crossings are fast and close-in moves stay precise).
  • Search and fly: press /, type, hit Enter; the camera travels to the top hit. The server builds a MiniSearch inverted index over note content (titles boosted, prefix + fuzzy matching) on first query; ~4 ms per query after that.
  • Read without leaving the map: clicking a node opens the rendered Markdown in a draggable, resizable side panel; [[wiki links]] inside it are clickable and fly you to the next node. Double-click opens the note in Obsidian itself via the obsidian:// URI.
  • Focus mode: selecting a node dims everything outside its depth-N neighborhood (depth 1–3, like Obsidian's local graph).
  • Filters: an ordered list of show / ignore rules decides which nodes render. Patterns match titles, tags, and folders by fuzzy text or wildcard (macro*, *lipid); show keeps matches (a whitelist), ignore hides them. The top rule wins, rules drag to reorder, and the list persists across sessions.
  • Your groups, your colors: group nodes by top-level folder or by #tag; every legend swatch is a color picker, and clicking a legend row toggles that group's visibility.
  • Weighted node sizing: node size reflects incoming links, outgoing links, and word count, each with its own weight slider, plus a contrast curve that exaggerates or flattens the spread between hubs and leaf notes.
  • Phantom nodes: notes you've linked to but not yet written, rendered the way Obsidian renders unresolved links (off by default); an orphans toggle hides notes with no links.
  • Always-on labels, Obsidian style: every node carries its name; labels fade in by camera distance, so names appear as you approach a cluster.
  • Deep links & sharing: ?focus=, ?theme=, and ?nodes= in the URL preset the view on load; Tools → Copy Link to Selected Note generates a shareable link to the current note.
  • Export & view: File → Export Image (PNG) saves the current view; the View menu adds Reset Camera and Toggle Fullscreen.

Built for massive vaults

Akasha holds the entire graph in view and stays interactive as vaults grow into the thousands of notes. Below, the same vault from another angle, ~20k links, every node and edge rendered at once:

A 1,800-note vault rendered dense, clusters and cross-links visible

Akasha keeps rescan and render cost proportional to what changed:

  • Incremental rescans: the scanner caches per-file parse results by mtime+size (scan-cache.json) and re-reads only the files that changed. Edit one note in a 2k-note vault: 108ms — 1 parsed, 1829 from cache. At 50k notes the difference is seconds vs. minutes. --full forces a cold scan.
  • Content fingerprint: a hash of the file manifest keys the layout cache, so a no-op rescan keeps your settled layout.
  • One-draw-call links: all links render as a single merged LineSegments buffer; per-frame cost stays flat no matter how many links you have.
  • Label budget: only the ~140 nearest labels draw per frame.
  • Lazy full-text index: the server builds it once per session on first search; ~4 ms per query after that.

Themes & node styles

Ten themes restyle the entire app (scene, links, starfield, bloom, node palette, and UI panels), selectable from the bottom bar, the View menu, or ?theme= in the URL. Four node styles set how each note is drawn: classic glossy spheres, faceted dodecahedron gems, glowing starlight cores, and volumetric swirling particle shells (up to 16k points per node, tier-scaled), selectable from the nodes dropdown or ?nodes=.

Each shot below pairs a theme with a node style, so the first ten pictures cover all ten themes and all four styles; the last two show tag grouping and the view from inside a cluster:

Midnight theme, classic spheres
Midnight, classic spheres: cool dark default
Cosmos theme, particle shells
Cosmos, particles: deep space, dense starfield
Gilded theme, starlight nodes
Gilded, starlight: near-black with gold links
Manuscript theme, classic spheres
Manuscript, classic: light parchment
Notebook theme, dodecahedron nodes
Notebook, dodecahedrons: warm beige paper
Dracula theme, particle shells
Dracula, particles: purple-charcoal
Nord theme, starlight nodes
Nord, starlight: arctic slate-blue
Tokyo Night theme, dodecahedron nodes
Tokyo Night, dodecahedrons: deep navy
Gruvbox theme, classic spheres
Gruvbox, classic: retro warm dark
Monokai theme, starlight nodes
Monokai, starlight: classic editor olive
Midnight theme grouped by tag
Group by #tag: your tags drive the legend and colors
Camera inside a cluster, labels faded in
Inside a cluster: labels fade in as you approach

Capabilities

A selected node opens the rendered note in a draggable, resizable reader panel while focus mode dims everything outside its neighborhood:

Reader panel and focus mode

Filters carve the graph down to what you want to see: an ordered list of show / ignore rules matched against titles, tags, and folders by fuzzy text or wildcard. The top rule wins, rows drag to reorder, and the list persists:

Filters panel with show and ignore rules narrowing the graph

Display settings panel
Display settings: live sliders + node-size weighting
View menu
View menu: themes + graphics tiers

Controls

Input Action
Left-drag Rotate
Scroll Zoom
Right-drag Pan
Arrow keys Fly: forward, back, / strafe
Shift+arrows Pan
+ / Zoom
Hover Highlight node + neighbors
Click Select, fly to node, open reader
Double-click / right-click Open the note in Obsidian
/ Focus search (Enter flies to the top hit)
Esc Close modal / menu, then clear selection

The bottom bar carries the everyday toggles (glow, labels, unwritten/orphan nodes, focus depth, group-by, graphics tier, node style, theme); the ⚙ settings panel holds the live sliders; and Help → Keyboard & Mouse Controls lists every input.

Privacy

Everything runs on localhost. Data and files are never copied, indexed, or uploaded.

Stack

TypeScript end to end · 3d-force-graph (three.js/WebGL) · Express 5 · Vite 6 · marked · tsx · Made with Claude Fable 5.

License

MIT. See THIRD_PARTY_LICENSES.md.