Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions gitlens/GL-New-Page-Template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---

title: New Page Title
description: New Page Description
taxonomy:
category: gitlens

---

5 changes: 3 additions & 2 deletions gitlens/gitlens-community-vs-gitlens-pro.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,9 @@ GitLens Pro takes your workflow to the next level by unlocking advanced features
### Making Your Choice

Both GitLens Community and Pro provide valuable tools to support your Git workflows. The Community edition is an excellent choice if you're looking for a powerful free VS Code Git management tool. If your work involves PR reviews, collaborative workflows, and advanced Git actions, upgrading to GitLens Pro will unlock new features and workflows to increase your developer productivity.
_Both editions are backed by our commitment to enhancing your development experience. Start with Community and upgrade to Pro when you need additional horsepower for your workflows._

<img src="/wp-content/uploads/gl-community-vs-pro.png" class="img-bordered img-responsive center" style="padding-left: 20%; padding-right: 20%;">

_Both editions are backed by our commitment to enhancing your development experience. Start with Community and upgrade to Pro when you need additional horsepower for your workflows._

**_Choose Community if you want:_**

Expand All @@ -47,12 +46,14 @@ _Both editions are backed by our commitment to enhancing your development experi

**_Upgrade to Pro if you need:_**

* _AI-powered automation for Git workflows_
* _Streamlined PR review workflows_
* _Advanced Git operations and visualization_
* _Cross-platform integration capabilities_
* _Team collaboration features_
* _Enhanced productivity tools for professional development_


### Get Started with GitLens Pro Today

<a class="button button--basic" href="https://gitkraken.dev/register?product=gitlens&source=marketing_page&redirect_uri=vscode%3A%2F%2Feamodio.gitlens%2Flogin&flow=gitlens_web&utm_source=website&utm_medium=help-center&utm_campaign=pro-vs-community-pg&utm_content=button" target="_blank">Try GitLens Pro for free</a>
Expand Down
67 changes: 57 additions & 10 deletions gitlens/gitlens-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ taxonomy:

---

