Getting Started

Everything you need to install Graphify, build your first knowledge graph, and run your first query.

📖 Documentation in This Section

• Setup Guide - Complete installation and configuration
• First Query - Your first architecture question
• Verification - Confirm everything works

🎯 Prerequisites

• Python 3.10+ - Required for Graphify
• uv - Package manager (or pip)
• ~2 GB disk space - For the local LLM model
• Optional: LLM API key - For semantic doc/markdown extraction (Gemini, OpenAI, Anthropic, etc.)

⚡ Quick Path

 1# 1. Install Graphify
 2uv tool install graphifyy && graphify install
 3
 4# 2. Build code-only graph (no API key needed)
 5cd your-project
 6mkdir -p graphify-out && touch graphify-out/.graphify-activity
 7graphify . --code-only
 8
 9# 3. Run your first query
10mkdir -p graphify-out && touch graphify-out/.graphify-activity
11graphify query "project overview"

📋 What Gets Installed

Via uv tool install graphifyy:

• graphify - Main CLI
• graphify-mcp - MCP server for IDE integration
• Local LLM model (~2 GB, downloaded on first graphify install)

Python dependencies (auto-installed):

• tree-sitter-* - AST parsers for 20+ languages
• networkx - Graph algorithms
• sentence-transformers - Local embeddings
• llama-cpp-python - Local LLM inference

🔑 Optional: API Key for Full Graph

For semantic extraction of markdown, docs, PDFs, and images:

1# Option 1: Environment variable (recommended)
2export GEMINI_API_KEY="your-key"
3# or
4export OPENAI_API_KEY="your-key"
5# or
6export ANTHROPIC_API_KEY="your-key"
7
8# Option 2: .env file in project root
9echo "GEMINI_API_KEY=your-key" > .env

Then run without --code-only:

1graphify .   # full graph with semantic doc extraction

🛠️ One-Time Machine Setup

1mkdir -p ~/.graphify-stats && touch ~/.graphify-stats/configured

Enables persistent activity tracking across sessions.

✅ Verification

1# Check installation
2graphify --version
3
4# Check model
5graphify install  # re-runs if needed, idempotent
6
7# Check graph (after building)
8ls -lh graphify-out/graph.json
9# Should be > 500 KB for non-empty repos

📚 Next Steps

Once set up, proceed to:

• First Query - Run your first architecture question
• Daily Usage - Common query patterns
• Code vs Full Graph - Understanding the difference

🎉 Summary

Before First Use

• ❌ No knowledge graph
• ❌ Manual code exploration
• ❌ Grep/find for dependencies

After Setup

• ✅ Local knowledge graph (4797 nodes in this project)
• ✅ Natural language architecture queries
• ✅ Dependency tracing between any two components
• ✅ Visual graph exploration in browser
• ✅ Zero cost per query

You’re ready to query! 🚀

In this section

• Setup Guide
  Complete installation and configuration guide for Graphify.
• First Query
  Run your first Graphify architecture query and understand the output.
• Verification
  Verify your Graphify installation and graph are working correctly.