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 [Postgres.app](https://postgresapp.com) and start it.
12* Install the `LiveKit` server and the `foreman` process supervisor:
13
14 ```
15 brew install livekit
16 brew install foreman
17 ```
18
19* Ensure the Zed.dev website is checked out in a sibling directory:
20
21 ```
22 cd ..
23 git clone https://github.com/zed-industries/zed.dev
24 ```
25
26* Initialize submodules
27
28 ```
29 git submodule update --init --recursive
30 ```
31
32* Set up a local `zed` database and seed it with some initial users:
33
34 Create a personal GitHub token to run `script/bootstrap` once successfully. Then delete that token.
35
36 ```
37 GITHUB_TOKEN=<$token> script/bootstrap
38 ```
39
40### Testing against locally-running servers
41
42Start the web and collab servers:
43
44```
45foreman start
46```
47
48If you want to run Zed pointed at the local servers, you can run:
49
50```
51script/zed-with-local-servers
52# or...
53script/zed-with-local-servers --release
54```
55
56### Dump element JSON
57
58If 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.
59
60### Licensing
61
62We use [`cargo-about`](https://github.com/EmbarkStudios/cargo-about) to automatically comply with open source licenses. If CI is failing, check the following:
63
64- 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.
65- 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`.
66- 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).
67
68
69### Wasm Plugins
70
71Zed 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:
72
73```bash
74rustup target add wasm32-wasi
75```
76
77Plugins 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`.