HomeGetting Started

Quick Start

Get Started in 2 Minutes

Install the CLI, scan your project, and give your AI assistant a brain. Everything runs 100% locally — no cloud, no data leaves your machine.

Prerequisites

⬢

Node.js 20+

Required for Tree-sitter native bindings

🐳

Docker

For Neo4j graph database

Setup Steps

Install the CLI

Nomik is distributed as an npm package. Install it globally or use npx.

Global Install

terminal

$ npm install -g @nomik-ai/cli

added 1 package in 4s

$ nomik --version

@nomik-ai/cli v1.0.0

Or use npx (no install)

terminal

$ npx @nomik-ai/cli --version

@nomik-ai/cli v1.0.0

# All commands work with npx:

$ npx @nomik-ai/cli scan ./src

Initialize & Start Neo4j

Run nomik init in your project directory. It creates config files and optionally starts Neo4j via Docker.

terminal

$ nomik init

✔ Created .nomik/config.json

✔ Created docker-compose.yml

✔ Starting Neo4j container...

✔ Neo4j ready at bolt://localhost:7687

💡

Already have Neo4j? Run nomik init --no-docker and point to your existing instance via .nomik/config.json.

Scan Your Codebase

Point Nomik at your project. It parses all supported files and builds the knowledge graph.

terminal

$ nomik scan .

Files discovered 247

Nodes extracted 1,432

Edges resolved 3,891

Graph synced ✓ in 8.2s

Connect Your AI

One command auto-configures your IDE's MCP connection. No manual JSON editing required.

Cursor

cursor

$ nomik setup-cursor

✔ .cursor/mcp.json configured

Windsurf

windsurf

$ nomik setup-windsurf

✔ mcp_config.json configured

Claude Desktop

claude

$ nomik setup-claude

✔ claude_desktop_config configured

ℹ

No server needed. In stdio mode, the IDE launches the MCP server automatically. nomik serve is only for the visualization dashboard.

Ask Your AI Anything

Your AI assistant now has a brain. Ask it architecture questions and get precise, graph-powered answers.

ai-assistant

> "What depends on authenticateUser?"

nm_impact → traversing graph...

POST /api/login (depth: 1, HANDLES)

authGuard (depth: 1, CALLS)

refreshSession (depth: 2, CALLS)

sessions [DBTable] (depth: 1, WRITES_TO)

→ 4 precise dependents — graph-powered, not grep

ℹ

Source code will be open-sourced after the initial launch period. We believe in transparency — the full codebase will be publicly available under a source-available license. During early access, the CLI is free to use with no restrictions.

Resource Requirements

Nomik is lightweight. Here's what to expect for different codebase sizes:

Codebase Size	RAM (Neo4j)	Disk	Scan Time
Small (<10K lines)	~256MB	<100MB	<10s
Medium (10–100K lines)	~512MB	<500MB	<60s
Large (100K–500K lines)	~1GB	<2GB	<5min
Huge (>500K lines)	~2GB	<5GB	<15min

What's Next?

🔌

MCP Tools

Explore all 21 AI tools and what they can do

🏗️

Architecture

Deep dive into how Nomik works under the hood

🧬

Graph Schema

17 node types, 22 edge types, and Cypher queries

← Home

→

Vision