debian-mirror-gitlab/doc/user/project/web_ide_beta/index.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

107 lines
3.8 KiB
Markdown
Raw Normal View History

2023-03-04 22:38:38 +05:30
---
stage: Create
group: Editor
info: 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)**
2023-03-17 16:20:25 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/95169) in GitLab 15.7 [with a flag](../../../administration/feature_flags.md) named `vscode_web_ide`. Disabled by default.
2023-03-04 22:38:38 +05:30
FLAG:
2023-03-17 16:20:25 +05:30
On self-managed GitLab, by default this feature is not available. To make it available, ask an administrator to [enable the feature flag](../../../administration/feature_flags.md) named `vscode_web_ide`. On GitLab.com, this feature is available. The feature is not ready for production use.
2023-03-04 22:38:38 +05:30
As announced in [this blog post](https://about.gitlab.com/blog/2022/05/23/the-future-of-the-gitlab-web-ide/),
2023-03-17 16:20:25 +05:30
the current implementation of the [Web IDE](../web_ide/index.md) is being replaced
with an implementation powered by Visual Studio Code. This effort is still under
development. For updates, see [this epic](https://gitlab.com/groups/gitlab-org/-/epics/7683).
2023-03-04 22:38:38 +05:30
2023-03-17 16:20:25 +05:30
To pair the Web IDE Beta with a Remote Development environment, see [Remote Development](../remote_development/index.md).
2023-03-04 22:38:38 +05:30
## Enable the Web IDE Beta
To use the Web IDE Beta on a self-managed GitLab instance,
ensure that the `vscode_web_ide` feature flag
[is enabled](../../../administration/feature_flags.md).
On GitLab.com, this feature is available by default. However, you can
[stop using it if you choose](#stop-using-the-web-ide-beta).
## Use the Web IDE Beta
To open the Web IDE Beta from anywhere in the UI:
- Use the <kbd>.</kbd> [keyboard shortcut](../../shortcuts.md).
You can also open the Web IDE Beta when viewing a file, the repository file list,
2023-03-17 16:20:25 +05:30
or a merge request.
2023-03-04 22:38:38 +05:30
### Use when viewing a file or the repository file list
To open the Web IDE Beta from a file or the repository file list:
2023-04-23 21:23:45 +05:30
- In the upper right of the page, select **Open in Web IDE**.
2023-03-04 22:38:38 +05:30
If **Open in Web IDE** is not visible:
1. Next to **Edit** or **Gitpod**, select the down arrow (**{chevron-lg-down}**).
1. From the list, select **Open in Web IDE**.
1. Select **Open in Web IDE**.
### Use when viewing a merge request
To open the Web IDE Beta from a merge request:
1. Go to your merge request.
1. In the upper right corner, select **Code > Open in Web IDE**.
## Open a file in the Web IDE Beta
To open any file by its name:
2023-03-17 16:20:25 +05:30
1. Press <kbd>Command</kbd>+<kbd>P</kbd>.
1. Enter the name of your file.
2023-03-04 22:38:38 +05:30
![fuzzy_finder_v15_7](img/fuzzy_finder_v15_7.png)
## Search across files
2023-03-17 16:20:25 +05:30
You can use VS Code to quickly search all files in the opened folder.
2023-03-04 22:38:38 +05:30
2023-03-17 16:20:25 +05:30
To search across files:
2023-03-04 22:38:38 +05:30
2023-03-17 16:20:25 +05:30
1. Press <kbd>Shift</kbd>+<kbd>Command</kbd>+<kbd>F</kbd>.
2023-03-04 22:38:38 +05:30
1. 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.
2023-03-17 16:20:25 +05:30
## View a list of changed files
2023-03-04 22:38:38 +05:30
2023-03-17 16:20:25 +05:30
To view a list of files you changed in the Web IDE Beta,
in the Activity Bar on the left, select **Source Control**.
Your `CHANGES`, `STAGED CHANGES`, and `MERGE CHANGES` are displayed.
2023-03-04 22:38:38 +05:30
2023-03-17 16:20:25 +05:30
For details, see the [VS Code documentation](https://code.visualstudio.com/docs/sourcecontrol/overview#_commit).
2023-03-04 22:38:38 +05:30
2023-03-17 16:20:25 +05:30
## Stop using the Web IDE Beta
2023-03-04 22:38:38 +05:30
2023-03-17 16:20:25 +05:30
If you do not want to use the Web IDE Beta, you can change your personal preferences.
2023-04-23 21:23:45 +05:30
1. On the top bar, in the upper-right corner, select your avatar.
2023-03-17 16:20:25 +05:30
1. Select **Preferences**.
1. In the **Web IDE** section, select the **Opt out of the Web IDE Beta** checkbox.
1. Select **Save changes**.
2023-03-04 22:38:38 +05:30
## Known issues
The [Web Terminal](../web_ide/index.md#interactive-web-terminals-for-the-web-ide)
2023-04-23 21:23:45 +05:30
and [Live Preview](../web_ide/index.md#live-preview-removed) are not available in the Web IDE Beta.
2023-03-04 22:38:38 +05:30
2023-03-17 16:20:25 +05:30
These features might become available at a later date.
2023-03-04 22:38:38 +05:30
2023-03-17 16:20:25 +05:30
## Related topics
2023-03-04 22:38:38 +05:30
2023-03-17 16:20:25 +05:30
- [Remote Development](../remote_development/index.md)
- [Web IDE](../web_ide/index.md)