diff --git a/gitlens/GL-GK-Account.md b/gitlens/GL-GK-Account.md index 258d6eb..b12a5ec 100644 --- a/gitlens/GL-GK-Account.md +++ b/gitlens/GL-GK-Account.md @@ -29,7 +29,7 @@ When prompted with the login screen, select **Create an account** to begin. Choo - [Single Sign-On (SSO)](/gk-dev/gk-dev-single-sign-on/)
- GitKraken account creation screen with multiple login options + GitKraken account creation screen with multiple login options
Select a login method to create your GitKraken account
@@ -51,7 +51,7 @@ To change your avatar, click your profile picture. This will redirect you to [Gr > It may take several hours for avatar changes to appear in GitKraken.
- GitKraken account personalization options + GitKraken account personalization options
Customize your name, email, avatar, and password
diff --git a/gitlens/GL-Integrations.md b/gitlens/GL-Integrations.md index 21d1fe0..b9a35b6 100644 --- a/gitlens/GL-Integrations.md +++ b/gitlens/GL-Integrations.md @@ -1,100 +1,182 @@ --- - -title: Gitlens Integrations -description: Explore Gitlens Integrations +title: GitLens Integrations +description: Explore GitLens integrations with remote providers taxonomy: category: gitlens +--- + +Last updated: July 2025 + +# GitLens Integrations + +GitLens supports a wide range of remote providers to enhance your Git workflow inside Visual Studio Code. Supported platforms include: + +- GitHub (including GitHub Enterprise) +- GitLab +- Gitea +- Gerrit +- Bitbucket (Cloud and Server) +- Azure DevOps + +You can also define [custom remote providers or providers with custom domains](/gitlens/settings/#remote-provider-integration-settings). + +## Integration Capabilities + +Basic integrations include: + +- **Auto-linking** for issues and pull requests + +Enhanced integrations (e.g., GitHub, GitLab) offer: + +- **Launchpad support** to manage pull requests and workflows +- **Rich hovers** showing issue and PR details +- **Pull request associations** with branches and commits +- **Avatars** for contributors and reviewers + +These integrations also add contextual commands to open or copy URLs to files, commits, branches, and comparisons directly from your remote provider. --- -GitLens provides rich integrations with many remote providers, including GitHub, GitHub Enterprise, GitLab, Gitea, Gerrit, Bitbucket, Bitbucket Server, and Azure DevOps. You can also define [custom remote providers](/gitlens/settings/#remote-provider-integration-settings) or [remote providers with custom domains](/gitlens/settings/#remote-provider-integration-settings) as well. +## Remote Command Reference + +You can use the following GitLens commands to interact with files, commits, and repositories on your remote platform. + +### Files + +- **Open File from Remote** (`gitlens.openFileFromRemote`) — Open a local file by specifying a remote file URL +- **Open File on Remote** (`gitlens.openFileOnRemote`) — Open the current file or revision on the remote +- **Copy Remote File URL** (`gitlens.copyRemoteFileUrlToClipboard`) — Copy the URL of the current file or revision +- **Open File on Remote From...** (`gitlens.openFileOnRemoteFrom`) — Open a file/revision from a specific branch or tag +- **Copy Remote File URL From...** (`gitlens.copyRemoteFileUrlFrom`) — Copy the file/revision URL from a specific branch or tag -Basic integrations provide issue and pull request auto-linking, while richer integrations (e.g. GitHub or GitLab) offer the ability to work with the Launchpad, can provide rich hover information provided for auto-linked issues and pull requests, associate pull requests with branches and commits, and provide avatars. +### Commits -Additionally, these integrations provide commands to copy the url of or open, files, commits, branches, and the repository on the remote provider. +- **Open Commit on Remote** (`gitlens.openCommitOnRemote`) — Open a commit on the remote +- **Copy Remote Commit URL** (`gitlens.copyRemoteCommitUrl`) — Copy the URL of a commit -- Open _File from Remote_ command (`gitlens.openFileFromRemote`) — opens the local file from a url of a file on a remote provider -- Open _File on Remote_ command (`gitlens.openFileOnRemote`) — opens a file or revision on the remote provider -- Copy _Remote File Url_ command (`gitlens.copyRemoteFileUrlToClipboard`) — copies the url of a file or revision on the remote provider -- Open _File on Remote From..._ command (`gitlens.openFileOnRemoteFrom`) — opens a file or revision on a specific branch or tag on the remote provider -- Copy _Remote File Url From..._ command (`gitlens.copyRemoteFileUrlFrom`) — copies the url of a file or revision on a specific branch or tag the remote provider -- Open _Commit on Remote_ command (`gitlens.openCommitOnRemote`) — opens a commit on the remote provider -- Copy _Remote Commit Url_ command (`gitlens.copyRemoteCommitUrl`) — copies the url of a commit on the remote provider -- Open _Branch on Remote_ command (`gitlens.openBranchOnRemote`) — opens the branch on the remote provider -- Copy _Remote Branch Url_ command (`gitlens.copyRemoteBranchUrl`) — copies the url of a branch on the remote provider -- Open _Branches on Remote_ command (`gitlens.openBranchesOnRemote`) — opens the branches on the remote provider -- Copy _Remote Branches Url_ command (`gitlens.copyRemoteBranchesUrl`) — copies the url of the branches on the remote provider -- Open _Comparison on Remote_ command (`gitlens.openComparisonOnRemote`) — opens the comparison on the remote provider -- Copy _Remote Comparison Url_ command (`gitlens.copyRemoteComparisonUrl`) — copies the url of the comparison on the remote provider -- Open _Pull Request_ command (`gitlens.openPullRequestOnRemote`) — opens the pull request on the remote provider -- Copy _Pull Request Url_ command (`gitlens.copyRemotePullRequestUrl`) — copies the url of the pull request on the remote provider -- Open _Repository on Remote_ command (`gitlens.openRepoOnRemote`) — opens the repository on the remote provider -- Copy _Remote Repository Url_ command (`gitlens.copyRemoteRepositoryUrl`) — copies the url of the repository on the remote provider +### Branches -### Connecting the GitHub and GitLab Integration +- **Open Branch on Remote** (`gitlens.openBranchOnRemote`) — Open the current branch on the remote +- **Copy Remote Branch URL** (`gitlens.copyRemoteBranchUrl`) — Copy the URL of the current branch +- **Open Branches on Remote** (`gitlens.openBranchesOnRemote`) — Open the list of branches on the remote +- **Copy Remote Branches URL** (`gitlens.copyRemoteBranchesUrl`) — Copy the URL for all branches -The GitHub and GitLab integration are connected via your GitKraken account from [gitkraken.dev](https://gitkraken.dev/settings/integrations?source=help_center&product=gitlens). To connect an integration, open the Command Palette (`command/ctrl+shift+P`) and type `GitLens: Manage Integrations`. You can also navigate to GitKraken Account in the GitLens Activity Bar and select `Integrations`. +### Comparisons - +- **Open Comparison on Remote** (`gitlens.openComparisonOnRemote`) — Open a diff comparison on the remote +- **Copy Remote Comparison URL** (`gitlens.copyRemoteComparisonUrl`) — Copy the URL for the comparison -You will be prompted to log into your GitKraken account if you are not already. Then, select `Connect with GitHub` or `Connect with GitLab` and sign into the desired service. You will have the option to connect multiple integrations if needed. Finish the process by selecting `Complete Setup` to hop back into VS Code and begin working with the integrations. +### Pull Requests - +- **Open Pull Request on Remote** (`gitlens.openPullRequestOnRemote`) — Open the associated pull request +- **Copy Pull Request URL** (`gitlens.copyRemotePullRequestUrl`) — Copy the pull request URL + +### Repositories + +- **Open Repository on Remote** (`gitlens.openRepoOnRemote`) — Open the entire repository in your browser +- **Copy Remote Repository URL** (`gitlens.copyRemoteRepositoryUrl`) — Copy the repository URL for sharing or navigation + + +### Connect GitHub or GitLab Integration + +To connect GitHub or GitLab to GitLens, you'll use your GitKraken account via the [GitLens integrations dashboard](https://gitkraken.dev/settings/integrations?source=help_center&product=gitlens). + +#### Steps to Connect: + +1. Open the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P`) and run `GitLens: Manage Integrations`, **or** +2. Go to the **GitKraken Account** section in the GitLens Activity Bar and choose **Integrations**. + +
+ +
Navigate to Integrations in the GitKraken Account menu
+
+ +3. If you’re not already signed in, log into your GitKraken account. +4. Click **Connect with GitHub** or **Connect with GitLab** and complete the sign-in process. +5. Select **Complete Setup** to return to Visual Studio Code and activate the integration. + +You can connect multiple integrations if needed. + +
+ +
Select the service you want to integrate and finish setup
+
-

Community users are limited to basic functionality only.

+

Community users are limited to basic functionality only.

## GitHub Enterprise Server and GitLab Self-Managed Integration `PRO` -GitLens Pro offers a richer integration with GitHub Enterprise Server and GitLab Self-Managed. - -Once authenticated, GitLens will enrich GitHub Enterprise Server or GitLab Self-Managed autolinks in the hovers. You’ll see your GitHub Enterprise Server or GitLab Self-Managed avatar, links to related pull requests, along with a footnote of the pull request or issue details. You’ll see similar details from the Sidebar views for any commit or branch associated with a pull request or issue. +GitLens Pro supports advanced integration with GitHub Enterprise Server and GitLab Self-Managed. - +Once authenticated, GitLens enhances autolinks for these services in hover cards. You'll see: -### Connecting GitHub Enterprise Server or GitLab Self-Managed +- User avatars +- Links to related pull requests and issues +- Pull request and issue details directly in the Sidebar views -To connect either the GitHub Enterprise Server or GitLab Self-Managed integration: +
+ +
Enhanced hover cards with issue and PR metadata
+
-- Open the `settings.json` - this can be done from the command palette (`command/ctrl + shift + P`) > _Preferences: Open User Settings (JSON)_ +### Connect GitHub Enterprise Server or GitLab Self-Managed -- Provide a _gitlens.remote_ with a _domain_ and a _type_ with the below format - for more information on the formatting see the [remote provider integration settings](/gitlens/settings/#remote-provider-integration-settings) +To connect a self-hosted GitHub or GitLab instance: -Format Example: +1. Open the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P`) and select **Preferences: Open User Settings (JSON)** +2. In `settings.json`, add a `gitlens.remotes` entry with your domain and provider type: -``` +```json "gitlens.remotes": [{ "domain": "git.corporate-url.com", "type": "GitHub" }] ``` -Or +Or for GitLab: -``` +```json "gitlens.remotes": [{ "domain": "git.corporate-url.com", "type": "GitLab" }] ``` -- Open a GitHub Enterprise Server or GitLab Self-Managed repository in VS Code +3. Open the self-hosted repository in Visual Studio Code +4. Open the [Remotes View](/gitlens/side-bar/#remotes-view) +5. Click **Connect to Remote** -- Open the [Remotes View](/gitlens/side-bar/#remotes-view) +
+ +
Use the plug icon to connect a self-managed remote
+
-- Select _Connect to Remote_ - if you do not see this option, check that the format of the settings.json matches the example above +> If the **Connect to Remote** option doesn't appear, double-check that your JSON entry matches the example format. - +6. When prompted, provide a Personal Access Token (PAT) with the required scopes and press **Enter** to complete setup -- You will then be prompted to provide a PAT with the required scopes and can hit _Enter_ to complete the integration connection *** ## Jira Integration `PRO` -The Jira Integration connected through your GitKraken Account gives you access to Jira [Autolinks](/gitlens/gitlens-features#autolinks) anywhere autolinks are supported in GitLens. Simply connect the integration and GitLens will automatically convert Jira IDs in commit messages to links i.e. `ABC-123`. +GitLens Pro supports integration with Jira Cloud via your GitKraken Account. This allows GitLens to automatically link Jira issue keys (e.g., `ABC-123`) in commit messages and views wherever autolinks are supported. - +
+ +
Jira issues auto-linked in GitLens hovers and views
+
-

This Feature is only available for Pro subscription tiers or higher

+

This feature is only available for Pro subscription tiers or higher.

-To connect the integration, open the GitLens Sidebar, select `Cloud Integrations` from the GitKraken Account view, select Jira Cloud, and proceed with the integration connection by allowing GitKraken access to your Atlassian Account. You can also open [Integration Settings](gitkraken.dev/settings/integrations?source=help_center&product=gitlens) in a browser. +### Connect the Jira Integration + +1. Open the GitLens Sidebar and navigate to the **GitKraken Account** view. +2. Select **Cloud Integrations**. +3. Choose **Jira Cloud** and follow the prompts to connect. +4. Allow GitKraken access to your Atlassian Account. + +You can also configure this via the [Integration Settings](https://gitkraken.dev/settings/integrations?source=help_center&product=gitlens) in a browser. - +
+ +
Jira integration via GitLens Cloud Integrations panel
+
diff --git a/gitlens/GL-Workspaces.md b/gitlens/GL-Workspaces.md index 6e68d83..d0feebe 100644 --- a/gitlens/GL-Workspaces.md +++ b/gitlens/GL-Workspaces.md @@ -1,79 +1,141 @@ --- - -title: Gitlens Workspaces -description: Explore Workspaces in Gitlens +title: Manage Multiple Repositories with GitLens Workspaces +description: Learn how to create and use Workspaces in GitLens to organize your repositories taxonomy: category: gitlens - --- +Last updated: July 2025 + +Workspaces in GitLens help you organize and manage multiple repositories from one convenient interface. Whether you're working solo or collaborating with a team, Workspaces simplify project access and context switching. -Workspaces are a convenient way to group and manage multiple repositories, making them easily accessible from anywhere. Whether you're working individually or collaborating with a team, Workspaces provide a seamless way to manage your projects. A Workspace can be made up of local repositories, those you currently have open in your VS Code window, or GitKraken Workspaces, which are repositories stored on the cloud or on GitKraken services. +A Workspace can include: +- **Local repositories**: The ones currently open in your VS Code window. +- **Cloud Workspaces**: Hosted by GitKraken and accessible anywhere (GitKraken account required). -Whether you're working individually or collaborating with a team, these new features are designed to help you work more efficiently and effectively. +> 💡 **Note:** Shared cloud Workspaces require a GitKraken trial or subscription. -To access Workspaces, simply open the GitLens Home menu and you will find them in the panel located at the bottom left. Alternatively, you can access them by performing a search in the command palette. +### Accessing Workspaces -Please note that while using cloud workspaces requires a GitKraken account, shared cloud workspaces require a trial or subscription. +You can open your Workspaces in two ways: - +1. Click the **GitLens Home** icon in the Activity Bar. +2. Use the Command Palette (`Cmd+Shift+P` or `Ctrl+Shift+P`) and search for `GitLens: Open Workspaces`. + +
+ +
Workspaces section in the GitLens Home panel
+
### Creating a Workspace -To create a workspace, tap the '+' button next to GitKraken Workspaces, provide a name and a description, and connect a provider if you wish. +To create a new GitLens Workspace: + +1. In the GitLens Home panel, click the **+** button next to **GitKraken Workspaces**. +2. Enter a **name** and an optional **description**. +3. (Optional) Connect a Git provider (such as GitHub or GitLab) to link repositories. - +
+ +
Create Workspace dialog with name, description, and provider options
+
### Adding Repositories -You can add repositories to a workspace by tapping the '+' button under the Workspace tab. And if you want to keep your Workspaces and their repositories up-to-date, simply tap the Refresh icon. +To add repositories to a Workspace: + +1. Click the **+** button under the **Workspace** tab. +2. To sync repository status, click the **Refresh** icon. - +
+ +
Add repositories to your Workspace
+
### Locating Repositories -To locate the disk location of the repositories within the Cloud Workspace, select the 'Locate Repositories' (pin icon) next to the repository name. If you have a folder set up for a Workspace with multiple repositories on your disk, you can select the option and choose the parent folder. GitLens will then find all the repositories within that parent folder. +To find the disk location of a repository in a Cloud Workspace: - +1. Click the **Locate Repositories** (pin icon) next to the repository name. +2. If you have a folder with multiple repositories, select the parent folder. GitLens will detect and associate all repositories within it. + +
+ +
Locate local disk path of repositories in your Workspace
+
### Opening Repositories -To open a repository from a Workspace tap the 'Open Repository in New Window' icon. +To open a repository from a Workspace: -_Pro Tip: If you prefer to open the Workspace in your current window, hold down the ALT/OPTION key on a Mac and click 'Open Repo'._ +- Click the **Open Repository in New Window** icon. +- _Pro Tip:_ To open the repository in the **current window**, hold the **Alt/Option** key (Mac) while clicking **Open Repo**. - +
+ +
Open repositories from a Workspace in VS Code
+
### Removing Repositories -To remove a repository from a Workspace, you can do so by right-clicking to open the context menu on the repository you wish to remove and then selecting 'remove repository from Workspace'. +To remove a repository from a Workspace: + +1. Right-click the repository. +2. Select **Remove repository from Workspace** from the context menu. - +
+ +
Remove repositories from a Workspace
+
### Converting to Cloud Workspaces -To convert your local VSCode workspace into a GitKraken Workspace, press the 'Convert to Cloud Workspace' icon, provide a name and a description, and your workspace will be stored in the cloud for your GitKraken user account. This means that your Cloud Workspace will now appear in any of your GitKraken shared services, such as GitKraken Desktop, GitLens, and the GitKraken CLI. +To convert a local VS Code workspace into a GitKraken Cloud Workspace: + +1. Click the **Convert to Cloud Workspace** icon. +2. Enter a **name** and **description**. + +Your Cloud Workspace will be synced to your GitKraken account and accessible via GitKraken Desktop, GitLens, and the GitKraken CLI. + +
+ +
Convert local Workspace to GitKraken Cloud Workspace
+
- +### Understanding Workspace Indicators and Colors -### Understanding Workspace indicators and colors +Visual indicators in Workspaces help you quickly understand their status. For example: +- A **green Workspace** with an **O** symbol indicates it is open in your current window. -Workspaces also include visual indicators to help you understand their status. For example, a green Workspace with an 'O' symbol indicates that it is open in your current window. +
+ +
Workspace status indicators
+
- +### Workspace Linking -### Workspace linking +You can link a VS Code workspace to a GitKraken Workspace: -A VS Code workspace can be created from a GitKraken Workspace to link them. +1. Create a VS Code workspace from an existing GitKraken Cloud Workspace. +2. Use the **Open VS Code Workspace in New Window** option (hold **Alt** to open in the current window). - +
+ +
Create a VS Code workspace from a GitKraken Workspace
+
-You can open a linked VS Code workspace from its cloud workspace using the new `Open VS Code Workspace in New Window` option (hold alt to open in the current window). +When opening a linked workspace, you can choose how to handle repository auto-adding: +- Automatically add repositories +- Prompt before adding +- Disable auto-adding -When repositories are added to a GitKraken Cloud workspace, you can automatically add those repositories to its linked VS Code workspace when that workspace is opened. You can choose to automatically add the repositories, be prompted to add them, or disable auto-adding repositories altogether for that workspace. This setting is chosen when creating the VS Code workspace, but can be changed at any time using the new `Change Linked Workspace Auto-Add Behavior` command on the `Current Window` item or its linked workspace in the _Workspaces_ view. +This behavior is configurable during setup or later via the `Change Linked Workspace Auto-Add Behavior` command. - +To manually sync repositories: +- Use the `Add Repositories from Linked Workspace` command at any time. -You can also manually add repositories to the VS Code workspace at any time using the new `Add Repositories from Linked Workspace` command. +
+ +
Manage repository linking for VS Code and GitKraken Workspaces
+
-*** \ No newline at end of file diff --git a/gitlens/gitlens-home.md b/gitlens/gitlens-home.md index 7b25f9e..d74717c 100644 --- a/gitlens/gitlens-home.md +++ b/gitlens/gitlens-home.md @@ -1,12 +1,15 @@ --- -title: Start Here -description: How to start working with GitLens +title: Get Started with GitLens +description: How to install and start using GitLens in Visual Studio Code taxonomy: category: gitlens --- + +Last updated: July 2025 + Welcome to the GitLens Support Documentation site! GitLens is the #1 most downloaded [Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens) Git extension that supercharges your developer workflows. You can download GitLens from the VS Code marketplace: @@ -21,7 +24,7 @@ GitLens is known for its blame, hover, and annotations, but there’s much more *** -### Interactive Code History +## Interactive Code History
@@ -29,128 +32,168 @@ GitLens is known for its blame, hover, and annotations, but there’s much more

 

-Understanding code history can be difficult when looking at complex repositories with multiple branches and contributors. Developers can struggle to easily see who made changes, why, and when. With the use of The Commit Graph, GitLens Inspect, and Inline Blame and Hovers, GitLens offers the ability to easily navigate through your repository to provide insights about the history and interact with it to better manage your code. +Understanding your repository's history is easier with GitLens. Whether you're navigating complex branches or reviewing past changes, GitLens offers intuitive tools to reveal who changed what and why. + +### View the Commit Graph + +The Commit Graph provides an interactive visual history of your branches and commits. It helps you: + +- Follow the development of features and bug fixes over time +- Quickly search and jump to specific commits or branches +- Understand commit context through messages and structure + +**To open the Commit Graph:** + +- Open the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P`) and run **GitLens: Show Commit Graph View**, or +- Click the **Commit Graph** icon in the sidebar + +[Open the Commit Graph in GitLens](vscode://eamodio.gitlens/link/command/graph) -#### Commit Graph +### Use GitLens Inspect -Once you have a repository open in VS Code, the Commit Graph gives you an interactive, action oriented visual of your commit and branch history. This allows you to follow your repository over time to see what is happening with branches and see why it was done with commit messages. You can quickly jump to any point in history by searching for either branches or commits. To view the commit graph, use the command palette (command/ctrl + shift + P) > _GitLens: Show Commit Graph View_ or select the _Show Commit Graph_ icon. +GitLens Inspect helps you dive deeper into a specific commit. It shows: -Open the Commit Graph in GitLens. +- Modified files and changed lines +- Related Jira issues or pull requests via autolinks +- File or line history for better context -#### GitLens Inspect +**To open Inspect View:** -When you are ready to dive deeper into a specific area, you can use GitLens Inspect. To open GitLens Inspect, right-click a commit and select Inspect Details. This will give you contextual information about what files and lines were modified in this specific commit. You can jump through the history of the file or line to see how it has changed over time. Additionally, autolinks help you see things like Jira issues or Pull Requests related to the changes. +- Right-click any commit and select **Inspect Details** -Open the Inspect View in GitLens. +[Open the Inspect View in GitLens](vscode://eamodio.gitlens/link/command/inspect) -#### Inline Blame and Hovers +### Explore Inline Blame and Hovers -From inside a file, Inline Blame and Hovers provide the answers to who exactly changed a specific line in a file, when, and why. To see the Inline Blame, select a file and then a line in the file. You can hover over the blame to take action on it such as viewing the previous revision, opening the pull request it was included in, opening the commit in the Commit Graph, and much more. +Inline Blame reveals who last modified each line and why. Hover over any line to: + +- View commit details +- Navigate to the previous revision +- Open the associated pull request +- See the commit in the Commit Graph + +These insights help you trace decisions and collaborate more effectively. *** -### Accelerate PR Reviews +## Accelerate PR Reviews +
+
Video: Review pull requests without leaving your IDE
+
-

 

+Manually switching between browser tabs, emails, and PR tools can interrupt your development flow. GitLens helps you stay focused in Visual Studio Code by organizing pull request tasks and supporting multiple workspaces with worktrees. + +### Launchpad `PRO` +
+

This feature is only available for Pro subscription tiers or higher.

+
+ +Launchpad provides a centralized view of your pull requests. You can: -Reviewing pull requests can be cumbersome due to needing to context switch to a browser to search through pull requests that are irrelevant to you. Email notification updates can interrupt your workflows when checking out branches if you have work in progress. With the use of Launchpad and Worktrees, GitLens offers the ability to see all pull requests that are organized in groups of actions that you need to take and utilize worktrees to simultaneously have separate working directories, all without leaving Visual Studio Code. +- Connect your [GitHub Integration](https://gitkraken.dev/settings/integrations?source=help_center&product=gitlens) +- View PRs by action status: needs review, follow-up, blocked, draft, and more +- Open pull requests in a new worktree or switch branches directly -#### Launchpad `PRO` +**To access Launchpad:** -To begin working with the Launchpad, connect the [GitHub Integration](gitkraken.dev/settings/integrations?source=help_center&product=gitlens). Once connected, you can access the Launchpad from the command palette (command/ctrl + shift + P) > _GitLens: Open Launchpad_. +- Open the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P`) and run **GitLens: Open Launchpad** -Here, you can see pull requests that are open on your current branch, blocked, need your review, require follow-up, waiting for a review, and in draft. +[Open the Launchpad in GitLens](vscode://eamodio.gitlens/link/command/launchpad) -To begin reviewing a pull request, simply select a pull request and then Open in Worktree or Switch to Branch or Worktree. -Open the Launchpad in GitLens. +### Worktrees + +### Worktrees
-

This feature is only available for Pro subscription tiers or higher

+

The Community plan supports only public and local repositories.

-#### Worktrees -Worktrees allow you to have separate working directories, meaning you can check out and work in multiple branches at once. This allows you to not need to commit or stash changes you are currently working on in order to review a pull request. +Worktrees let you check out multiple branches at once without stashing or committing changes in progress. This allows you to: -Once you have opened a worktree, you can easily begin reviewing all changes made in the Pull Request sidebar. You can see what commits have been made, what files have been changed, open the file diffs, and more. +- Review pull requests without leaving your current work +- Keep separate working directories for isolated tasks +- Open a worktree and inspect file diffs, commit history, and changed files directly from the Pull Request sidebar -Open the Worktree View in GitLens. +**To open Worktree View:** -
-

Community plan is restricted to public and local repositories only.

-
+[Open the Worktree View in GitLens](vscode://eamodio.gitlens/link/command/worktrees) *** -### Streamline Collaboration +## Streamline Team Collaboration +
+
Video: Share code and suggest changes in GitLens
+
-

 

- -When collaborating with others in a repository, it can be difficult to share code without bloating your repository with multiple commits and branches that may not be ready to contribute to the remote. Additionally, pull request reviews can be limiting for what you have access to review, comment on, and does not give you the ability to review files that have not been modified. With the use of Cloud Patches and Code Suggest, GitLens offers the ability to easily share code without needing to commit/push it to a remote and allows you to suggest code changes to any file in the repository. +GitLens enables flexible collaboration without needing to commit or push unfinished code. Use **Cloud Patches** to share changes privately and **Code Suggest** to offer improvements across a pull request—even for unmodified files. -#### Cloud Patches `PRO` +### Cloud Patches `PRO` +
+

This feature is only available for Pro subscription tiers or higher.

+
-Cloud Patches are Git patches that can be shared with anyone in your GitKraken organization to quickly share code changes with others. It can be applied to their working directory to continue to collaborate on or commit to the repository. +Cloud Patches are sharable Git patches that can be applied across your GitKraken organization: -To create a cloud patch, make changes to any file in a repository and then save those changes. Then, use the command palette (command/ctrl + shift + P) > _GitLens: Share as Cloud Patch…_. +- Make and save changes to any file +- Open the Command Palette and run **GitLens: Share as Cloud Patch…** +- Select collaborators to notify via the Cloud Patch sidebar -When you select members to share it with, they will see this in the Cloud Patch sidebar to be able to apply to their working directory. +[Open the Cloud Patches View in GitLens](vscode://eamodio.gitlens/link/command/cloud-patches) -Open the Cloud Patches View in GitLens. +### Code Suggest `PRO`
-

This feature is only available for Pro subscription tiers or higher

+

This feature is only available for Pro subscription tiers or higher.

-#### Code Suggest `PRO` - -Code Suggest allows you to make edits across the entire repository that can be submitted to anyone's open pull request. +Suggest code edits to any file—even those not changed in the original PR: -To create a Code Suggestion, have a branch checked out with an open pull request, make changes to any files and save those changes. Then, use the command palette (command/ctrl + shift + P) > _GitLens: Show inspect view_ > Suggest Changes for PR. +- Check out a branch with an open pull request +- Make and save your proposed changes +- Open the Command Palette and run **GitLens: Show Inspect View**, then choose **Suggest Changes for PR** -The pull request creator can then review these changes, apply them to their working directory to continue updating them, and accept the changes to commit/push them to the pull request. - -
-

This feature is only available for Pro subscription tiers or higher

-
+The pull request owner can apply, modify, and commit these suggestions to streamline reviews and collaboration. *** -### Improve Workflows With Integrations +## Connect GitLens to External Services +
+
Video: Use integrations and autolinks to connect GitLens to tools like Jira
+
-

 

+Boost your productivity by integrating GitLens with platforms like GitHub, GitLab, Azure DevOps, Bitbucket, Jira, and Trello. Reduce context switching and bring external issue tracking directly into your Git workflows. -Enhance your productivity in GitLens by reducing context switching and automating your workflow with Integrations and Autolinks. By connecting to platforms like GitHub, GitLab, Azure DevOps, and Bitbucket, you can seamlessly sync repositories and track issues within Launchpad—your PR hub. Additionally, Autolinks enables automatic linking to external services, making it easy to reference issues from platforms like Jira and Trello directly in your workflow. +### Integrations -#### Integrations +Connect GitLens to your code host and issue tracker to: -Connect GitLens to your providers—GitHub, GitLab, Azure DevOps, and Bitbucket—to keep repositories in sync and track issues effortlessly in Launchpad. These integrations reduce the need for context switching, allowing you to focus on coding without leaving GitLens. +- Sync and manage repositories inside Launchpad +- Automatically show pull requests and issues related to your branch +- Avoid switching between your editor and browser -#### Autolinks +To set up an integration, go to **Settings > Integrations** or visit the [GitLens Integrations Settings](https://gitkraken.dev/settings/integrations?source=help_center&product=gitlens). -GitLens integrations come with automatic linking capabilities, allowing you to link to external services like Jira and Trello. This feature lets you easily reference issues and tickets within your workflow. +### Autolinks -Create custom autolinks with pattern-matching rules for a more tailored experience. This enables you to link external references, such as Jira issues or Zendesk tickets, directly in your commit messages, helping you maintain clear and accessible documentation for each change. +Autolinks let you automatically link external issues—like Jira tickets or Trello cards—directly in commit messages, file annotations, and code lenses. -*** - -## Other places to check out +You can also create custom autolinks by defining pattern-matching rules for external references like Zendesk or Linear. This helps keep your codebase traceable and well-documented. -Looking to submit a feature request or bug report? Check out the GitHub.com public repository. -[GitHub Repository](https://github.com/gitkraken/vscode-gitlens) +--- -Join our public slack community and interact with other GitKraken GitLens users from around the world 🌐. -[GitKraken Slack](https://slack.gitkraken.com/) +## Other Resources -Didn't find what you're looking for in all of our documentation and help articles? Paid users can reach out to our support team. -[Contact Support](https://help.gitkraken.com/gitlens/gl-contact-support) +- 📌 [GitHub Repository](https://github.com/gitkraken/vscode-gitlens) — Submit feature requests or bug reports +- 💬 [Join GitKraken Slack](https://slack.gitkraken.com/) — Connect with the GitLens community +- 🛠️ [Contact Support](https://help.gitkraken.com/gitlens/gl-contact-support) — Paid users can get direct help from our support team