Skip to content

docs: fix global add example#1489

Closed
MikeKatsoulakis wants to merge 1 commit into
Graphify-Labs:v8from
MikeKatsoulakis:docs-readme-global-add-as
Closed

docs: fix global add example#1489
MikeKatsoulakis wants to merge 1 commit into
Graphify-Labs:v8from
MikeKatsoulakis:docs-readme-global-add-as

Conversation

@MikeKatsoulakis

Copy link
Copy Markdown
Contributor

What

While trying the README example for adding a graph to the global graph, I noticed the documented command does not actually name the repo as shown:

graphify global add graphify-out/graph.json myrepo

The CLI expects the repo name through --as, so this updates the example to:

graphify global add graphify-out/graph.json --as myrepo

This also updates the comment on that line to use the actual global graph path, ~/.graphify/global-graph.json.

Why

I ran into this because the README made it look like myrepo could be passed as a positional argument, but the CLI ignores that extra positional value and falls back to its default repo tag. Using --as myrepo matches the CLI help and records the intended name.

Tests

Not run. This is a README-only change.

safishamsi pushed a commit that referenced this pull request Jun 27, 2026
The README showed `global add graph.json myrepo` (positional tag) writing to
`~/.graphify/global.json`. The real CLI takes the tag via `--as` (the positional
was silently ignored) and the file is `~/.graphify/global-graph.json`. Corrected
to `global add graph.json --as myrepo`.

Ported from PR #1489 by @MikeKatsoulakis.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@safishamsi

Copy link
Copy Markdown
Collaborator

Thanks @MikeKatsoulakis — verified against the code: the CLI takes the tag via --as (the positional was silently ignored) and the file is ~/.graphify/global-graph.json, so the old example was wrong on both counts. Landed on v8 in 1225677 with your authorship. Closing as merged-by-port.

@safishamsi safishamsi closed this Jun 27, 2026
safishamsi added a commit that referenced this pull request Jun 28, 2026
Dates the 0.8.51 CHANGELOG and bumps the version. Highlights: Obsidian export no
longer overwrites user notes / .obsidian config in an existing vault (#1506);
cross-file node-ID cluster fixes — C# resolver (#1466), Go sourceless stubs
(#1500), import-stub disambiguation (#1462); Java enum/annotation type nodes
(#1512) + generic parents (#1510); explain/affected source-file path lookup
(#1503); claude-cli Windows GBK fix (#1505); macOS install docs (#1471) and the
global-add docs fix (#1489).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants