Add native Windows installer and documentation - #8
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughThis PR adds a checksum-verifying native Windows PowerShell installer, redirects Windows users from Bash installers, documents Windows npm and MCP usage, and updates installation, update, troubleshooting, metadata, and network-access guidance. ChangesWindows support
Estimated code review effort: 3 (Moderate) | ~25 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
@coderabbitai review |
✅ Action performedReview finished.
|
![chatgpt-codex-connector[bot]](https://cdn.github.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: e306c830e5
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
![coderabbitai[bot]](https://cdn.github.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
install/install.ps1 (1)
101-104: 🩺 Stability & Availability | 🔵 Trivial | ⚡ Quick winHandle in-use binary replacements on Windows.
If
codedb.exeis currently running (e.g., as a background MCP server),Move-Item -Forcewill fail with a file-in-use error because Windows locks executing binaries.To allow seamless updates without requiring the user to stop the process first, you can leverage the fact that Windows allows renaming a running executable:
♻️ Proposed fix
Copy-Item -LiteralPath $downloadedBinary -Destination $stagedPath -Force Unblock-File -LiteralPath $stagedPath -ErrorAction SilentlyContinue + if (Test-Path -LiteralPath $targetPath) { + Move-Item -LiteralPath $targetPath -Destination "$targetPath.old" -Force -ErrorAction SilentlyContinue + } Move-Item -LiteralPath $stagedPath -Destination $targetPath -Force🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@install/install.ps1` around lines 101 - 104, Update the installation replacement flow around Copy-Item, Unblock-File, and Move-Item so replacing a running codedb.exe succeeds on Windows. Use a rename-based replacement strategy that leverages Windows’ ability to rename an executing binary, while preserving the existing staging and overwrite behavior for normal installations.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@npm/README.md`:
- Around line 73-90: Update the root README reference in the Windows support
section to use the repository’s absolute GitHub URL with the existing `#windows`
anchor, replacing the relative ../README.md link while preserving the
surrounding instructions.
---
Nitpick comments:
In `@install/install.ps1`:
- Around line 101-104: Update the installation replacement flow around
Copy-Item, Unblock-File, and Move-Item so replacing a running codedb.exe
succeeds on Windows. Use a rename-based replacement strategy that leverages
Windows’ ability to rename an executing binary, while preserving the existing
staging and overwrite behavior for normal installations.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: ab78c4b9-92cc-492e-8773-2f159bea83de
⛔ Files ignored due to path filters (3)
website/dist/install.shis excluded by!**/dist/**website/dist/privacy.htmlis excluded by!**/dist/**website/dist/quickstart.htmlis excluded by!**/dist/**
📒 Files selected for processing (9)
README.mddocs/mcp.mdinstall/install.ps1install/install.shnpm/README.mdwebsite/app/install_script.shwebsite/app/layout.zigwebsite/app/privacy.zigwebsite/app/quickstart.zig
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: a0cf745d82
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
@codex review |
|
Codex Review: Didn't find any major issues. Keep it up! Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
|
@coderabbitai review |
✅ Action performedReview finished.
|
716435d to
d321e16
Compare
|
👋 Thanks for the contribution! Quick heads-up: this repo lands changes on the current Please retarget this PR via Edit → base branch to the active (Automated hint — reply here if you need a hand.) |
d321e16 to
716435d
Compare
1 participant
Summary
Why
codedb now publishes
codedb-windows-x86_64.exe, but the primary installation documentation still described codedb as macOS/Linux-only or directed Windows users to WSL. This made the shipped native binary difficult to discover and install safely.Validation
0.2.5830, verified SHA256, installed, and returnedcodedb 0.2.5830irm ... | iexexecution shape validated against the checked-out installercodedeebee0.2.5830 package installed and ran the Windows binarygit diff --checkpassedNotes
latesttag was still 0.2.5823 during validation, so the root README does not yet recommend npm for Windows.website/distoutputs are updated alongside their website sources.Summary by CodeRabbit