Skip to content

docs: clarify vt install from macOS app is script (not symlink)#599

Open
nikolasdehor wants to merge 1 commit intoamantus-ai:mainfrom
nikolasdehor:fix/readme-vt-installation-wording
Open

docs: clarify vt install from macOS app is script (not symlink)#599
nikolasdehor wants to merge 1 commit intoamantus-ai:mainfrom
nikolasdehor:fix/readme-vt-installation-wording

Conversation

@nikolasdehor
Copy link
Copy Markdown

Summary

  • Fix README wording that said the macOS app creates a symlink at /usr/local/bin/vt
  • Clarify that the macOS app installs the vt wrapper script at /usr/local/bin/vt

Why

Issue #592 reports a mismatch between docs and actual install behavior.

Validation

  • Checked implementation in mac/VibeTunnel/Utilities/CLIInstaller.swift (uses cp + chmod, not symlink creation)

Closes #592

Copilot AI review requested due to automatic review settings February 23, 2026 01:38
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 vt wrapper script at /usr/local/bin/vt" instead of "Creates /usr/local/bin/vt symlink"
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:
  1. docs/deployment.md:21 says "vt wrapper script/symlink (convenience command)" which should be clarified to just "vt wrapper script"
  2. 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.

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.

Documentation/README says symlink is created on macOS, but it's the script itself

2 participants