Skip to content

Installation SOP

Fresh

Overview

This SOP covers the complete installation of Graphify on any supported platform — from Python dependency setup through first-run verification.

Requirements Checklist

  • [ ] Python 3.10 or higher installed (python3 --version)
  • [ ] pip available (pip --version)
  • [ ] At least one supported AI coding assistant installed

Step 1: Install the Python Package

bash
pip install graphifyy

Package Name

The PyPI package is graphifyy (double-y). The CLI command you use after install is graphify (no double-y).

Verify the install:

bash
graphify --version

Step 2: Install the Skill into Your Assistant

Claude Code

bash
graphify install

Or manually:

bash
graphify claude install

This writes two things:

  1. A CLAUDE.md directive telling Claude to consult the knowledge graph
  2. A PreToolUse hook that fires before every file-search tool call

Codex / OpenCode

bash
graphify install --platform codex
# or
graphify codex install

Cursor

bash
graphify cursor install

Writes rules to .cursor/rules/.

GitHub Copilot CLI

bash
graphify install --platform copilot

VS Code Copilot Chat

bash
graphify vscode install

Aider

bash
graphify install --platform aider

Gemini CLI

bash
graphify gemini install

Manual Setup (any platform)

Download SKILL.md from the repository and place it at:

~/.claude/skills/graphify/SKILL.md

Then register it in ~/.claude/CLAUDE.md:

- **graphify** (`~/.claude/skills/graphify/SKILL.md`) - any input to knowledge graph

Step 3: Verify Installation

Run a quick test on a small directory:

bash
mkdir /tmp/graphify-test
echo "# Test\nThis is a test file." > /tmp/graphify-test/README.md
/graphify /tmp/graphify-test

Expected output:

graphify-out/
├── graph.html
├── GRAPH_REPORT.md
├── graph.json
└── cache/

Step 4: Open the Visualization

bash
open graphify-out/graph.html     # macOS
start graphify-out/graph.html    # Windows
xdg-open graphify-out/graph.html # Linux

Uninstalling Platform Hooks

bash
graphify claude uninstall
graphify codex uninstall
graphify cursor uninstall
graphify gemini uninstall

Troubleshooting Installation

command not found: graphify

Run pip show graphifyy to confirm the package installed. If it shows, your pip bin directory may not be on PATH. Try python3 -m graphify --version.

Python Version Error

Graphify requires Python 3.10+. Check with python3 --version. If you have multiple Python versions, use pip3.11 install graphifyy to target the correct one.