1# Zed
2
3[](https://github.com/zed-industries/zed/actions/workflows/ci.yml)
4
5Welcome to Zed, a lightning-fast, collaborative code editor that makes your dreams come true.
6
7## Development tips
8
9### Dependencies
10
11* Install Xcode from https://apps.apple.com/us/app/xcode/id497799835?mt=12, and accept the license:
12 ```
13 sudo xcodebuild -license
14 ```
15
16* Install rustup (rust, cargo, etc.)
17 ```
18 curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
19 ```
20
21* Install homebrew and node
22 ```
23 /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
24 brew install node
25 ```
26
27* Install postgres and configure the database
28 ```
29 brew install postgresql@15
30 brew services start postgresql@15
31 psql -c "CREATE ROLE postgres SUPERUSER LOGIN" postgres
32 psql -U postgres -c "CREATE DATABASE zed"
33 ```
34
35* Install the `LiveKit` server and the `foreman` process supervisor:
36
37 ```
38 brew install livekit
39 brew install foreman
40 ```
41
42* Ensure the Zed.dev website is checked out in a sibling directory and install it's dependencies:
43
44 ```
45 cd ..
46 git clone https://github.com/zed-industries/zed.dev
47 cd zed.dev && npm install
48 npm install -g vercel
49 ```
50
51* Return to Zed project directory and Initialize submodules
52
53 ```
54 cd zed
55 git submodule update --init --recursive
56 ```
57
58* Set up a local `zed` database and seed it with some initial users:
59
60 [Create a personal GitHub token](https://github.com/settings/tokens/new) to run `script/bootstrap` once successfully: the token needs to have an access to private repositories for the script to work (`repo` OAuth scope).
61 Then delete that token.
62
63 ```
64 GITHUB_TOKEN=<$token> script/bootstrap
65 ```
66
67* Now try running zed with collaboration disabled:
68 ```
69 cargo run
70 ```
71
72### Common errors
73
74* `xcrun: error: unable to find utility "metal", not a developer tool or in PATH`
75 * You need to install Xcode and then run: `xcode-select --switch /Applications/Xcode.app/Contents/Developer`
76 * (see https://github.com/gfx-rs/gfx/issues/2309)
77
78### Testing against locally-running servers
79
80Start the web and collab servers:
81
82```
83foreman start
84```
85
86If you want to run Zed pointed at the local servers, you can run:
87
88```
89script/zed-with-local-servers
90# or...
91script/zed-with-local-servers --release
92```
93
94### Dump element JSON
95
96If you trigger `cmd-alt-i`, Zed will copy a JSON representation of the current window contents to the clipboard. You can paste this in a tool like [DJSON](https://chrome.google.com/webstore/detail/djson-json-viewer-formatt/chaeijjekipecdajnijdldjjipaegdjc?hl=en) to navigate the state of on-screen elements in a structured way.
97
98### Licensing
99
100We use [`cargo-about`](https://github.com/EmbarkStudios/cargo-about) to automatically comply with open source licenses. If CI is failing, check the following:
101
102- Is it showing a `no license specified` error for a crate you've created? If so, add `publish = false` under `[package]` in your crate's Cargo.toml.
103- Is the error `failed to satisfy license requirements` for a dependency? If so, first determine what license the project has and whether this system is sufficient to comply with this license's requirements. If you're unsure, ask a lawyer. Once you've verified that this system is acceptable add the license's SPDX identifier to the `accepted` array in `script/licenses/zed-licenses.toml`.
104- Is `cargo-about` unable to find the license for a dependency? If so, add a clarification field at the end of `script/licenses/zed-licenses.toml`, as specified in the [cargo-about book](https://embarkstudios.github.io/cargo-about/cli/generate/config.html#crate-configuration).
105
106
107### Wasm Plugins
108
109Zed has a Wasm-based plugin runtime which it currently uses to embed plugins. To compile Zed, you'll need to have the `wasm32-wasi` toolchain installed on your system. To install this toolchain, run:
110
111```bash
112rustup target add wasm32-wasi
113```
114
115Plugins can be found in the `plugins` folder in the root. For more information about how plugins work, check the [Plugin Guide](./crates/plugin_runtime/README.md) in `crates/plugin_runtime/README.md`.