development.md

 1# Developing Zed
 2
 3See the platform-specific instructions for building Zed from source:
 4
 5- [macOS](./development/macos.md)
 6- [Linux](./development/linux.md)
 7- [Windows](./development/windows.md)
 8
 9If you'd like to develop collaboration features, additionally see:
10
11- [Local Collaboration](./development/local-collaboration.md)
12
13## Authentication
14
15When developing Zed you will typically want to sign in to the production collab
16instance, unless you are specifically working on features that require running
17collab locally.
18
19In order to bypass the keychain prompts that pop up when trying to sign in each
20time you run a development build of Zed, you can use the development auth
21provider.
22
23This will store your Zed access token in a local file on disk that can be read
24in development, bypassing the need to retrieve the credential from the system
25keychain.
26
27To enable the development auth provider, set this in your shell:
28
29```
30ZED_DEVELOPMENT_AUTH=1
31```
32
33You may want to add this to your shell profile so you don't need to remember to enable it each time.
34
35> Note: This only works for development builds. It is a no-op in all non-development release channels.
36
37## Contributor links
38
39- [CONTRIBUTING.md](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md)
40- [Releases](./development/releases.md)
41- [Debugging Crashes](./development/debugging-crashes.md)
42- [Code of Conduct](https://zed.dev/code-of-conduct)
43- [Zed Contributor License](https://zed.dev/cla)