Skip to content

docs: document image updates in quickstart READMEs and CLI connect message#295

Merged
aliasunder merged 2 commits into
mainfrom
docs-image-update-instructions
Jul 9, 2026
Merged

docs: document image updates in quickstart READMEs and CLI connect message#295
aliasunder merged 2 commits into
mainfrom
docs-image-update-instructions

Conversation

@aliasunder

Copy link
Copy Markdown
Owner

Problem

Compose does not pull new images on up — once :latest / :remote is 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, so npx vault-cortex init users 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 run variant (pull → rm -f → re-run), matching that README's existing no-Compose path.
  • cli/src/messages.ts — shared updateGuidance block 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

…ssage

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

@sourcery-ai sourcery-ai Bot 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.

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>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread cli/src/messages.ts Outdated
Both composeUpCommand and updateGuidance — paths with spaces or special
characters would break the pasted command.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@aliasunder aliasunder merged commit 80046a1 into main Jul 9, 2026
16 checks passed
@aliasunder aliasunder deleted the docs-image-update-instructions branch July 9, 2026 23:51
@umm-actually

umm-actually Bot commented Jul 9, 2026

Copy link
Copy Markdown

PR Code Suggestions ✨

No code suggestions found for the PR.

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.

1 participant