Skip to content

MIGRATION.md

Latest commit

 

History

History
66 lines (45 loc) · 2.36 KB

MIGRATION.md

File metadata and controls

66 lines (45 loc) · 2.36 KB
Raw

Migrate from Graphify to Compass

Compass uses its own executable, output directory, environment variable, and sidecars. The first public release makes a clean break from Graphify compatibility paths.

Install Compass

Install the latest macOS release:

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/crabbuild/compass/releases/latest/download/install.sh | sh

The release contains only the compass executable. It doesn't install graphify or graphify-mcp compatibility entry points.

Rebuild project output

Compass doesn't read graphify-out/ or GRAPHIFY_OUT. Run a new build to create compass-out/:

cd your_project_directory
compass update .

Set COMPASS_OUT before running Compass when you need a custom output directory.

Rename repository and user configuration before the first build:

.graphifyignore                  -> .compassignore
~/.graphify/providers.json       -> ~/.compass/providers.json
GRAPHIFY_*                       -> COMPASS_*
merge.graphify.*                 -> merge.compass.*
graphify://... MCP resources     -> compass://...

Compass does not fall back to the old names.

Regenerate HTML graph exports

Current Compass releases use the shared graph workbench for graph.html and do not preserve the previous export's DOM, CSS selectors, or remote vis-network script boundary. Regenerate saved HTML exports with the current compass export html command. Any private CSS overrides or browser automation that targeted the old document structure must be updated to use visible roles and labels in the new workbench.

The matching VS Code extension requires a CLI that advertises both graph and community_detail. Upgrade Compass and the extension together; the extension does not fall back to the older non-drill-down graph workflow.

Replace commands

Replace Python and legacy executable invocations with compass:

graphify <command>       -> compass <command>
python -m graphify ...  -> compass ...

Compass exposes its Model Context Protocol server through compass serve. Reinstall assistant integrations so generated hooks and instructions invoke compass:

compass install --platform codex --project

Keep the old Graphify installation and graphify-out/ directory until the new compass-out/ graph has passed your project checks. The two tools don't share runtime output paths.