docs: clarify vt install from macOS app is script (not symlink)#599
Open
nikolasdehor wants to merge 1 commit intoamantus-ai:mainfrom
Open
docs: clarify vt install from macOS app is script (not symlink)#599nikolasdehor wants to merge 1 commit intoamantus-ai:mainfrom
nikolasdehor wants to merge 1 commit intoamantus-ai:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR fixes a documentation discrepancy reported in issue #592, where the README incorrectly stated that the macOS app creates a symlink for the vt command at /usr/local/bin/vt. The PR updates the documentation to accurately reflect that the macOS app installs (copies) the wrapper script file rather than creating a symlink.
Changes:
- Updated README.md to clarify that the macOS app "Installs the
vtwrapper script at/usr/local/bin/vt" instead of "Creates/usr/local/bin/vtsymlink"
Comments suppressed due to low confidence (1)
README.md:110
- While this documentation update correctly describes the macOS app behavior, there are other files in the codebase that still refer to symlink creation and should be updated for consistency:
docs/deployment.md:21says "vt wrapper script/symlink (convenience command)" which should be clarified to just "vt wrapper script"mac/VibeTunnel/Utilities/CLIInstaller.swift:8-11- The class documentation still says "Service responsible for creating symlinks to command line tools" and "This service creates symlinks from the application bundle's resources to system locations"
These references should be updated to accurately reflect that the macOS app copies the script rather than creating symlinks.
- **macOS App**: Installs the `vt` wrapper script at `/usr/local/bin/vt` during installation
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
Why
Issue #592 reports a mismatch between docs and actual install behavior.
Validation
Closes #592