README: make command examples copy-pasteable from repo root - #4
Merged
Conversation
Co-authored-by: VrilLabs <271641621+VrilLabs@users.noreply.github.com>
Co-authored-by: VrilLabs <271641621+VrilLabs@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
VrilLabs
August 16, 2026 06:24
View session
VrilLabs
marked this pull request as ready for review
August 16, 2026 06:24
There was a problem hiding this comment.
Pull request overview
Updates the root README鈥檚 shell examples to be copy/pasteable regardless of where the memory-system skill is located by introducing a single $MEMORY variable that points to the tool path.
Changes:
- Adds a
MEMORY=...variable in the Quick start / workflow / verify snippets. - Replaces hardcoded
skills/memory-system/scripts/memory ...invocations with$MEMORY .... - Fixes contributing checklist example so the variable assignment happens before the command uses it.
Suppressed comments (3)
README.md:182
- As with the quick-start block, these commands should quote "$MEMORY" when invoking it so paths with spaces remain copy/pasteable.
$MEMORY --cwd . root
$MEMORY --cwd . glob "user/**/*.md"
$MEMORY --cwd . read user/MEMORY.md
$MEMORY --cwd . search "edge proxy"
README.md:297
- In the inline contributing command, quote "$MEMORY" when invoking it so the example still works if MEMORY points at a path with spaces.
3. Run `MEMORY=skills/memory-system/scripts/memory; $MEMORY selftest` before proposing changes that touch the tool or ledger
README.md:274
- Quote "$MEMORY" when invoking it to keep the verify command robust if MEMORY is set to a path containing spaces.
$MEMORY selftest
馃挕 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+157
to
+159
| $MEMORY --cwd . init | ||
|
|
||
| skills/memory-system/scripts/memory --cwd . write user/edge-tls.md \ | ||
| $MEMORY --cwd . write user/edge-tls.md \ |
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
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.
PR #2 review noted that the new root README hardcodes
skills/memory-system/scripts/memory, which breaks copy/paste for anyone using an installed skill path or reading from a different layout.Changes
$MEMORYin quick-start and workflow blocks so one variable points at the tool path.$MEMORYin every shell example.MEMORY=...; $MEMORY selftestinstead of a same-line expansion that would resolve before assignment).Example