Skip to content

Commit b85c594

Browse files
jjsilva4jjsilva4
committed
Updates GitLens Workspaces documentation
Adds a new Workspaces documentation page with detailed instructions and screenshots for managing multiple repositories. Replaces the old, less detailed version and standardizes image class names for consistency.
1 parent ed6d074 commit b85c594

File tree

2 files changed

+97
-35
lines changed

2 files changed

+97
-35
lines changed

‎gitlens/GL-GK-Account.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ When prompted with the login screen, select **Create an account** to begin. Choo
2929
- [Single Sign-On (SSO)](/gk-dev/gk-dev-single-sign-on/)
3030

3131
<figure>
32-
<img src="/wp-content/uploads/gk-dev-create-account.png" alt="GitKraken account creation screen with multiple login options" class="img-responsive center img-bordered">
32+
<img src="/wp-content/uploads/gk-dev-create-account.png" alt="GitKraken account creation screen with multiple login options" class="help-center-img center img-bordered">
3333
<figcaption style="text-align: center; color: #888">Select a login method to create your GitKraken account</figcaption>
3434
</figure>
3535

@@ -51,7 +51,7 @@ To change your avatar, click your profile picture. This will redirect you to [Gr
5151
> It may take several hours for avatar changes to appear in GitKraken.
5252
5353
<figure>
54-
<img src="/wp-content/uploads/gk-dev-account-personalization.png" srcset="/wp-content/uploads/gk-dev-account-personalization@2x.png" alt="GitKraken account personalization options" class="img-responsive center img-bordered">
54+
<img src="/wp-content/uploads/gk-dev-account-personalization.png" srcset="/wp-content/uploads/gk-dev-account-personalization@2x.png" alt="GitKraken account personalization options" class="help-center-img center img-bordered">
5555
<figcaption style="text-align: center; color: #888">Customize your name, email, avatar, and password</figcaption>
5656
</figure>
5757

‎gitlens/GL-Workspaces.md

Lines changed: 95 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,141 @@
11
---
2-
3-
title: Gitlens Workspaces
4-
description: Explore Workspaces in Gitlens
2+
title: Manage Multiple Repositories with GitLens Workspaces
3+
description: Learn how to create and use Workspaces in GitLens to organize your repositories
54
taxonomy:
65
category: gitlens
7-
86
---
97

8+
<kbd>Last updated: July 2025</kbd>
9+
10+
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.
1011

11-
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.
12+
A Workspace can include:
13+
- **Local repositories**: The ones currently open in your VS Code window.
14+
- **Cloud Workspaces**: Hosted by GitKraken and accessible anywhere (GitKraken account required).
1215

13-
Whether you're working individually or collaborating with a team, these new features are designed to help you work more efficiently and effectively.
16+
> 💡 **Note:** Shared cloud Workspaces require a GitKraken trial or subscription.
1417
15-
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.
18+
### Accessing Workspaces
1619

17-
Please note that while using cloud workspaces requires a GitKraken account, shared cloud workspaces require a trial or subscription.
20+
You can open your Workspaces in two ways:
1821

19-
<img src="/wp-content/uploads/gl-workspaces-sidebar.png" class="help-center-img img-bordered">
22+
1. Click the **GitLens Home** icon in the Activity Bar.
23+
2. Use the Command Palette (`Cmd+Shift+P` or `Ctrl+Shift+P`) and search for `GitLens: Open Workspaces`.
24+
25+
<figure>
26+
<img src="/wp-content/uploads/gl-workspaces-sidebar.png" class="help-center-img img-bordered">
27+
<figcaption style="text-align: center; color: #888">Workspaces section in the GitLens Home panel</figcaption>
28+
</figure>
2029

2130
### Creating a Workspace
2231

23-
To create a workspace, tap the '+' button next to GitKraken Workspaces, provide a name and a description, and connect a provider if you wish.
32+
To create a new GitLens Workspace:
33+
34+
1. In the GitLens Home panel, click the **+** button next to **GitKraken Workspaces**.
35+
2. Enter a **name** and an optional **description**.
36+
3. (Optional) Connect a Git provider (such as GitHub or GitLab) to link repositories.
2437

25-
<img src="/wp-content/uploads/gl-create-workspace.png" class="help-center-img img-bordered">
38+
<figure>
39+
<img src="/wp-content/uploads/gl-create-workspace.png" class="help-center-img img-bordered">
40+
<figcaption style="text-align: center; color: #888">Create Workspace dialog with name, description, and provider options</figcaption>
41+
</figure>
2642

2743
### Adding Repositories
2844

29-
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.
45+
To add repositories to a Workspace:
46+
47+
1. Click the **+** button under the **Workspace** tab.
48+
2. To sync repository status, click the **Refresh** icon.
3049

31-
<img src="/wp-content/uploads/gl-add-repo-to-workspace.png" class="help-center-img img-bordered">
50+
<figure>
51+
<img src="/wp-content/uploads/gl-add-repo-to-workspace.png" class="help-center-img img-bordered">
52+
<figcaption style="text-align: center; color: #888">Add repositories to your Workspace</figcaption>
53+
</figure>
3254

3355
### Locating Repositories
3456

35-
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.
57+
To find the disk location of a repository in a Cloud Workspace:
3658

37-
<img src="/wp-content/uploads/gl-locate-repo-in-workspace.png" class="help-center-img img-bordered">
59+
1. Click the **Locate Repositories** (pin icon) next to the repository name.
60+
2. If you have a folder with multiple repositories, select the parent folder. GitLens will detect and associate all repositories within it.
61+
62+
<figure>
63+
<img src="/wp-content/uploads/gl-locate-repo-in-workspace.png" class="help-center-img img-bordered">
64+
<figcaption style="text-align: center; color: #888">Locate local disk path of repositories in your Workspace</figcaption>
65+
</figure>
3866

3967
### Opening Repositories
4068

41-
To open a repository from a Workspace tap the 'Open Repository in New Window' icon.
69+
To open a repository from a Workspace:
4270

43-
_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'._
71+
- Click the **Open Repository in New Window** icon.
72+
- _Pro Tip:_ To open the repository in the **current window**, hold the **Alt/Option** key (Mac) while clicking **Open Repo**.
4473

45-
<img src="/wp-content/uploads/gl-open-as-vscode-workspace.png" class="help-center-img img-bordered">
74+
<figure>
75+
<img src="/wp-content/uploads/gl-open-as-vscode-workspace.png" class="help-center-img img-bordered">
76+
<figcaption style="text-align: center; color: #888">Open repositories from a Workspace in VS Code</figcaption>
77+
</figure>
4678

4779
### Removing Repositories
4880

49-
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'.
81+
To remove a repository from a Workspace:
82+
83+
1. Right-click the repository.
84+
2. Select **Remove repository from Workspace** from the context menu.
5085

51-
<img src="/wp-content/uploads/gl-remove-repo-from-wrokspace.png" class="help-center-img img-bordered">
86+
<figure>
87+
<img src="/wp-content/uploads/gl-remove-repo-from-wrokspace.png" class="help-center-img img-bordered">
88+
<figcaption style="text-align: center; color: #888">Remove repositories from a Workspace</figcaption>
89+
</figure>
5290

5391
### Converting to Cloud Workspaces
5492

55-
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.
93+
To convert a local VS Code workspace into a GitKraken Cloud Workspace:
94+
95+
1. Click the **Convert to Cloud Workspace** icon.
96+
2. Enter a **name** and **description**.
97+
98+
Your Cloud Workspace will be synced to your GitKraken account and accessible via GitKraken Desktop, GitLens, and the GitKraken CLI.
99+
100+
<figure>
101+
<img src="/wp-content/uploads/gl-convert-workspace-to-cloud.png" class="help-center-img img-bordered">
102+
<figcaption style="text-align: center; color: #888">Convert local Workspace to GitKraken Cloud Workspace</figcaption>
103+
</figure>
56104

57-
<img src="/wp-content/uploads/gl-convert-workspace-to-cloud.png" class="help-center-img img-bordered">
105+
### Understanding Workspace Indicators and Colors
58106

59-
### Understanding Workspace indicators and colors
107+
Visual indicators in Workspaces help you quickly understand their status. For example:
108+
- A **green Workspace** with an **O** symbol indicates it is open in your current window.
60109

61-
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.
110+
<figure>
111+
<img src="/wp-content/uploads/gl-workspace-indicators.png" class="help-center-img img-bordered">
112+
<figcaption style="text-align: center; color: #888">Workspace status indicators</figcaption>
113+
</figure>
62114

63-
<img src="/wp-content/uploads/gl-workspace-indicators.png" class="help-center-img img-bordered">
115+
### Workspace Linking
64116

65-
### Workspace linking
117+
You can link a VS Code workspace to a GitKraken Workspace:
66118

67-
A VS Code workspace can be created from a GitKraken Workspace to link them.
119+
1. Create a VS Code workspace from an existing GitKraken Cloud Workspace.
120+
2. Use the **Open VS Code Workspace in New Window** option (hold **Alt** to open in the current window).
68121

69-
<img src="/wp-content/uploads/gl-create-vs-workspace-from-gl.png" class="help-center-img img-bordered">
122+
<figure>
123+
<img src="/wp-content/uploads/gl-create-vs-workspace-from-gl.png" class="help-center-img img-bordered">
124+
<figcaption style="text-align: center; color: #888">Create a VS Code workspace from a GitKraken Workspace</figcaption>
125+
</figure>
70126

71-
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).
127+
When opening a linked workspace, you can choose how to handle repository auto-adding:
128+
- Automatically add repositories
129+
- Prompt before adding
130+
- Disable auto-adding
72131

73-
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.
132+
This behavior is configurable during setup or later via the `Change Linked Workspace Auto-Add Behavior` command.
74133

75-
<img src="/wp-content/uploads/gl-link-repositories-in-workspaces.png" class="help-center-img img-bordered">
134+
To manually sync repositories:
135+
- Use the `Add Repositories from Linked Workspace` command at any time.
76136

77-
You can also manually add repositories to the VS Code workspace at any time using the new `Add Repositories from Linked Workspace` command.
137+
<figure>
138+
<img src="/wp-content/uploads/gl-link-repositories-in-workspaces.png" class="help-center-img img-bordered">
139+
<figcaption style="text-align: center; color: #888">Manage repository linking for VS Code and GitKraken Workspaces</figcaption>
140+
</figure>
78141

79-
***

0 commit comments

Comments
 (0)