1---
2description: Zed is a text editor that supports lots of Git features
3title: Zed Editor Git integration documentation
4---
5
6# Git
7
8Zed has built-in Git support that lets you manage version control without leaving the editor. The Git Panel shows your working tree state, staging area, and branch information. Changes you make on the command line are reflected immediately in Zed.
9
10For operations that Zed doesn't support natively, you can use the integrated terminal.
11
12## Git Panel
13
14The Git Panel gives you a birds-eye view of the state of your working tree and of Git's staging area.
15
16You can open the Git Panel using {#action git_panel::ToggleFocus}, or by clicking the Git icon in the status bar.
17
18In the panel you can see the state of your project at a glance: which repository and branch are active, what files have changed and the current staging state of each file.
19
20Zed monitors your repository so that changes you make on the command line are instantly reflected.
21
22### Configuration
23
24Open the Settings Editor (`Cmd+,` on macOS, `Ctrl+,` on Linux/Windows) to customize Git behavior. Settings are spread across two pages:
25
26- **Panels > Git Panel**: Panel position, tree vs flat view, status display style
27- **Version Control**: Gutter indicators, inline blame, hunk styles
28
29#### Moving the Git Panel
30
31By default, the Git Panel docks on the left. Go to **Panels > Git Panel** and change **Git Panel Dock** to move it to the right or bottom.
32
33#### Switching to Tree View
34
35The Git Panel shows a flat list of changed files by default. To see files organized by folder hierarchy instead, toggle **Tree View** in the panel's context menu, or enable it in **Panels > Git Panel**.
36
37#### Inline Blame
38
39Zed shows Git blame information on the current line. To turn this off or add a delay before it appears, go to **Version Control > Inline Git Blame**.
40
41#### Hiding the Gutter Indicators
42
43The colored bars in the gutter that show added, modified, and deleted lines can be hidden. Go to **Version Control > Git Gutter** and set **Visibility** to "Hide".
44
45#### Commit Message Line Length
46
47Zed wraps commit messages at 72 characters (a Git convention). To change this, search for "Git Commit" in Settings and adjust **Preferred Line Length**.
48
49## Project Diff
50
51You can see all of the changes captured by Git in Zed by opening the Project Diff ({#kb git::Diff}), accessible via the {#action git::Diff} action in the Command Palette or the Git Panel.
52
53All of the changes displayed in the Project Diff behave exactly the same as any other multibuffer: they are all editable excerpts of files.
54
55You can stage or unstage each hunk as well as a whole file by hitting the buttons on the tab bar or their corresponding keybindings.
56
57### Word Diff Highlighting
58
59By default, Zed highlights changed words within modified lines to make it easier to spot exactly what changed. To disable this globally, open the Settings Editor and go to **Languages & Tools > Miscellaneous**, then turn off **Word Diff Enabled**.
60
61To disable word diff for specific languages only, add this to your settings.json:
62
63```json
64{
65 "languages": {
66 "Markdown": {
67 "word_diff_enabled": false
68 }
69 }
70}
71```
72
73## File History
74
75File History shows the commit history for an individual file. Each entry displays the commit's author, timestamp, and message. Selecting a commit opens a diff view filtered to show only the changes made to that file in that commit.
76
77To open File History:
78
79- Right-click on a file in the Project Panel and select "Open File History"
80- Right-click on a file in the Git Panel and select "Open File History"
81- Right-click on an editor tab and select "Open File History"
82- Use the Command Palette and search for "file history"
83
84## Fetch, Push, and Pull
85
86Fetch, push, or pull from your Git repository in Zed via the buttons available on the Git Panel or via the Command Palette by looking at the respective actions: {#action git::Fetch}, {#action git::Push}, and {#action git::Pull}.
87
88### Push Configuration
89
90Zed respects Git's push configuration. When pushing, Zed checks the following in order:
91
921. `pushRemote` configured for the current branch
932. `remote.pushDefault` in your Git config
943. The branch's tracking remote
95
96This matches Git's standard behavior, so if you've configured `pushRemote` or `pushDefault` in your `.gitconfig` or via `git config`, Zed will use those settings.
97
98## Remotes
99
100When your repository has multiple remotes, Zed shows a remote selector in the Git Panel. Click the remote button next to push/pull to choose which remote to use for that operation.
101
102## Staging Workflow
103
104Zed has two primary staging workflows, using either the Project Diff or the panel directly.
105
106### Using the Project Diff
107
108In the Project Diff view, you can focus on each hunk and stage them individually by clicking on the tab bar buttons or via the keybindings {#action git::StageAndNext} ({#kb git::StageAndNext}).
109
110Similarly, stage all hunks at the same time with the {#action git::StageAll} ({#kb git::StageAll}) keybinding and then immediately commit with {#action git::Commit} ({#kb git::Commit}).
111
112### Using the Git Panel
113
114From the panel, you can simply type a commit message and hit the commit button, or {#action git::Commit}. This will automatically stage all tracked files (indicated by a `[·]` in the entry's checkbox) and commit them.
115
116<!-- Show a set of changes with default staged -->
117
118Entries can be staged using each individual entry's checkbox. All changes can be staged using the button at the top of the panel, or {#action git::StageAll}.
119
120<!-- Add media -->
121
122## Committing
123
124Zed offers two commit textareas:
125
1261. The first one is available right at the bottom of the Git Panel. Hitting {#kb git::Commit} immediately commits all of your staged changes.
1272. The second is available via the action {#action git::ExpandCommitEditor} or via hitting the {#kb git::ExpandCommitEditor} while focused in the Git Panel commit textarea.
128
129### Undoing a Commit
130
131As soon as you commit in Zed, in the Git Panel, you'll see a bar right under the commit textarea, which will show the recently submitted commit.
132In there, you can use the "Uncommit" button, which performs the `git reset HEADˆ--soft` command.
133
134### Configuring Commit Line Length
135
136By default, Zed sets the commit line length to `72` but it can be configured in your local `settings.json` file.
137
138Find more information about setting the `preferred-line-length` in the [Configuration](#configuration) section.
139
140## Branch Management
141
142### Creating and Switching Branches
143
144Create a new branch using {#action git::Branch} or switch to an existing branch using {#action git::Switch} or {#action git::CheckoutBranch}.
145
146### Deleting Branches
147
148To delete a branch, open the branch switcher with {#action git::Switch}, find the branch you want to delete, and use the delete option. Zed will confirm before deleting to prevent accidental data loss.
149
150> **Note:** You cannot delete the branch you currently have checked out. Switch to a different branch first.
151
152## Merge Conflicts
153
154When you encounter merge conflicts after a merge, rebase, or pull, Zed highlights the conflicting regions in your files and displays resolution buttons above each conflict.
155
156### Viewing Conflicts
157
158Conflicting files appear in the Git Panel with a warning icon. You can also see conflicts in the Project Diff view, where each conflict region is highlighted:
159
160- Changes from your current branch are highlighted in green
161- Changes from the incoming branch are highlighted in blue
162
163### Resolving Conflicts
164
165Each conflict shows three buttons:
166
167- **Use [branch-name]**: Keep the changes from one branch (shows the actual branch name, like "main")
168- **Use [other-branch]**: Keep the changes from the other branch (like "feature-branch")
169- **Use Both**: Keep both sets of changes, with your branch's changes first
170
171Click a button to resolve that conflict. The conflict markers are removed and replaced with your chosen content. After resolving all conflicts in a file, stage it and commit to complete the merge.
172
173> **Tip:** For complex conflicts that need manual editing, you can edit the file directly. Remove the conflict markers (`<<<<<<<`, `=======`, `>>>>>>>`) and keep the content you want.
174
175## Stashing
176
177Git stash allows you to temporarily save your uncommitted changes and revert your working directory to a clean state. This is particularly useful when you need to quickly switch branches or pull updates without committing incomplete work.
178
179### Creating Stashes
180
181To stash all your current changes, use the {#action git::StashAll} action. This will save both staged and unstaged changes to a new stash entry and clean your working directory.
182
183### Managing Stashes
184
185Zed provides a stash picker accessible via {#action git::ViewStash} or from the Git Panel's overflow menu. From the stash picker, you can:
186
187- **View stash list**: Browse all your saved stashes with their descriptions and timestamps
188- **Open diffs**: See exactly what changes are stored in each stash
189- **Apply stashes**: Apply stash changes to your working directory while keeping the stash entry
190- **Pop stashes**: Apply stash changes and remove the stash entry from the list
191- **Drop stashes**: Delete unwanted stash entries without applying them
192
193### Quick Stash Operations
194
195For faster workflows, Zed provides direct actions to work with the most recent stash:
196
197- **Apply latest stash**: Use {#action git::StashApply} to apply the most recent stash without removing it
198- **Pop latest stash**: Use {#action git::StashPop} to apply and remove the most recent stash
199
200### Stash Diff View
201
202To view a stash's contents, select it in the stash picker and press {#kb stash_picker::ShowStashItem}. From the diff view, you can use these keybindings:
203
204| Action | Keybinding |
205| ------------------------------------ | ---------------------------- |
206| Apply stash | {#kb git::ApplyCurrentStash} |
207| Pop stash (apply and remove) | {#kb git::PopCurrentStash} |
208| Drop stash (remove without applying) | {#kb git::DropCurrentStash} |
209
210## AI Support in Git
211
212Zed currently supports LLM-powered commit message generation.
213You can ask AI to generate a commit message by focusing on the message editor within the Git Panel and either clicking on the pencil icon in the bottom left, or reaching for the {#action git::GenerateCommitMessage} ({#kb git::GenerateCommitMessage}) keybinding.
214
215> Note that you need to have an LLM provider configured either via your own API keys or through Zed's hosted AI models.
216> Visit [the AI configuration page](./ai/configuration.md) to learn how to do so.
217
218You can specify your preferred model to use by providing a `commit_message_model` agent setting.
219See [Feature-specific models](./ai/agent-settings.md#feature-specific-models) for more information.
220
221```json [settings]
222{
223 "agent": {
224 "commit_message_model": {
225 "provider": "anthropic",
226 "model": "claude-3-5-haiku"
227 }
228 }
229}
230```
231
232To customize the format of generated commit messages, run {#action agent::OpenRulesLibrary} and select the "Commit message" rule on the left side.
233From there, you can modify the prompt to match your desired format.
234
235<!-- Add media -->
236
237Any specific instructions for commit messages added to [Rules files](./ai/rules.md) are also picked up by the model tasked with writing your commit message.
238
239## Git Integrations
240
241Zed integrates with popular Git hosting services to ensure that Git commit hashes and references to Issues, Pull Requests, and Merge Requests become clickable links.
242
243Zed currently supports links to the hosted versions of
244[GitHub](https://github.com),
245[GitLab](https://gitlab.com),
246[Bitbucket](https://bitbucket.org),
247[SourceHut](https://sr.ht) and
248[Codeberg](https://codeberg.org).
249
250### Self-Hosted Instances
251
252For self-hosted GitHub, GitLab, or Bitbucket instances, add them to the `git_hosting_providers` setting so commit hashes and permalinks resolve to your domain:
253
254```json [settings]
255{
256 "git_hosting_providers": [
257 {
258 "provider": "gitlab",
259 "name": "Corp GitLab",
260 "base_url": "https://git.example.corp"
261 }
262 ]
263}
264```
265
266Supported `provider` values are `github`, `gitlab`, `bitbucket`, `gitea`, `forgejo`, and `sourcehut`. The `name` field is optional and used for display purposes.
267
268### Permalinks
269
270Zed also has a Copy Permalink feature to create a permanent link to a code snippet on your Git hosting service.
271These links are useful for sharing a specific line or range of lines in a file at a specific commit.
272Trigger this action via the [Command Palette](./getting-started.md#command-palette) (search for `permalink`),
273by creating a [custom key bindings](key-bindings.md#custom-key-bindings) to the
274`editor::CopyPermalinkToLine` or `editor::OpenPermalinkToLine` actions
275or by simply right clicking and selecting `Copy Permalink` with line(s) selected in your editor.
276
277## Diff Hunk Keyboard Shortcuts
278
279When viewing files with changes, Zed displays diff hunks that can be expanded or collapsed for detailed review:
280
281- **Expand all diff hunks**: {#action editor::ExpandAllDiffHunks} ({#kb editor::ExpandAllDiffHunks})
282- **Collapse all diff hunks**: Press `Escape` (bound to {#action editor::Cancel})
283- **Toggle selected diff hunks**: {#action editor::ToggleSelectedDiffHunks} ({#kb editor::ToggleSelectedDiffHunks})
284- **Navigate between hunks**: {#action editor::GoToHunk} and {#action editor::GoToPreviousHunk}
285
286> **Tip:** The `Escape` key is the quickest way to collapse all expanded diff hunks and return to an overview of your changes.
287
288## Action Reference
289
290| Action | Keybinding |
291| ----------------------------------------- | ------------------------------------- |
292| {#action git::Add} | {#kb git::Add} |
293| {#action git::StageAll} | {#kb git::StageAll} |
294| {#action git::UnstageAll} | {#kb git::UnstageAll} |
295| {#action git::ToggleStaged} | {#kb git::ToggleStaged} |
296| {#action git::StageAndNext} | {#kb git::StageAndNext} |
297| {#action git::UnstageAndNext} | {#kb git::UnstageAndNext} |
298| {#action git::Commit} | {#kb git::Commit} |
299| {#action git::ExpandCommitEditor} | {#kb git::ExpandCommitEditor} |
300| {#action git::Push} | {#kb git::Push} |
301| {#action git::ForcePush} | {#kb git::ForcePush} |
302| {#action git::Pull} | {#kb git::Pull} |
303| {#action git::PullRebase} | {#kb git::PullRebase} |
304| {#action git::Fetch} | {#kb git::Fetch} |
305| {#action git::Diff} | {#kb git::Diff} |
306| {#action git::Restore} | {#kb git::Restore} |
307| {#action git::RestoreFile} | {#kb git::RestoreFile} |
308| {#action git::Branch} | {#kb git::Branch} |
309| {#action git::Switch} | {#kb git::Switch} |
310| {#action git::CheckoutBranch} | {#kb git::CheckoutBranch} |
311| {#action git::Blame} | {#kb git::Blame} |
312| {#action git::StashAll} | {#kb git::StashAll} |
313| {#action git::StashPop} | {#kb git::StashPop} |
314| {#action git::StashApply} | {#kb git::StashApply} |
315| {#action git::ViewStash} | {#kb git::ViewStash} |
316| {#action editor::ToggleGitBlameInline} | {#kb editor::ToggleGitBlameInline} |
317| {#action editor::ExpandAllDiffHunks} | {#kb editor::ExpandAllDiffHunks} |
318| {#action editor::ToggleSelectedDiffHunks} | {#kb editor::ToggleSelectedDiffHunks} |
319
320> Not all actions have default keybindings, but can be bound by [customizing your keymap](./key-bindings.md#user-keymaps).
321
322## Git CLI Configuration
323
324If you would like to also use Zed for your [git commit message editor](https://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration#_core_editor) when committing from the command line you can use `zed --wait`:
325
326```sh
327git config --global core.editor "zed --wait"
328```
329
330Or add the following to your shell environment (in `~/.zshrc`, `~/.bashrc`, etc):
331
332```sh
333export GIT_EDITOR="zed --wait"
334```