d5441ba386
This pull request introduces a new assistant panel to Zed that lets users interact with OpenAI using their API key: ![CleanShot 2023-06-07 at 09 39 10@2x](https://github.com/zed-industries/zed/assets/482957/ba2a5830-9aeb-4c45-a182-a44d6a72675f) After setting the key up, it will be saved to the keychain and automatically loaded the next time the assistant panel is opened. The key can be reset using `assistant: reset key`. ![CleanShot 2023-06-07 at 09 39 23@2x](https://github.com/zed-industries/zed/assets/482957/a6808bb0-0098-45ae-a2e3-f4d88472e626) From there, users can type messages in a multi-buffer and hit `cmd-enter` (`assistant: assist`) to stream assistant responses using the OpenAI API. Responses can be canceled by hitting `escape`. ![CleanShot 2023-06-07 at 09 40 16@2x](https://github.com/zed-industries/zed/assets/482957/749779da-850e-4ad5-af04-74a3ca39f7ad) Users can quote a selection from the active editor by hitting `cmd->` (`assistant: quote selection`), which will embed the selected piece of text in a Markdown fenced code block. Conversations with the assistant are ephemeral at the moment, but can be easily copy/pasted: ![CleanShot 2023-06-07 at 09 50 33@2x](https://github.com/zed-industries/zed/assets/482957/b3386c10-4c51-4419-a0e0-517112ef6521) Release Notes: - Added a new assistant panel feature that enables interacting with OpenAI using an API key. This replaces the previous experimental `ai: assist` command that would work on any buffer. The experience is similar to the one offered by ChatGPT with the added ability to edit, delete or enhance previous messages. When hitting `cmd-enter`, the assistant will start streaming responses from OpenAI. A response stream can be canceled using `escape`. Moreover, the active editor's selection can be quoted in the assistant panel using `cmd->`, which will automatically embed the selected piece of text in a Markdown fenced code block. |
||
---|---|---|
.github | ||
.vscode | ||
assets | ||
crates | ||
plugins | ||
script | ||
styles | ||
.dockerignore | ||
.gitignore | ||
.gitmodules | ||
Cargo.lock | ||
Cargo.toml | ||
Dockerfile | ||
Procfile | ||
README.md | ||
rust-toolchain.toml |
Zed
Welcome to Zed, a lightning-fast, collaborative code editor that makes your dreams come true.
Development tips
Dependencies
-
Install Postgres.app and start it.
-
Install the
LiveKit
server and theforeman
process supervisor:brew install livekit brew install foreman
-
Ensure the Zed.dev website is checked out in a sibling directory:
cd .. git clone https://github.com/zed-industries/zed.dev
-
Initialize submodules
git submodule update --init --recursive
-
Set up a local
zed
database and seed it with some initial users:Create a personal GitHub token to run
script/bootstrap
once successfully: the token needs to have an access to private repositories for the script to work (repo
OAuth scope). Then delete that token.GITHUB_TOKEN=<$token> script/bootstrap
Testing against locally-running servers
Start the web and collab servers:
foreman start
If you want to run Zed pointed at the local servers, you can run:
script/zed-with-local-servers
# or...
script/zed-with-local-servers --release
Dump element JSON
If 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 to navigate the state of on-screen elements in a structured way.
Licensing
We use cargo-about
to automatically comply with open source licenses. If CI is failing, check the following:
- Is it showing a
no license specified
error for a crate you've created? If so, addpublish = false
under[package]
in your crate's Cargo.toml. - 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 theaccepted
array inscript/licenses/zed-licenses.toml
. - Is
cargo-about
unable to find the license for a dependency? If so, add a clarification field at the end ofscript/licenses/zed-licenses.toml
, as specified in the cargo-about book.
Wasm Plugins
Zed 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:
rustup target add wasm32-wasi
Plugins can be found in the plugins
folder in the root. For more information about how plugins work, check the Plugin Guide in crates/plugin_runtime/README.md
.