docs: document image updates in quickstart READMEs and CLI connect message#295
Merged
Conversation
…ssage Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
There was a problem hiding this comment.
Hey - I've found 1 issue
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path="cli/src/messages.ts" line_range="108-112" />
<code_context>
+// Compose does not pull new images on `up` — without this hint users stay
+// on the image from init day forever while believing they track releases.
+const updateGuidance = (targetDir: string): string =>
+ `Update to the latest release:
+ cd ${targetDir} && docker compose pull && docker compose up -d`
+
</code_context>
<issue_to_address>
**suggestion:** Consider quoting targetDir in the composed shell command to handle paths with spaces or special characters.
Because this string is meant to be copy‑pasted into a shell, unquoted `${targetDir}` will fail for directories with spaces or special characters. Wrapping it in double quotes (e.g. `cd "${targetDir}" && docker compose pull && docker compose up -d`) makes the hint work reliably for all valid paths.
```suggestion
// Compose does not pull new images on `up` — without this hint users stay
// on the image from init day forever while believing they track releases.
const updateGuidance = (targetDir: string): string =>
`Update to the latest release:
cd "${targetDir}" && docker compose pull && docker compose up -d`
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Both composeUpCommand and updateGuidance — paths with spaces or special characters would break the pasted command. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
PR Code Suggestions ✨No code suggestions found for the PR. |
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.
Problem
Compose does not pull new images on
up— once:latest/:remoteis present locally, a deployment stays on that exact image until something explicitly pulls. Nothing in the quickstart READMEs or the CLI's connect output told users this or gave them the update command, sonpx vault-cortex initusers silently stay on init-day images while floating tags suggest they track releases.Changes
deploy/local/README.md— new "Updating" section:docker compose pull && docker compose up -d, the no-auto-pull caveat, and the index-persists/warm-restart reassurance.deploy/remote/README.md— same section, plus the volume-persistence guarantees (synced vault, index, Obsidian login state carry over — no re-sync, no device re-registration) and the plain-docker runvariant (pull →rm -f→ re-run), matching that README's existing no-Compose path.cli/src/messages.ts— sharedupdateGuidanceblock appended to the Settings section of both connect messages:Update to the latest release: cd <dir> && docker compose pull && docker compose up -d.cli/src/__tests__/messages.test.ts— 2 new tests (local + remote) asserting the update line and command; mutation-checked (both fail with the messages.ts change reverted).1589 tests pass. Docs + one user-facing CLI string; no behavior changes.
🤖 Generated with Claude Code