e2b9dfa89c
## Summary This PR improves the documentation for diff hunk keyboard shortcuts to make existing functionality more discoverable to users. ### Problem Users were unaware that pressing **ESC** already collapses all expanded diff hunks through the existing `Cancel` action. The functionality exists but lacks discoverability: - The `Cancel` action description was too generic: "Cancels the current operation" - No documentation existed for diff hunk keyboard shortcuts in the Git docs - Users would naturally expect a dedicated keybinding for collapsing diff hunks Release Notes: - N/A
153 lines
8 KiB
Markdown
153 lines
8 KiB
Markdown
# Git
|
||
|
||
Zed currently offers a set of fundamental Git features, with support coming in the future for more advanced ones, like conflict resolution tools, line by line staging, and more.
|
||
|
||
Here's an overview of all currently supported features:
|
||
|
||
- Committing
|
||
- Staging, pushing, pulling, and fetching
|
||
- Project Diff: A multibuffer view of all changes
|
||
- Diff indicators in buffers and editor scrollbars
|
||
- Inline diff toggle and reverts in the editor for unstaged changes
|
||
- Git status in the Project Panel
|
||
- Branch creating and switching
|
||
- Git blame viewing
|
||
|
||
## Git Panel
|
||
|
||
The Git Panel gives you a birds-eye view of the state of your working tree and of Git's staging area.
|
||
|
||
You can open the Git Panel using {#action git_panel::ToggleFocus}, or by clicking the Git icon in the status bar.
|
||
|
||
In 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.
|
||
|
||
Zed monitors your repository so that changes you make on the command line are instantly reflected.
|
||
|
||
## Project Diff
|
||
|
||
You 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.
|
||
|
||
All of the changes displayed in the Project Diff behave exactly the same as any other multibuffer: they are all editable excerpts of files.
|
||
|
||
You can stage or unstage each hunk as well as a whole file by hitting the buttons on the tab bar or their corresponding keybindings.
|
||
|
||
<!-- Add media -->
|
||
|
||
## Fetch, push, and pull
|
||
|
||
Fetch, 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}.
|
||
|
||
## Staging Workflow
|
||
|
||
Zed has two primary staging workflows, using either the Project Diff or the panel directly.
|
||
|
||
### Using the Project Diff
|
||
|
||
In 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}).
|
||
|
||
Similarly, 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}).
|
||
|
||
### Using the Git Panel
|
||
|
||
From 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.
|
||
|
||
<!-- Show a set of changes with default staged -->
|
||
|
||
Entries 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}.
|
||
|
||
<!-- Add media -->
|
||
|
||
## Committing
|
||
|
||
Zed offers two commit textareas:
|
||
|
||
1. The first one is available right at the bottom of the Git Panel. Hitting {#kb git::Commit} immediately commits all of your staged changes.
|
||
2. 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.
|
||
|
||
### Undoing a Commit
|
||
|
||
As 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.
|
||
In there, you can use the "Uncommit" button, which performs the `git reset HEADˆ--soft` command.
|
||
|
||
## AI Support in Git
|
||
|
||
Zed currently supports LLM-powered commit message generation.
|
||
You 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.
|
||
|
||
> Note that you need to have an LLM provider configured. Visit [the AI configuration page](./ai/configuration.md) to learn how to do so.
|
||
|
||
You can specify your preferred model to use by providing a `commit_message_model` agent setting. See [Feature-specific models](./ai/configuration.md#feature-specific-models) for more information.
|
||
|
||
```json
|
||
{
|
||
"agent": {
|
||
"version": "2",
|
||
"commit_message_model": {
|
||
"provider": "anthropic",
|
||
"model": "claude-3-5-haiku"
|
||
}
|
||
}
|
||
}
|
||
```
|
||
|
||
<!-- Add media -->
|
||
|
||
More advanced AI integration with Git features may come in the future.
|
||
|
||
## Git Integrations
|
||
|
||
Zed integrates with popular Git hosting services to ensure that Git commit hashes and references to Issues, Pull Requests, and Merge Requests become clickable links.
|
||
|
||
Zed currently supports links to the hosted versions of
|
||
[GitHub](https://github.com),
|
||
[GitLab](https://gitlab.com),
|
||
[Bitbucket](https://bitbucket.org),
|
||
[SourceHut](https://sr.ht) and
|
||
[Codeberg](https://codeberg.org).
|
||
|
||
Zed also has a Copy Permalink feature to create a permanent link to a code snippet on your Git hosting service.
|
||
These links are useful for sharing a specific line or range of lines in a file at a specific commit.
|
||
Trigger this action via the [Command Palette](./getting-started.md#command-palette) (search for `permalink`),
|
||
by creating a [custom key bindings](key-bindings.md#custom-key-bindings) to the
|
||
`editor::CopyPermalinkToLine` or `editor::OpenPermalinkToLine` actions
|
||
or by simply right clicking and selecting `Copy Permalink` with line(s) selected in your editor.
|
||
|
||
## Diff Hunk Keyboard Shortcuts
|
||
|
||
When viewing files with changes, Zed displays diff hunks that can be expanded or collapsed for detailed review:
|
||
|
||
- **Expand all diff hunks**: {#action editor::ExpandAllDiffHunks} ({#kb editor::ExpandAllDiffHunks})
|
||
- **Collapse all diff hunks**: Press `Escape` (bound to {#action editor::Cancel})
|
||
- **Toggle selected diff hunks**: {#action editor::ToggleSelectedDiffHunks} ({#kb editor::ToggleSelectedDiffHunks})
|
||
- **Navigate between hunks**: {#action editor::GoToHunk} and {#action editor::GoToPreviousHunk}
|
||
|
||
> **Tip:** The `Escape` key is the quickest way to collapse all expanded diff hunks and return to an overview of your changes.
|
||
|
||
## Action Reference
|
||
|
||
| Action | Keybinding |
|
||
| ----------------------------------------- | ------------------------------------- |
|
||
| {#action git::Add} | {#kb git::Add} |
|
||
| {#action git::StageAll} | {#kb git::StageAll} |
|
||
| {#action git::UnstageAll} | {#kb git::UnstageAll} |
|
||
| {#action git::ToggleStaged} | {#kb git::ToggleStaged} |
|
||
| {#action git::StageAndNext} | {#kb git::StageAndNext} |
|
||
| {#action git::UnstageAndNext} | {#kb git::UnstageAndNext} |
|
||
| {#action git::Commit} | {#kb git::Commit} |
|
||
| {#action git::ExpandCommitEditor} | {#kb git::ExpandCommitEditor} |
|
||
| {#action git::Push} | {#kb git::Push} |
|
||
| {#action git::ForcePush} | {#kb git::ForcePush} |
|
||
| {#action git::Pull} | {#kb git::Pull} |
|
||
| {#action git::Fetch} | {#kb git::Fetch} |
|
||
| {#action git::Diff} | {#kb git::Diff} |
|
||
| {#action git::Restore} | {#kb git::Restore} |
|
||
| {#action git::RestoreFile} | {#kb git::RestoreFile} |
|
||
| {#action git::Branch} | {#kb git::Branch} |
|
||
| {#action git::Switch} | {#kb git::Switch} |
|
||
| {#action git::CheckoutBranch} | {#kb git::CheckoutBranch} |
|
||
| {#action git::Blame} | {#kb git::Blame} |
|
||
| {#action editor::ToggleGitBlameInline} | {#kb editor::ToggleGitBlameInline} |
|
||
| {#action editor::ExpandAllDiffHunks} | {#kb editor::ExpandAllDiffHunks} |
|
||
| {#action editor::ToggleSelectedDiffHunks} | {#kb editor::ToggleSelectedDiffHunks} |
|
||
|
||
> Not all actions have default keybindings, but can be bound by [customizing your keymap](./key-bindings.md#user-keymaps).
|