fix: update outdated graphify CLI commands in setup guide#6
Conversation
…ME.md and README.pt-BR.md
|
Thanks for catching this — the subcommand-only CLI issue is real and well-documented Two clarifications before merge:
Otherwise the LLM API key step, the |
Summary
Every
graphifycommand shown in the setup guide is verified againstgraphify --helpfrom the currentgraphifyyPyPI build. The CLI now uses subcommands before the path (e.g.graphify extract <path>,graphify watch <path>,graphify update <path>); the oldgraphify . --flagstyle and the--obsidian/--obsidian-dir/--mode deepflags no longer exist, so following the README as-is fails immediately.Fixes (each cross-checked against
graphify --help)graphify . --obsidian --obsidian-dir <vault>→graphify extract . --out ./graphify-out.extractis the documented headless extraction command; the--obsidian*flags are not in--help.graphify . --watch→graphify watch ..--helplistswatch <path>as a subcommand, not a flag.graphify . --update→graphify update .. Same pattern:update <path>is a subcommand.graphify explainandgraphify pathrows from--help. Removed the--mode deeprow — that flag does not exist; semantic extraction runs automatically when an LLM API key is set.graphify extracterrors out with "no LLM API key found" otherwise. The step also documents--no-clusterfor users who want to skip LLM costs entirely.graphify install→graphify install --platform claude.--helpshowsinstall [--platform P]with supported platformsclaude|cursor|codex|opencode|...; baregraphify installno longer works.wiki/and the auto-generated Obsidian notes folder (the current CLI emits neither). Added a note explaining how to symlinkgraphify-outinto a vault for manual Obsidian integration.graphify treestep for generatingGRAPH_TREE.html. The interactive visualization is no longer produced byextract— it's a separatetreesubcommand per--help.Two troubleshooting tips that referenced
--mode deepandgraphify update . --obsidian-dirwere updated to current commands as well, so the rule "every command in the guide appears ingraphify --help" holds end-to-end.All changes mirrored in
README.pt-BR.mdwith Portuguese translations. Conceptual sections, architecture diagrams, the Obsidian setup walkthrough, and the chat import pipeline were left untouched per the scope of this PR.Test plan
graphify --helplists every subcommand referenced in the updated README (install --platform,extract,update,watch,tree,query,explain,path)graphify extract . --out ./graphify-outon a sample repo and confirmgraphify-out/graph.json,GRAPH_REPORT.md, andcache/are producedgraphify tree --graph ./graphify-out/graph.json --output ./graphify-out/GRAPH_TREE.htmland open the HTML in a browsergraphify install --platform claudeand confirm~/.claude/skills/graphify/SKILL.mdexistsREADME.pt-BR.mdfor parity with the English changes