vrr/zed
2
0
Fork 0
mirror of https://github.com/zed-industries/zed.git synced 2026-05-31 04:54:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8
zed/docs/src/macos.md
Katie Geer ece66be3df
docs: Big reorganize (#45276) 
Release Notes:

- N/A 

Overview

Restructures the documentation navigation to be organized by user goals
rather than feature lists. Introduces a new "Working with Code" section
and reorganizes existing content into clearer groupings.

### Navigation Changes

**New top-level sections:**
- **Working with Code** — Groups editing, navigation, and execution
features by workflow
- **Reference** — Dedicated section for lookup-only content (settings,
actions, CLI)
- **Coming From...** — Migration guides grouped together

**Reorganized sections:**
- **Customization** — Renamed from "Configuration," focused on
appearance and keybindings
- **Account & Privacy** — Consolidated auth, privacy, and telemetry
pages

New Files

| File | Purpose |
|------|---------|
| `editing-code.md` | Overview page for editing features |
| `finding-navigating.md` | Overview page for navigation tools with
quick reference |
| `running-testing.md` | Overview page for tasks, debugger, and REPL |
| `reference/all-settings.md` | Settings reference (moved/renamed) |
| `reference/cli.md` | CLI reference (moved) |

### Content Moves

| Page | From | To |
|------|------|-----|
| Snippets | Customization | Working with Code → Editing Code |
| Code Completions | (flat) | Working with Code → Editing Code |
| Diagnostics | (flat) | Working with Code → Editing Code |
| Multibuffers | (flat) | Working with Code → Editing Code |
| Command Palette | (flat) | Working with Code → Finding & Navigating |
| Outline Panel | (flat) | Working with Code → Finding & Navigating |
| Tab Switcher | (flat) | Working with Code → Finding & Navigating |
| Tasks | (flat) | Working with Code → Running & Testing |
| Debugger | (flat) | Working with Code → Running & Testing |
| REPL | (flat) | Working with Code → Running & Testing |
| All Settings | Configuration | Reference |
| CLI | (various) | Reference

---------

Co-authored-by: Marshall Bowers <git@maxdeviant.com>
Co-authored-by: Zed Zippy <234243425+zed-zippy[bot]@users.noreply.github.com>
2026-01-20 13:04:27 -08:00

3.3 KiB
Raw Blame History

Zed on macOS

Zed is developed primarily on macOS, making it a first-class platform with full feature support.

Installing Zed

Download Zed from the download page. The download is a .dmg file—open it and drag Zed to your Applications folder.

For the preview build, which receives updates about a week ahead of stable, visit the preview releases page.

After installation, Zed checks for updates automatically and prompts you when a new version is available.

Homebrew

You can also install Zed using Homebrew:

brew install --cask zed

For the preview version:

brew install --cask zed@preview

Building from Source

To build Zed from source, see the macOS development documentation.

System Requirements

  • macOS 10.15.7 (Catalina) or later
  • Apple Silicon (M1/M2/M3/M4) or Intel processor

Zed uses Metal for GPU-accelerated rendering, which is available on all supported macOS versions.

Installing the CLI

Zed includes a command-line tool for opening files and projects from Terminal. To install it:

  1. Open Zed
  2. Open the command palette with Cmd+Shift+P
  3. Run cli: install

This creates a zed command in /usr/local/bin. You can then open files and folders:

zed .                    # Open current folder
zed file.txt             # Open a file
zed project/ file.txt    # Open a folder and a file

See the CLI Reference for all available options.

Uninstall

  1. Quit Zed if it's running
  2. Drag Zed from Applications to the Trash
  3. Optionally, remove your settings and extensions:
rm -rf ~/.config/zed
rm -rf ~/Library/Application\ Support/Zed
rm -rf ~/Library/Caches/Zed
rm -rf ~/Library/Logs/Zed
rm -rf ~/Library/Saved\ Application\ State/dev.zed.Zed.savedState

If you installed the CLI, remove it with:

rm /usr/local/bin/zed

Troubleshooting

Zed won't open or shows "damaged" warning

If macOS reports that Zed is damaged or can't be opened, it's likely a Gatekeeper issue. Try:

  1. Right-click (or Control-click) on Zed in Applications
  2. Select "Open" from the context menu
  3. Click "Open" in the dialog that appears

This tells macOS to trust the application.

If that doesn't work, remove the quarantine attribute:

xattr -cr /Applications/Zed.app

CLI command not found

If the zed command isn't available after installation:

  1. Check that /usr/local/bin is in your PATH
  2. Try reinstalling the CLI via cli: install in the command palette
  3. Open a new terminal window to reload your PATH

GPU or rendering issues

Zed uses Metal for rendering. If you experience graphical glitches:

  1. Ensure macOS is up to date
  2. Restart your Mac to reset the GPU state
  3. Check Activity Monitor for GPU pressure from other apps

High memory or CPU usage

If Zed uses more resources than expected:

  1. Check for runaway language servers in the terminal output (zed: open log)
  2. Try disabling extensions one by one to identify conflicts
  3. For large projects, consider using project settings to exclude unnecessary folders from indexing

For additional help, see the Troubleshooting guide or visit the Zed Discord.