5.3 KiB
| stage | group | info |
|---|---|---|
| Create | IDE | To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments |
Web IDE Beta (FREE)
- Introduced in GitLab 15.7 with a flag named
vscode_web_ide. Disabled by default.- Enabled on GitLab.com in GitLab 15.7.
- Enabled on self-managed in GitLab 15.11.
FLAG:
On self-managed GitLab, by default this feature is available. To hide the feature, ask an administrator to disable the feature flag named vscode_web_ide. On GitLab.com, this feature is available.
As announced in this blog post, the current implementation of the Web IDE is being replaced with an implementation powered by Visual Studio Code. This effort is still under development. For updates, see this epic.
To pair the Web IDE Beta with a Remote Development environment, see Remote Development.
Use the Web IDE Beta
To open the Web IDE Beta from anywhere in the UI:
- Use the . keyboard shortcut.
You can also open the Web IDE Beta when viewing a file, the repository file list, or a merge request.
Use when viewing a file or the repository file list
To open the Web IDE Beta from a file or the repository file list:
- In the upper-right corner of the page, select Open in Web IDE.
If Open in Web IDE is not visible:
- Next to Edit or Gitpod, select the down arrow ({chevron-lg-down}).
- From the list, select Open in Web IDE.
- Select Open in Web IDE.
Use when viewing a merge request
To open the Web IDE Beta from a merge request:
- Go to your merge request.
- In the upper-right corner, select Code > Open in Web IDE.
The Web IDE Beta opens new and modified files in separate tabs and displays changes side by side with the original source. To optimize loading time, only the top 10 files (by number of lines changed) are opened automatically.
In the file tree, any new or modified file in the merge request is indicated by an icon next to the filename. To view changes to a file, right-click the filename and select Compare with merge request base.
Open a file in the Web IDE Beta
To open any file by its name:
- Press Command+P.
- Enter the name of your file.
Switch branches
The Web IDE Beta uses the currently selected branch by default. To switch branches in the Web IDE Beta:
- On the status bar, in the lower-left corner, select the current branch name.
- In the search box, start typing the branch name.
- From the dropdown list, select the branch.
Create a branch
To create a branch from the current branch in the Web IDE Beta:
- On the status bar, in the lower-left corner, select the current branch name.
- From the dropdown list, select Create new branch....
- Enter the branch name.
- Press Enter.
If you don't have write access to the repository, Create new branch... is not visible.
Search across files
You can use VS Code to quickly search all files in the opened folder.
To search across files:
- Press Shift+Command+F.
- Enter your search term.
In the Web IDE Beta, only partial results from opened files are displayed. Full file search is planned for a later date.
View a list of changed files
To view a list of files you changed in the Web IDE Beta,
on the Activity Bar on the left, select Source Control.
Your CHANGES, STAGED CHANGES, and MERGE CHANGES are displayed.
For details, see the VS Code documentation.
Commit changes
To commit your changes in the Web IDE Beta:
- On the Activity Bar on the left, select Source Control, or press Control+Shift+G.
- Enter your commit message.
- Select Commit & Push.
- Commit to the current branch, or create a new branch.
Open the command palette
In the Web IDE Beta, you can access many commands through the command palette. To open the command palette and run a command in the Web IDE Beta:
- Press F1 or Shift+Command+P.
- In the search box, start typing the command name.
- From the dropdown list, select the command.
Stop using the Web IDE Beta
If you do not want to use the Web IDE Beta, you can change your personal preferences.
- On the top bar, in the upper-right corner, select your avatar.
- Select Preferences.
- In the Web IDE section, select the Opt out of the Web IDE Beta checkbox.
- Select Save changes.
Known issues
The Web Terminal and Live Preview are not available in the Web IDE Beta.
These features might become available at a later date.