You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-13Lines changed: 6 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,6 @@ Install GitLens by clicking `Install` on the banner above, or from the Extension
18
18
19
19
> Have questions or concerns? Talk to our engineering team directly through our [GitHub Discussions](https://github.com/gitkraken/vscode-gitlens/discussions/categories/feedback) page. Having a positive experience with GitLens? Feel free to [write a review](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens&ssr=false#review-details).
20
20
21
-
22
21
## GitLens Editions: Free and Pro
23
22
24
23
**GitLens Free** gives you powerful tools to manage Git and understand how your code has evolved and by whom. With popular features like in-editor blame annotations, hovers, and CodeLens, you can see actionable authorship details at the top of each file. Track the history of any file over time using Revision Navigation to gain deeper insights into code changes.
@@ -45,13 +44,12 @@ You can [try GitLens Pro for free](https://gitkraken.dev/register?product=gitlen
45
44
46
45
GitLens offers a wide range of features—here are the three most popular workflows that users rely on to boost their productivity:
47
46
48
-
-[**Interactive Code History**](#interactive-code-history)— Understanding code in repositories with multiple branches and contributors can be difficult. GitLens provides the context you need with tools like blame, hovers, and file annotations. But it doesn’t stop there—the interactive Commit Graph lets you create branches, rebase, revert, and more, all with powerful search capabilities.
47
+
-[**Interactive Code History**](#interactive-code-history)— Understanding code in repositories with multiple branches and contributors can be difficult. GitLens provides the context you need with tools like blame, hovers, and file annotations. But it doesn’t stop there—the interactive Commit Graph lets you create branches, rebase, revert, and more, all with powerful search capabilities.
49
48
50
-
-[**Accelerate PR Reviews**](#accelerate-pr-reviews)— Reduce context switching and manage all your PRs in one place. Prioritize tasks and identify bottlenecks right in VS Code with Launchpad when you integrate Github or other host providers. Work on multiple branches at once without disrupting your main workspace with Worktrees.
49
+
-[**Accelerate PR Reviews**](#accelerate-pr-reviews)— Reduce context switching and manage all your PRs in one place. Prioritize tasks and identify bottlenecks right in VS Code with Launchpad when you integrate Github or other host providers. Work on multiple branches at once without disrupting your main workspace with Worktrees.
51
50
52
51
-[**Streamline Collaboration**](#streamline-collaboration)— GitLens isn’t just for solo developers—it’s designed to enhance team collaboration. With Cloud Patches and Code Suggest, you can share and discuss suggested changes with any GitLens or GitKraken user, on multiple files and even PRs.
53
52
54
-
55
53
# Interactive Code History
56
54
57
55
Understanding who made changes, when, and why can be challenging. GitLens simplifies this with tools like the Commit Graph, Inspect, Inline Blame, and Hovers, giving you clear context and insights. Quickly explore your repository's history with intuitive visuals and actionable tools.
@@ -147,17 +145,14 @@ Launchpad consolidates all your GitHub pull requests into a unified, actionable
147
145
148
146
Worktrees enable efficient multitasking by allowing you to work on multiple branches without stashing changes or leaving your current branch. They preserve your workflow while letting you shift focus when needed. For example, you can easily review a pull request on a worktree in a separate VS Code window with GitLens.
GitLens isn’t just for solo developers—it’s designed to enhance team collaboration. Sharing code can be tricky without adding noise to your repository with extra commits or branches. GitLens simplifies this with Cloud Patches and Code Suggest, letting you share or propose changes to any file in the repository without committing or pushing to a remote.
159
155
160
-
161
156
## Cloud Patches `Preview`
162
157
163
158
Easily and securely share code changes by creating a Cloud Patch from your work-in-progress, commit, or stash, and sharing a link with teammates or other developers. Cloud Patches enable early collaboration for feedback on direction and approach, reducing rework and streamlining your workflow. [Learn more](https://gitkraken.com/solutions/cloud-patches?utm_source=gitlens-extension&utm_medium=in-app-links)
@@ -195,12 +190,11 @@ An x-ray or developer tools Inspect into your code, focused on providing context
195
190
196
191
### GitLens
197
192
198
-
Quick access to many GitLens features. Also the home of GitKraken teams and collaboration services (e.g. GitKraken Workspaces), help, and support.
193
+
Quick access to many GitLens features. Also the home of GitKraken teams and collaboration services (e.g. Cloud Patches, Cloud Workspaces), help, and support.
199
194
200
195
-**Home**— Quick access to many features.
201
196
-[**Cloud Patches `Preview`**](#cloud-patches-preview)— Easily and securely share code with your teammates
202
-
-[**GitKraken Workspaces `Preview`**](#gitkraken-workspaces-preview)— Easily group and manage multiple repositories together, accessible from anywhere, streamlining your workflow.
203
-
-**GitKraken Account**— Power-up with GitKraken Cloud Services.
197
+
-[**Cloud Workspaces `Preview`**](#gitkraken-workspaces-preview)— Easily group and manage multiple repositories together, accessible from anywhere, streamlining your workflow.
204
198
205
199
### Source Control
206
200
@@ -219,9 +213,9 @@ Shows additional views that are focused on exploring and managing your repositor
219
213
220
214
Convenient and easy access to the Commit Graph with a dedicated details view.
221
215
222
-
## GitKraken Workspaces `Preview`
216
+
## Cloud Workspaces `Preview`
223
217
224
-
GitKraken Workspaces allow you to easily group and manage multiple repositories together, accessible from anywhere, streamlining your workflow. Create workspaces just for yourself or share (coming soon in GitLens) them with your team for faster onboarding and better collaboration. [Learn more](https://gitkraken.com/solutions/workspaces?utm_source=gitlens-extension&utm_medium=in-app-links)
218
+
Cloud Workspaces allow you to easily group and manage multiple repositories together, accessible from anywhere, streamlining your workflow. Create workspaces just for yourself or share (coming soon in GitLens) them with your team for faster onboarding and better collaboration. [Learn more](https://gitkraken.com/solutions/workspaces?utm_source=gitlens-extension&utm_medium=in-app-links)
225
219
226
220
## Visual File History `Pro`
227
221
@@ -261,7 +255,6 @@ Use a series of new commands to:
261
255
- View and explore your stashes
262
256
- Visualize the current repository status
263
257
264
-
265
258
# Integrations
266
259
267
260
Context switching kills productivity. GitLens not only reveals buried knowledge within your repository, it also brings additional context from issues and pull requests providing you with a wealth of information and insights at your fingertips.
"Compares the working tree with a user-selected reference"
3154
3154
],
3155
3155
"default": "working",
3156
-
"markdownDescription": "Specifies whether to show a comparison of the current branch or the working tree with a user-selected reference (branch, tag, etc) in the _GitKraken Workspaces_ view",
3156
+
"markdownDescription": "Specifies whether to show a comparison of the current branch or the working tree with a user-selected reference (branch, tag, etc) in the _Cloud Workspaces_ view",
3157
3157
"scope": "window",
3158
3158
"order": 10
3159
3159
},
3160
3160
"gitlens.views.workspaces.showUpstreamStatus": {
3161
3161
"type": "boolean",
3162
3162
"default": true,
3163
-
"markdownDescription": "Specifies whether to show the upstream status of the current branch for each repository in the _GitKraken Workspaces_ view",
3163
+
"markdownDescription": "Specifies whether to show the upstream status of the current branch for each repository in the _Cloud Workspaces_ view",
3164
3164
"scope": "window",
3165
3165
"order": 11
3166
3166
},
3167
3167
"gitlens.views.workspaces.includeWorkingTree": {
3168
3168
"type": "boolean",
3169
3169
"default": false,
3170
-
"markdownDescription": "Specifies whether to include working tree file status for each repository in the _GitKraken Workspaces_ view",
3170
+
"markdownDescription": "Specifies whether to include working tree file status for each repository in the _Cloud Workspaces_ view",
"markdownDescription": "Specifies whether to query for pull requests associated with branches and commits in the _GitKraken Workspaces_ view. Requires a connection to a supported remote service (e.g. GitHub)",
3177
+
"markdownDescription": "Specifies whether to query for pull requests associated with branches and commits in the _Cloud Workspaces_ view. Requires a connection to a supported remote service (e.g. GitHub)",
"markdownDescription": "Specifies whether to show pull requests (if any) associated with branches in the _GitKraken Workspaces_ view. Requires a connection to a supported remote service (e.g. GitHub)",
3184
+
"markdownDescription": "Specifies whether to show pull requests (if any) associated with branches in the _Cloud Workspaces_ view. Requires a connection to a supported remote service (e.g. GitHub)",
"markdownDescription": "Specifies whether to show pull requests (if any) associated with commits in the _GitKraken Workspaces_ view. Requires a connection to a supported remote service (e.g. GitHub)",
3191
+
"markdownDescription": "Specifies whether to show pull requests (if any) associated with commits in the _Cloud Workspaces_ view. Requires a connection to a supported remote service (e.g. GitHub)",
3192
3192
"scope": "window",
3193
3193
"order": 22
3194
3194
},
3195
3195
"gitlens.views.workspaces.showCommits": {
3196
3196
"type": "boolean",
3197
3197
"default": true,
3198
-
"markdownDescription": "Specifies whether to show the commits on the current branch for each repository in the _GitKraken Workspaces_ view",
3198
+
"markdownDescription": "Specifies whether to show the commits on the current branch for each repository in the _Cloud Workspaces_ view",
3199
3199
"scope": "window",
3200
3200
"order": 30
3201
3201
},
3202
3202
"gitlens.views.workspaces.showBranches": {
3203
3203
"type": "boolean",
3204
3204
"default": true,
3205
-
"markdownDescription": "Specifies whether to show the branches for each repository in the _GitKraken Workspaces_ view",
3205
+
"markdownDescription": "Specifies whether to show the branches for each repository in the _Cloud Workspaces_ view",
3206
3206
"scope": "window",
3207
3207
"order": 31
3208
3208
},
3209
3209
"gitlens.views.workspaces.showRemotes": {
3210
3210
"type": "boolean",
3211
3211
"default": true,
3212
-
"markdownDescription": "Specifies whether to show the remotes for each repository in the _GitKraken Workspaces_ view",
3212
+
"markdownDescription": "Specifies whether to show the remotes for each repository in the _Cloud Workspaces_ view",
3213
3213
"scope": "window",
3214
3214
"order": 32
3215
3215
},
3216
3216
"gitlens.views.workspaces.showStashes": {
3217
3217
"type": "boolean",
3218
3218
"default": true,
3219
-
"markdownDescription": "Specifies whether to show the stashes for each repository in the _GitKraken Workspaces_ view",
3219
+
"markdownDescription": "Specifies whether to show the stashes for each repository in the _Cloud Workspaces_ view",
3220
3220
"scope": "window",
3221
3221
"order": 33
3222
3222
},
3223
3223
"gitlens.views.workspaces.showTags": {
3224
3224
"type": "boolean",
3225
3225
"default": true,
3226
-
"markdownDescription": "Specifies whether to show the tags for each repository in the _GitKraken Workspaces_ view",
3226
+
"markdownDescription": "Specifies whether to show the tags for each repository in the _Cloud Workspaces_ view",
3227
3227
"scope": "window",
3228
3228
"order": 34
3229
3229
},
3230
3230
"gitlens.views.workspaces.showContributors": {
3231
3231
"type": "boolean",
3232
3232
"default": true,
3233
-
"markdownDescription": "Specifies whether to show the contributors for each repository in the _GitKraken Workspaces_ view",
3233
+
"markdownDescription": "Specifies whether to show the contributors for each repository in the _Cloud Workspaces_ view",
3234
3234
"scope": "window",
3235
3235
"order": 35
3236
3236
},
3237
3237
"gitlens.views.workspaces.showWorktrees": {
3238
3238
"type": "boolean",
3239
3239
"default": true,
3240
-
"markdownDescription": "Specifies whether to show the worktrees for each repository in the _GitKraken Workspaces_ view",
3240
+
"markdownDescription": "Specifies whether to show the worktrees for each repository in the _Cloud Workspaces_ view",
"markdownDescription": "Specifies whether to show the experimental incoming activity for each repository in the _GitKraken Workspaces_ view",
3247
+
"markdownDescription": "Specifies whether to show the experimental incoming activity for each repository in the _Cloud Workspaces_ view",
3248
3248
"scope": "window",
3249
3249
"order": 37
3250
3250
},
3251
3251
"gitlens.views.workspaces.avatars": {
3252
3252
"type": "boolean",
3253
3253
"default": true,
3254
-
"markdownDescription": "Specifies whether to show avatar images instead of commit (or status) icons in the _GitKraken Workspaces_ view",
3254
+
"markdownDescription": "Specifies whether to show avatar images instead of commit (or status) icons in the _Cloud Workspaces_ view",
3255
3255
"scope": "window",
3256
3256
"order": 60
3257
3257
},
@@ -3266,7 +3266,7 @@
3266
3266
"Displays branches as a list",
3267
3267
"Displays branches as a tree when branch names contain slashes `/`"
3268
3268
],
3269
-
"markdownDescription": "Specifies how the _GitKraken Workspaces_ view will display branches",
3269
+
"markdownDescription": "Specifies how the _Cloud Workspaces_ view will display branches",
3270
3270
"scope": "window",
3271
3271
"order": 70
3272
3272
},
@@ -3283,21 +3283,21 @@
3283
3283
"Displays files as a list",
3284
3284
"Displays files as a tree"
3285
3285
],
3286
-
"markdownDescription": "Specifies how the _GitKraken Workspaces_ view will display files",
3286
+
"markdownDescription": "Specifies how the _Cloud Workspaces_ view will display files",
3287
3287
"scope": "window",
3288
3288
"order": 80
3289
3289
},
3290
3290
"gitlens.views.workspaces.files.threshold": {
3291
3291
"type": "number",
3292
3292
"default": 5,
3293
-
"markdownDescription": "Specifies when to switch between displaying files as a `tree` or `list` based on the number of files in a nesting level in the _GitKraken Workspaces_ view. Only applies when `#gitlens.views.workspaces.files.layout#` is set to `auto`",
3293
+
"markdownDescription": "Specifies when to switch between displaying files as a `tree` or `list` based on the number of files in a nesting level in the _Cloud Workspaces_ view. Only applies when `#gitlens.views.workspaces.files.layout#` is set to `auto`",
3294
3294
"scope": "window",
3295
3295
"order": 81
3296
3296
},
3297
3297
"gitlens.views.workspaces.files.compact": {
3298
3298
"type": "boolean",
3299
3299
"default": true,
3300
-
"markdownDescription": "Specifies whether to compact (flatten) unnecessary file nesting in the _GitKraken Workspaces_ view. Only applies when `#gitlens.views.workspaces.files.layout#` is set to `tree` or `auto`",
3300
+
"markdownDescription": "Specifies whether to compact (flatten) unnecessary file nesting in the _Cloud Workspaces_ view. Only applies when `#gitlens.views.workspaces.files.layout#` is set to `tree` or `auto`",
3301
3301
"scope": "window",
3302
3302
"order": 82
3303
3303
},
@@ -3312,14 +3312,14 @@
3312
3312
"Shows the file's status as the icon",
3313
3313
"Shows the file's type (theme icon) as the icon"
3314
3314
],
3315
-
"markdownDescription": "Specifies how the _GitKraken Workspaces_ view will display file icons",
3315
+
"markdownDescription": "Specifies how the _Cloud Workspaces_ view will display file icons",
3316
3316
"scope": "window",
3317
3317
"order": 83
3318
3318
},
3319
3319
"gitlens.views.workspaces.compact": {
3320
3320
"type": "boolean",
3321
3321
"default": false,
3322
-
"markdownDescription": "Specifies whether to show the _GitKraken Workspaces_ view in a compact display density",
3322
+
"markdownDescription": "Specifies whether to show the _Cloud Workspaces_ view in a compact display density",
3323
3323
"scope": "window",
3324
3324
"order": 90
3325
3325
},
@@ -3337,7 +3337,7 @@
3337
3337
"Compares the branch with a user-selected reference"
3338
3338
],
3339
3339
"default": "branch",
3340
-
"markdownDescription": "Specifies whether to show a comparison of the branch with a user-selected reference (branch, tag, etc) under each branch in the _GitKraken Workspaces_ view",
3340
+
"markdownDescription": "Specifies whether to show a comparison of the branch with a user-selected reference (branch, tag, etc) under each branch in the _Cloud Workspaces_ view",
0 commit comments