Skip to content

README: make command examples copy-pasteable from repo root - #4

Merged
VrilLabs merged 2 commits into
mainfrom
copilot/apply-corrections
Aug 16, 2026
Merged

README: make command examples copy-pasteable from repo root#4
VrilLabs merged 2 commits into
mainfrom
copilot/apply-corrections

Conversation

Copilot AI commented Aug 16, 2026

Copy link
Copy Markdown

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

  • Introduce $MEMORY in quick-start and workflow blocks so one variable points at the tool path.
  • Replace hardcoded paths with $MEMORY in every shell example.
  • Fix inline env expansion in the contributing checklist (MEMORY=...; $MEMORY selftest instead of a same-line expansion that would resolve before assignment).

Example

# from this repo
MEMORY=skills/memory-system/scripts/memory

$MEMORY --cwd . init
$MEMORY --cwd . write user/edge-tls.md --content "# Edge TLS

Terminate TLS at Envoy.
"
$MEMORY --cwd . search "Envoy TLS"

Copilot AI and others added 2 commits August 16, 2026 06:23
Co-authored-by: VrilLabs <271641621+VrilLabs@users.noreply.github.com>
Co-authored-by: VrilLabs <271641621+VrilLabs@users.noreply.github.com>
@VrilLabs
VrilLabs marked this pull request as ready for review August 16, 2026 06:24
Copilot AI lite review requested due to automatic review settings August 16, 2026 06:24

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 thread README.md
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 \
@VrilLabs
VrilLabs merged commit 11a4eb4 into main Aug 16, 2026
1 check passed
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.

3 participants