Features marked with `PRO` require a [trial or paid plan](https://www.gitkraken.com/gitlens/pricing) for use on privately hosted repos
Features marked with `PREVIEW` require a GitKraken Account, with access level based on your [plan](https://www.gitkraken.com/gitlens/pricing), e.g. Community, Pro, etc
Features marked with `PRO` require a [trial or paid plan](https://www.gitkraken.com/gitlens/pricing?source=help_center&product=gitlens) for use on privately hosted repos
Features marked with `PREVIEW` require a GitKraken Account, with access level based on your [plan](https://www.gitkraken.com/gitlens/pricing?source=help_center&product=gitlens), e.g. Community, Pro, etc

***

Expand Down Expand Up @@ -273,7 +273,7 @@ At the top of the commit graph the repository name, the branch name that is curr
<img src="/wp-content/uploads/graph-info.png" srcset="/wp-content/uploads/graph-info@2x.png" class="help-center-img img-bordered">

<div class='callout callout--basic'>
<p>Note: The Commit Graph is available to all users working on public repositories, and requires no account. Additionally, users with a paid GitLens subscription or trial can use the Commit Graph with private repos. </br></br>
<p>Note: The Commit Graph is available to all users working on public or local repositories, and requires no account. Additionally, users with a paid GitLens subscription or trial can use the Commit Graph with private repos. </br></br>

We’d love to hear your feedback in the <a href='https://github.com/gitkraken/vscode-gitlens/discussions/2158' target='_blank'>Commit Graph discussion on GitHub</a>.</p>
</div>
Expand Down Expand Up @@ -411,10 +411,13 @@ You can pin pull requests using the pin icon <i class="fa-solid fa-thumbtack"></
<div class='callout callout--basic'>
<p>Note: The Launchpad is currently organized by prioritizing items on the list that require more action by elevating them to the top. This is subject to change in the future.</p>
</div>
<div class='callout callout--warning'>
<p>This Feature is only available for Pro subscription tiers or higher</p>
</div>

***

## Visual File History `PRO`
## Visual File History

The Visual File History allows you to quickly see the evolution of a file, including when changes were made, how large they were, and who made them.

Expand All @@ -431,21 +434,57 @@ Gain additional insights on hover.

<img src="/wp-content/uploads/visual-file-history-hover.png" class="help-center-img img-bordered">

<div class='callout callout--warning'>
<p>Community plan is restricted to Public and Local Repositories only.</p>
</div>

***

## AI-Generated Commit Messages (Preview) `PRO`
## Gitkraken AI
### AI-Generated Commit Messages

Commit messages can be automatically generated using an AI Provider.
Commit messages can be automatically generated using Gitkraken AI.

<img src="/wp-content/uploads/gl-ai-generated-commit-message.gif" class="help-center-img img-bordered">

To connect an AI Provider, stage some changes you want to generate a commit message for and then run the `GitLens: Generate Commit Message (Experimental)` command from the Command Palette (`command/ctrl + shift + P`). From there you will be guided through the process of accepting to send the diff of your staged changes to the AI Provider and the entry of your AI Provider key. The API key can be created from your AI Provider's site. Once completed, the generated commit message will be entered into the commit input box on the Source Control sidebar. You can also enter additional context about your changes in the commit box and those will also be sent to help generate a better message. Additionally, you can customize the `gitlens.experimental.generateCommitMessagePrompt` setting to control the prompt used to structure and format the generated commit message. There are additional `gitlens.ai` settings that can be [customized](/gitlens/gitlens-settings/#misc-settings) for the provider and model.
To generate a commit message, stage the changes you want, then navigate to Home View and tap the "Generate Commit Message" button to generate a precise, descriptive commit messages based on your changes, or run the `GitLens: Generate Commit Message (Experimental)` command from the Command Palette (`command/ctrl + shift + P`). From there you will be guided through the process of accepting to send the diff of your staged changes to Gitkraken AI. Once completed, the generated commit message will be entered into the commit input box on the Source Control sidebar. You can also enter additional context about your changes in the commit box and those will also be sent to help generate a better message. Additionally, you can customize the `gitlens.experimental.generateCommitMessagePrompt` setting to control the prompt used to structure and format the generated commit message. There are additional `gitlens.ai` settings that can be [customized](/gitlens/gitlens-settings/#misc-settings) for the provider and model.

<div class='callout callout--warning'>
<p>Gitlens Pro users and above can also choose to provide their own API key in order to use a different AI provider. Gitkraken AI utilizes the Gemini 2.0 Flash model.</p>
</div>

### AI Stash Messages `Pro`
*Available in:* Pro, Advanced, and Business plans
Create intelligent descriptions for stashed changes, making it easier to find and understand your work later. This feature generates context-rich stash descriptions that help you quickly identify the purpose of each stash.
*How to access:*
- From the Command Palette: `GitLens: Generate Stash Message with AI`
- When creating a stash: Look for the AI option in the stash creation interface
- From the stash view: Generate descriptions for existing stashes

### AI Commit Explanations`Pro`
*Available in:* Pro, Advanced, and Business plans
Understand the reasoning behind changes with AI-generated explanations of commit content and purpose. Quickly grasp the intent and impact of complex commits without having to manually review all changed files.

*How to access:*
- In the "Commit Details" view: Find the AI explanation panel
- In the "Cloud Patch Details" view: Look for explanations alongside commit information
- When reviewing commits: Option to generate explanations for any selected commit

### AI Changelog Creation `Advanced`
*Available in:* Advanced and Business plans only
Automatically generate comprehensive changelogs from selected commits in the Graph, perfect for release documentation. Maintain consistent and detailed changelogs without manual effort.
*How to access:*
- In the Search/Compare view: Click the inline button on the "commits" line
- When selecting multiple commits in the Graph: Right-click and choose "Generate Changelog"
- From the Command Palette: `GitLens: Generate Changelog from Commits`

To remove your AI Provider API key in GitLens, run the command `GitLens: Reset Stored AI Keys...` from the Command Palette.
<div class='callout callout--basic'>
<p>More questions about Gitkraken AI? Please see our <a href="https://help.gitkraken.com/general/gitkraken-ai-faq/">GitKraken AI FAQ page</a> for more details</p>
</div>

***

##Git Command Palette
## Git Command Palette

<img src="/wp-content/uploads/git-command-palette.png" class="help-center-img img-bordered">

Expand Down Expand Up @@ -569,6 +608,10 @@ You will be prompted to log into your GitKraken account if you are not already.

<img src="/wp-content/uploads/gl-connect-remote-integration-manager.png" class="help-center-img img-bordered">

<div class='callout callout--warning'>
<p>Community users are limited to basic functionality only.</p>
</div>

## GitHub Enterprise Server and GitLab Self-Managed Integration `PRO`

GitLens Pro offers a richer integration with GitHub Enterprise Server and GitLab Self-Managed.
Expand Down Expand Up @@ -609,12 +652,16 @@ Or

***

## Jira Integration
## 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`.

<img src="/wp-content/uploads/gl-jira-integration.png" class="help-center-img img-bordered">

<div class='callout callout--warning'>
<p>This Feature is only available for Pro subscription tiers or higher</p>
</div>

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 gitkraken.dev/settings/integrations in a browser.

<img src="/wp-content/uploads/gl-cloud-integrations.png" class="help-center-img img-bordered">
Expand Down
21 changes: 17 additions & 4 deletions gitlens/gitlens-home.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ From inside a file, Inline Blame and Hovers provide the answers to who exactly c

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.

#### Launchpad
#### Launchpad `PRO`

To begin working with the Launchpad, connect the [GitHub Integration](gitkraken.dev/settings/integrations). Once connected, you can access the Launchpad from the command palette (command/ctrl + shift + P) > _GitLens: Open Launchpad_.

Expand All @@ -68,7 +68,9 @@ Here, you can see pull requests that are open on your current branch, blocked, n
To begin reviewing a pull request, simply select a pull request and then Open in Worktree or Switch to Branch or Worktree.

<a href="vscode://eamodio.gitlens/link/command/launchpad">Open the Launchpad in GitLens</a>.

<div class='callout callout--warning'>
<p>This feature is only available for Pro subscription tiers or higher</p>
</div>
#### 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.
Expand All @@ -77,6 +79,10 @@ Once you have opened a worktree, you can easily begin reviewing all changes made

<a href="vscode://eamodio.gitlens/link/command/worktrees">Open the Worktree View in GitLens</a>.

<div class='callout callout--warning'>
<p>Community plan is restricted to public and local repositories only.</p>
</div>

***

### Streamline Collaboration
Expand All @@ -89,7 +95,7 @@ Once you have opened a worktree, you can easily begin reviewing all changes made

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.

#### Cloud Patches
#### Cloud Patches `PRO`

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.

Expand All @@ -98,15 +104,22 @@ To create a cloud patch, make changes to any file in a repository and then save
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.

<a href="vscode://eamodio.gitlens/link/command/cloud-patches">Open the Cloud Patches View in GitLens</a>.
<div class='callout callout--warning'>
<p>This feature is only available for Pro subscription tiers or higher</p>
</div>

#### Code Suggest
#### Code Suggest `PRO`

Code Suggest allows you to make edits across the entire repository that can be submitted to anyone's open pull request.

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.

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.

<div class='callout callout--warning'>
<p>This feature is only available for Pro subscription tiers or higher</p>
</div>

***

### Improve Workflows With Integrations
Expand Down
Loading