Home Explore Blog CI



zed

docs/src/development.md
29cdb291d356526e0159465597430e8663e859351d33cbc6000000030000067e
# Developing Zed

See the platform-specific instructions for building Zed from source:

- [macOS](./development/macos.md)
- [Linux](./development/linux.md)
- [Windows](./development/windows.md)

If you'd like to develop collaboration features, additionally see:

- [Local Collaboration](./development/local-collaboration.md)

## Keychain access

Zed stores secrets in the system keychain.

However, when running a development build of Zed on macOS (and perhaps other
platforms) trying to access the keychain results in a lot of keychain prompts
that require entering your password over and over.

On macOS this is caused by the development build not having a stable identity.
Even if you choose the "Always Allow" option, the OS will still prompt you for
your password again the next time something changes in the binary.

This quickly becomes annoying and impedes development speed.

That is why, by default, when running a development build of Zed an alternative
credential provider is used in order to bypass the system keychain.

> Note: This is **only** the case for development builds. For all non-development
> release channels the system keychain is always used.

If you need to test something out using the real system keychain in a
development build, run Zed with the following environment variable set:

```
ZED_DEVELOPMENT_USE_KEYCHAIN=1
```

## Contributor links

- [CONTRIBUTING.md](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md)
- [Releases](./development/releases.md)
- [Debugging Crashes](./development/debugging-crashes.md)
- [Code of Conduct](https://zed.dev/code-of-conduct)
- [Zed Contributor License](https://zed.dev/cla)

Chunks
8f0c1ecf (1st chunk of `docs/src/development.md`)
Title: Developing Zed: Build Instructions, Keychain Access, and Contributor Resources
Summary
This section provides instructions for building Zed from source on macOS, Linux, and Windows. It explains how Zed handles keychain access during development to avoid excessive password prompts on macOS by using an alternative credential provider. It also provides links to important contributor resources like the contributing guidelines, release information, debugging crash instructions, code of conduct, and Zed contributor license agreement.