Make the repo usable by external users: license, submodule docs, honest platform errors - #8
Merged
Merged
Conversation
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
vendor/tree-sitter core and grammars are git submodules; a plain clone leaves them empty and the build fails at configure with a missing core/lib/src/lib.c. Document the flag and the recovery command. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
cgraph daemon/drain subcommands are launchd-backed end to end; on Linux they silently no-op and the error text told users to check launchctl, which does not exist there. Guard both command groups with a clear platform message and point at the direct alternatives. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Three fixes from an external-user readiness audit, so a fresh clone by someone who isn't the author actually works.
Changes
--recurse-submodules.vendor/tree-sittercore + 11 grammars are git submodules; following the old README verbatim left them empty and configure failed withCannot find source file: core/lib/src/lib.c. Reproduced this exact failure in a fresh worktree before fixing. Also documentsgit submodule update --init --recursivefor existing clones.cgraph daemon/cgraph drain. Both command groups are launchd-backed end to end. On Linux,launchctl_bootstrapsilently returns false and the error said "check launchctl and binary paths" — useless on a platform with no launchctl. Both handlers now exit early on non-Apple with a clear message pointing atgraphd --root PATH(daemon) and running the drain script via cron/systemd timer (drain).Verification
cmake --preset default+ full build — clean.ctest --preset default: 64/64 tests passed (30s).cgraph daemon statusstill lists 13 tracked repos,cgraph drain statusstill reports installed.Session transcript (local, not attached — public repo):
~/.agents/.history/versions/claude/2.1.196/home/.claude/projects/-Users-taylorgagne-tools-cgraph/01e85bdf-bb55-4a02-8df4-2ab883c33b0d.jsonl🤖 Generated with Claude Code