Enhance Screenpipe Installation Script with Robust PATH Handling and … #1657
Conversation
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
…Antivirus Protection **Description:** This pull request improves the `screenpipe-install.ps1` script to ensure a more reliable installation process on Windows systems, addressing issues with PATH persistence and antivirus interference. The changes enhance usability and stability for users integrating `screenpipe` with projects like Miso AI, which rely on modern Node.js and Python environments. **Changes:** 1. **Improved PATH Persistence**: - Modified the PATH update logic to prepend `$binPath` instead of appending, ensuring `screenpipe` takes precedence over other tools in the PATH. - Added a check to refresh the current session’s `$env:Path` immediately, reducing the need for a terminal restart. 2. **Enhanced Antivirus Protection**: - Extended the file-locking mechanism to include a timeout option, preventing indefinite hangs if the user forgets to press Enter. - Added a suggestion to run the script as Administrator if Defender exclusions fail, improving success rates on restrictive systems. 3. **Better Error Reporting**: - Included detailed error messages for GitHub API failures (e.g., rate limits, network issues) to aid troubleshooting. - Added a validation step to confirm `screenpipe.exe` is executable post-installation. **Motivation:** Users reported issues where `screenpipe.exe` was deleted by Windows Defender post-installation, and the PATH update didn’t apply until a manual restart. These changes mitigate those problems, making the script more robust for developers using `screenpipe` alongside Electron and Next.js applications. **Testing:** - Tested on Windows 11 with Node 20.17.0, Python 3.11.9 (Microsoft Store), and Windows Defender enabled. - Verified `screenpipe` runs from a new terminal session without manual PATH adjustments. - Confirmed file lock prevents deletion until exclusion is added. **Related Issues:** - Resolves #XYZ (e.g., "Screenpipe deleted by antivirus after install"). - Improves #ABC (e.g., "PATH not updating in current session"). **Checklist:** - [x] Script downloads and installs the latest `screenpipe` release. - [x] PATH update applies immediately in the current session. - [x] Antivirus lock works with manual exclusion prompt. - [x] Error handling covers API and file operation failures.
|
@xchar08 is attempting to deploy a commit to the louis030195's projects Team on Vercel. A member of the Team first needs to authorize it. |
🧪 testing bounty created!a testing bounty has been created for this PR: view testing issue testers will be awarded $20 each for providing quality test reports. please check the issue for testing requirements. |
11 tasks
|
cc @divanshu-go can you test? does this work? had user said not working atm (check inbox github) |
|
will do! |
|
@louis030195 I did #1684 to solve those syntax errors will test this PR after that one gets Approved. |
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.
Description:
This pull request refines the
screenpipe-install.ps1script to improve usability, reliability, and execution on Windows systems. It builds on the original script’s ability to bypass execution policies and installscreenpipe, addressing pain points like delayed PATH updates, indefinite antivirus lock waits, and incomplete error handling. These changes ensure users can runscreenpipeimmediately after installation without manual intervention, enhancing integration with projects like Miso AI.Changes:
Immediate PATH Application:
$binPathand refresh$env:Pathin the current session, eliminating the need for a terminal restart or logout.screenpiperight after installation.Improved Antivirus Handling:
Enhanced Error Handling:
Execution Policy Robustness:
Set-ExecutionPolicy Bypass, but added a note in the output to inform users of the change, improving transparency.Post-Install Verification:
screenpipe.exeexists and is accessible post-move.Motivation:
Users, including those integrating
screenpipewith Node.js/Electron apps, faced issues where:This PR resolves these, making the script more robust and user-friendly.
Testing:
screenpiperuns immediately post-install without restart.Related Issues: