install_cli: Show notification instead of failing CLI install (#59575)
Some checks are pending
Congratsbot / check-author (push) Waiting to run
Congratsbot / congrats (push) Blocked by required conditions
deploy_nightly_docs / deploy_docs (push) Waiting to run
run_tests / orchestrate (push) Waiting to run
run_tests / check_style (push) Waiting to run
run_tests / clippy_windows (push) Blocked by required conditions
run_tests / clippy_linux (push) Blocked by required conditions
run_tests / clippy_mac (push) Blocked by required conditions
run_tests / clippy_mac_x86_64 (push) Blocked by required conditions
run_tests / run_tests_windows (push) Blocked by required conditions
run_tests / run_tests_linux (push) Blocked by required conditions
run_tests / run_tests_mac (push) Blocked by required conditions
run_tests / miri_scheduler (push) Blocked by required conditions
run_tests / doctests (push) Blocked by required conditions
run_tests / check_workspace_binaries (push) Blocked by required conditions
run_tests / build_visual_tests_binary (push) Blocked by required conditions
run_tests / check_wasm (push) Blocked by required conditions
run_tests / check_dependencies (push) Blocked by required conditions
run_tests / check_docs (push) Blocked by required conditions
run_tests / check_licenses (push) Blocked by required conditions
run_tests / check_scripts (push) Blocked by required conditions
run_tests / check_postgres_and_protobuf_migrations (push) Blocked by required conditions
run_tests / extension_tests (push) Blocked by required conditions
run_tests / tests_pass (push) Blocked by required conditions

Closes #10065
Closes #42293

Release Notes:

- Improved error handling and documentation when Zed cannot install the
CLI on macOS
This commit is contained in:
Conrad Irwin 2026-06-22 12:20:57 -06:00 committed by GitHub
parent 8f438e6612
commit 39bba3c7ec
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 88 additions and 17 deletions

View file

@ -104,6 +104,32 @@ If the `zed` command isn't available after installation:
2. Try reinstalling the CLI via {#action cli::InstallCliBinary} in the command palette
3. Open a new terminal window to reload your PATH
### Can't install CLI {#cant-install-cli}
{#action cli::InstallCliBinary} writes a `zed` symlink to `/usr/local/bin`, which requires administrator privileges. If your macOS account isn't in the `admin` group, Zed can't create that symlink and will report that it can't install the CLI automatically.
Instead, you can add an alias pointing to the `cli` binary bundled inside the app. The path depends on where Zed is installed:
```sh
# Default install (Zed in /Applications)
alias zed="/Applications/Zed.app/Contents/MacOS/cli"
# User install (Zed in ~/Applications)
alias zed="$HOME/Applications/Zed.app/Contents/MacOS/cli"
# Preview build (Zed Preview in ~/Applications)
alias zed="$HOME/Applications/Zed Preview.app/Contents/MacOS/cli"
```
Add the line that matches your install to your shell configuration file. Use `~/.zshrc` for Zsh (the default on modern macOS) or `~/.bashrc` for Bash.
After you restart your shell, you will be able to use `zed` from your terminal:
```sh
zed . # Open current folder
zed file.txt # Open a file
```
### GPU or rendering issues
Zed uses Metal for rendering. If you experience graphical glitches: