Update installation.mdx
Resolving zsh: command not found for Wails on macOS
Description
This PR addresses the issue of the zsh: command not found error that occurs when running the wails command on macOS. This error is typically caused by the Wails binary being located in the ~/go/bin directory, which is not included in the system's PATH.
The changes include instructions on how to resolve this issue by either copying the wails binary to a directory that is in the PATH or updating the ~/.zshrc file to include an alias for the wails command.
Fixes # 2046 https://github.com/wailsapp/wails/issues/2046
Type of change
Please delete options that are not relevant.
- [X ] This change requires a documentation update
How Has This Been Tested?
- [X ] macOS
Test Configuration
Wails
Version | v2.9.1
System
┌────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ | OS | MacOS | | Version | 14.3 | | ID | 23D56 | | Go Version | go1.22.5 | | Platform | darwin | | Architecture | amd64 | | CPU | Intel(R) Core(TM) i5-8259U CPU @ 2.30GHz | | GPU | Chipset Model: Intel Iris Plus Graphics 655 Type: GPU Bus: Built-In VRAM (Dynamic, Max): 1536 MB Vendor: Intel Device ID: 0x3ea5 Revision ID: 0x0001 Metal Support: Metal 3 | | Memory | 16GB | └────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
Dependencies
┌──────────────────────────────────────────────────────────────────────┐ | Dependency | Package Name | Status | Version | | Xcode command line tools | N/A | Installed | 2405 | | Nodejs | N/A | Installed | 21.3.0 | | npm | N/A | Installed | 10.2.4 | | *Xcode | N/A | Installed | 15.4 (15F31d) | | *upx | N/A | Available | | | *nsis | N/A | Available | | └────────────────────── * - Optional Dependency ───────────────────────┘
Diagnosis
Optional package(s) installation details:
- upx : Available at https://upx.github.io/
- nsis : More info at https://wails.io/docs/guides/windows-installer/
SUCCESS Your system is ready for Wails development!
♥ If Wails is useful to you or your company, please consider sponsoring the project:
Checklist:
- [X ] I have made corresponding changes to the documentation
- [X ] My changes generate no new warnings
Summary by CodeRabbit
-
New Features
- Enhanced installation instructions for macOS users to resolve the
zsh: command not founderror related to thewailscommand.- Added solutions for updating the
PATHand creating an alias in the~/.zshrcfile.
- Added solutions for updating the
- Enhanced installation instructions for macOS users to resolve the
Walkthrough
The recent update enhances guidance for macOS users facing the zsh: command not found error when executing the wails command. It provides two effective solutions: moving the wails binary to a directory in the user's PATH or adding an alias in the user's ~/.zshrc file. These changes streamline the installation process, offering clearer steps for resolving command accessibility issues.
Changes
| Files | Change Summary |
|---|---|
website/versioned_docs/version-v2.9.0/gettingstarted/installation.mdx |
Added instructions for macOS users on resolving the wails command error by suggesting binary relocation or alias creation in ~/.zshrc. |
Poem
In the land of code where rabbits play,
A new guide emerges, brightening the way.
Withwailsnow found, no more dismay,
Just hop to install, and work without delay! 🐇✨
Binary paths clear, like a sunny day!
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Tips
Chat
There are 3 ways to chat with CodeRabbit:
- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
-
I pushed a fix in commit <commit_id>. -
Generate unit testing code for this file. -
Open a follow-up GitHub issue for this discussion.
-
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:-
@coderabbitai generate unit testing code for this file. -
@coderabbitai modularize this function.
-
- PR comments: Tag
@coderabbitaiin a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:-
@coderabbitai generate interesting stats about this repository and render them as a table. -
@coderabbitai show all the console.log statements in this repository. -
@coderabbitai read src/utils.ts and generate unit testing code. -
@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format. -
@coderabbitai help me debug CodeRabbit configuration file.
-
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.
CodeRabbit Commands (invoked as PR comments)
-
@coderabbitai pauseto pause the reviews on a PR. -
@coderabbitai resumeto resume the paused reviews. -
@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository. -
@coderabbitai full reviewto do a full review from scratch and review all the files again. -
@coderabbitai summaryto regenerate the summary of the PR. -
@coderabbitai resolveresolve all the CodeRabbit review comments. -
@coderabbitai configurationto show the current CodeRabbit configuration for the repository. -
@coderabbitai helpto get help.
Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile to the root of your repository. - Please see the configuration documentation for more information.
- If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation:
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
Documentation and Community
- Visit our Documentation for detailed information on how to use CodeRabbit.
- Join our Discord Community to get help, request features, and share feedback.
- Follow us on X/Twitter for updates and announcements.
Thanks for taking the time to open this. According to the official Go docs, the installer should already update the PATH environment variable. The ~/go/bin path isn't Wails specific (Go decides where to put the binary), so I'm wondering how this doesn't work out of the box (homebrew?).
I think you should add the bin subdir in the GOPATH (default is ~/go/bin/) to the PATH, rather than copying these files to /usr/local
export GOPATH=/path/to/go #default is ~/go
export PATH=$GOPATH/bin:$PATH
#export GOROOT=$(go env GOROOT 2>/dev/null)
Closing for now as this is a Go setup issue.