Skip to content

chore: gitignore graphify output and document graphify usage in CLAUDE.md #1689

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MrDirkelz wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: gitignore graphify output and document graphify usage in CLAUDE.md #1689

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,9 @@ node_modules
*.bkp

stats.html

# graphify knowledge-graph output (generated locally via `graphify`; not committed for now)
graphify-out/

# Claude Code agent worktrees (transient; must never be committed)
.claude/worktrees/
13 changes: 13 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,19 @@ Luminary is an offline-first content platform. The repo is a monorepo with no ro

**Always read the relevant subpackage's `CLAUDE.md` before working there.** This file only covers cross-package concerns.

## Knowledge graph (graphify)

**Only applies if graphify is installed** — i.e. the `graphify` CLI is on PATH (`command -v graphify` succeeds) and `graphify-out/graph.json` exists. If graphify is **not** installed, ignore this section and answer codebase questions with the normal tools (grep, file reads, subpackage `CLAUDE.md`s); do not attempt any `graphify` command.

When graphify is installed:

- For codebase questions, run `graphify query "<question>"` first. Use `graphify path "<A>" "<B>"` for relationships and `graphify explain "<concept>"` for focused concepts. These return a scoped subgraph, usually much smaller than `graphify-out/GRAPH_REPORT.md` or raw grep output.
- If `graphify-out/wiki/index.md` exists, use it for broad navigation instead of raw source browsing.
- Read `graphify-out/GRAPH_REPORT.md` only for broad architecture review or when query/path/explain don't surface enough context.
- After modifying code, run `graphify update .` to keep the graph current (AST-only, no API cost).

The `graphify-out/` directory is git-ignored — it's a local, generated artifact, not committed.

## Local setup

The wizard `./scripts/automate-luminary.sh setup` provisions CouchDB + MinIO containers, writes `.env` files, and installs in the correct order. For manual installs, the order matters:
Expand Down