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 homebrew, node and rustup-init (rustup, rust, cargo, etc.)
17 ```
18 /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
19 brew install node rustup-init
20 rustup-init # follow the installation steps
21 ```
22
23* Install postgres and configure the database
24 ```
25 brew install postgresql@15
26 brew services start postgresql@15
27 psql -c "CREATE ROLE postgres SUPERUSER LOGIN" postgres
28 psql -U postgres -c "CREATE DATABASE zed"
29 ```
30
31* Install the `LiveKit` server, the `PostgREST` API server, and the `foreman` process supervisor:
32
33 ```
34 brew install livekit
35 brew install postgrest
36 brew install foreman
37 ```
38
39* Ensure the Zed.dev website is checked out in a sibling directory and install its dependencies:
40
41 ```
42 cd ..
43 git clone https://github.com/zed-industries/zed.dev
44 cd zed.dev && npm install
45 npm install -g vercel
46 ```
47
48* Return to Zed project directory and Initialize submodules
49
50 ```
51 cd zed
52 git submodule update --init --recursive
53 ```
54
55* Set up a local `zed` database and seed it with some initial users:
56
57 [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).
58 Then delete that token.
59
60 ```
61 GITHUB_TOKEN=<$token> script/bootstrap
62 ```
63
64* Now try running zed with collaboration disabled:
65 ```
66 cargo run
67 ```
68
69### Common errors
70
71* `xcrun: error: unable to find utility "metal", not a developer tool or in PATH`
72 * You need to install Xcode and then run: `xcode-select --switch /Applications/Xcode.app/Contents/Developer`
73 * (see https://github.com/gfx-rs/gfx/issues/2309)
74
75### Testing against locally-running servers
76
77Start the web and collab servers:
78
79```
80foreman start
81```
82
83If you want to run Zed pointed at the local servers, you can run:
84
85```
86script/zed-with-local-servers
87# or...
88script/zed-with-local-servers --release
89```
90
91### Dump element JSON
92
93If 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.
94
95### Licensing
96
97We use [`cargo-about`](https://github.com/EmbarkStudios/cargo-about) to automatically comply with open source licenses. If CI is failing, check the following:
98
99- 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.
100- 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`.
101- 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).
102
103
104### Wasm Plugins
105
106Zed 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:
107
108```bash
109rustup target add wasm32-wasi
110```
111
112Plugins 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`.