diff options
Diffstat (limited to 'doc/user/project/web_ide/index.md')
| -rw-r--r-- | doc/user/project/web_ide/index.md | 517 |
1 files changed, 125 insertions, 392 deletions
diff --git a/doc/user/project/web_ide/index.md b/doc/user/project/web_ide/index.md index 5e9f648daba..bb1609a74e5 100644 --- a/doc/user/project/web_ide/index.md +++ b/doc/user/project/web_ide/index.md @@ -1,472 +1,205 @@ --- stage: Create -group: Editor +group: IDE 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 **(FREE)** -The Web IDE is an advanced editor with commit staging. -You can use the Web IDE to make changes to multiple files directly from the -GitLab UI. For a more basic implementation, see [Web Editor](../repository/web_editor.md). - -NOTE: -The Web IDE is being updated to use VS Code. For details, -see [Web IDE Beta](../web_ide_beta/index.md). - -## Open the Web IDE - -Use the <kbd>.</kbd> [keyboard shortcut](../../shortcuts.md) to open the Web IDE. -You can also open the Web IDE when viewing a file, from the repository file list, -and from merge requests: - -### When viewing a file or the repository file list - - 1. In the upper right corner of the page, select **Open in Web IDE** if it is visible. - 1. If **Open in Web IDE** is not visible: - 1. Select the (**{chevron-lg-down}**) next to **Edit** or **Gitpod**, depending on your configuration. - 1. Select **Open in Web IDE** from the list to display it as the editing option. - 1. Select **Open in Web IDE** to open the editor. - -### When viewing a merge request - - 1. Go to your merge request. - 1. In the upper right corner, select **Code > Open in Web IDE**. - -## File finder - -The file finder allows you to quickly open files in the current branch by -searching for fragments of the file path. The file finder is launched using the keyboard shortcut -<kbd>Command</kbd>+<kbd>p</kbd>, <kbd>Control</kbd>+<kbd>p</kbd>, or <kbd>t</kbd> -(when editor is not in focus). Type the filename or file path fragments to -start seeing results. - -## Command palette +> - [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. +> - [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/371084) in GitLab 15.7. +> - [Enabled on self-managed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/115741) in GitLab 15.11. -You can see all available commands for manipulating editor content by pressing -the <kbd>F1</kbd> key when the editor is in focus. After that, the editor displays -a complete list of available commands for -manipulating editor content. The editor supports commands for multi-cursor -editing, code block folding, commenting, searching and replacing, navigating -editor warnings and suggestions, and more. +FLAG: +On self-managed GitLab, by default this feature is available. To hide the feature, ask an administrator to [disable the feature flag](../../../administration/feature_flags.md) named `vscode_web_ide`. On GitLab.com, this feature is available. -Some commands have a keyboard shortcut assigned to them. The command palette -displays this shortcut next to each command. You can use this shortcut to invoke -the command without having to select it in the command palette. - -For a full list of keyboard shortcuts in the Web IDE, refer to the -[Keyboard shortcuts](../../shortcuts.md#web-ide) list. - -## Syntax highlighting - -As expected from an IDE, syntax highlighting for many languages in -the Web IDE makes your direct editing even easier. - -The Web IDE currently provides: - -- Basic syntax colorization for a variety of programming, scripting and markup - languages such as XML, PHP, C#, C++, Markdown, Java, VB, Batch, Python, Ruby, - and Objective-C. -- IntelliSense and validation support (displaying errors and warnings, providing - smart completions, formatting, and outlining) for some languages. For example: - TypeScript, JavaScript, CSS, LESS, SCSS, JSON, and HTML. - -Because the Web IDE is based on the [Monaco Editor](https://microsoft.github.io/monaco-editor/), -you can find a more complete list of supported languages in the -[Monaco languages](https://github.com/Microsoft/monaco-languages) repository. Under the hood, -Monaco uses the [Monarch](https://microsoft.github.io/monaco-editor/monarch.html) library for syntax highlighting. +The Web IDE is an advanced editor with commit staging. +You can use the Web IDE to make changes to multiple files directly from the GitLab UI. +For a more basic implementation, see [Web Editor](../repository/web_editor.md). -If you are missing Syntax Highlighting support for any language, we prepared a short guide on how to [add support for a missing language Syntax Highlighting.](https://gitlab.com/gitlab-org/gitlab/-/blob/master/app/assets/javascripts/ide/lib/languages/README.md) +To pair the Web IDE with a remote development environment, see [remote development](../remote_development/index.md). -### Themes +## Use the Web IDE -> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2389) in GitLab 13.0. -> - Full Solarized Dark Theme [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/219228) in GitLab 13.1. -> - Full [Solarized Light](https://gitlab.com/gitlab-org/gitlab/-/issues/221035) and [Monokai](https://gitlab.com/gitlab-org/gitlab/-/issues/221034) Themes introduced in GitLab 13.6. +To open the Web IDE from the GitLab UI: -All the themes GitLab supports for syntax highlighting are applied to the entire Web IDE screen. -You can pick a theme from your [profile preferences](../../profile/preferences.md). +1. On the top bar, select **Main menu > Projects** and find your project. +1. Use the <kbd>.</kbd> keyboard shortcut. -| Solarized Dark Theme | Dark Theme | -|-------------------------------------------------------------|-----------------------------------------| -|  |  | +You can also open the Web IDE from: -## Link to specific lines +- A file +- The repository file list +- A merge request -The Web IDE and the [Web Editor](../repository/web_editor.md) share the -same core features. To link to specific lines in the Web IDE, see -[Web Editor](../repository/web_editor.md#link-to-specific-lines). +### From a file or the repository file list -## Schema based validation +To open the Web IDE from a file or the repository file list: -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/218472) validation based on predefined schemas in GitLab 13.2 [with a flag](../../../administration/feature_flags.md) named `schema_linting`. -> - [Enabled by default](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/104399) in GitLab 15.7. -> - On self-managed GitLab [enabled by default](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/107488) in GitLab 15.8. +- In the upper-right corner of the page, select **Open in Web IDE**. -The Web IDE provides validation support for certain JSON and YAML files using schemas -based on the [JSON Schema Store](https://www.schemastore.org/json/). +If **Open in Web IDE** is not visible: -### Predefined schemas +1. Next to **Edit** or **Gitpod**, select the down arrow (**{chevron-lg-down}**). +1. From the dropdown list, select **Open in Web IDE**. +1. Select **Open in Web IDE**. -The Web IDE has validation for certain files built in. This feature is only supported for -the `*.gitlab-ci.yml` files. +### From a merge request -### Custom schemas **(PREMIUM)** +To open the Web IDE from a merge request: -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/226982) in GitLab 13.4. +1. Go to your merge request. +1. In the upper-right corner, select **Code > Open in Web IDE**. -The Web IDE also allows you to define custom schemas for certain JSON/YAML files in your project. -You can do so by defining a `schemas` entry in the `.gitlab/.gitlab-webide.yml` file inside the -repository's root. Here is an example configuration: +The Web IDE 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. -```yaml -schemas: - - uri: https://json.schemastore.org/package - match: - - package.json - - uri: https://somewebsite.com/first/raw/url - match: - - data/release_posts/unreleased/*.{yml,yaml} - - uri: https://somewebsite.com/second/raw/url - match: - - "*.meta.json" -``` +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**. -Each schema entry supports two properties: +## Open a file in the Web IDE -- `uri`: Provide an absolute URL for the schema definition file here. - The schema from this URL is loaded when a matching file is open. -- `match`: A list of matching paths or glob expressions. If a schema matches a - particular path pattern, it is applied to that file. Enclose the pattern - in quotes if it begins with an asterisk (`*`), it's be applied to that file. - If a pattern begins with an asterisk (`*`), enclose it in quotation marks. - Otherwise, the configuration file is not valid YAML. +To open any file by its name: -## Configure the Web IDE +1. Press <kbd>Command</kbd>+<kbd>P</kbd>. +1. Enter the name of your file. -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/23352) in GitLab 13.1. + -The Web IDE supports configuration of certain editor settings by using -[`.editorconfig` files](https://editorconfig.org/). When opening a file, the -Web IDE looks for a file named `.editorconfig` in the current directory -and all parent directories. If a configuration file is found and has settings -that match the file's path, these settings are enforced on the opened file. +## Search across files -The Web IDE currently supports the following `.editorconfig` settings: +You can use the Web IDE to search all files in the opened folder. -- `indent_style` -- `indent_size` -- `end_of_line` -- `trim_trailing_whitespace` -- `tab_width` -- `insert_final_newline` +To search across files: -## Commit changes +1. Press <kbd>Shift</kbd>+<kbd>Command</kbd>+<kbd>F</kbd>. +1. Enter your search term. -> - [Starting](https://gitlab.com/gitlab-org/gitlab/-/issues/33441) with GitLab 12.7, files are automatically staged. -> - In GitLab 12.9, support for staging files was [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/196609) to prevent loss of unstaged data. All of your current changes must be committed or discarded. +In the Web IDE, only partial results from opened files are displayed. -After making your changes, select **Commit** on the bottom-left to -review the list of changed files. +## View a list of changed files -After you have finalized your changes, you can add a commit message, commit the -changes and directly create a merge request. In case you don't have write -access to the selected branch, you see a warning, but can still create -a new branch and start a merge request. +To view a list of files you changed in the Web IDE: -To discard a change in a particular file, select **Discard changes** on that -file in the changes tab. To discard all the changes, select the trash icon in the -upper-right corner of the changes sidebar. +- On the activity bar on the left, select **Source Control**, + or press <kbd>Control</kbd>+<kbd>Shift</kbd>+<kbd>G</kbd>. - +Your `CHANGES`, `STAGED CHANGES`, and `MERGE CHANGES` are displayed. +For more information, see the [VS Code documentation](https://code.visualstudio.com/docs/sourcecontrol/overview#_commit). -## Reviewing changes +## Upload a new file -Before you commit your changes, you can compare them with the previous commit -by switching to the review mode or selecting the file from the list of changes. +To upload a new file and add it to the Git repository: -An additional review mode is available when you open a merge request, which -shows you a preview of the merge request diff if you commit your changes. +1. In the **Explorer** file tree, navigate to the directory where you want to upload the file. +1. Optional. If the directory does not exist yet, select the directory path where you want to have a new directory and either: + - Right-click on the directory path, and select **New Folder...**. You can create a nested directory path with the `/` separator, for example `parentdir/subdir1/subdir2`. + - In the **Explorer** panel, in the upper-right corner, select the new folder (**{folder-new}**) icon. +1. Enter the name of the new directory, and press <kbd>Enter/Return</kbd> to create it. +1. Right-click on the directory path and select `Upload...`. +1. Select the file you want to upload, then select `Open`. You can select and add multiple files at once. -## View CI job logs +The file is uploaded and automatically added as a new file to the Git repository. -You can use the Web IDE to quickly fix failing tests by opening -the branch or merge request in the Web IDE and opening the logs of the failed -job. You can access the status of all jobs for the most recent pipeline and job -traces for the current commit by selecting the **Pipelines** button in the top -right. +## Switch branches -The pipeline status is also shown at all times in the status bar in the bottom -left. +The Web IDE uses the currently selected branch by default. +To switch branches in the Web IDE: -## Switching merge requests +1. On the status bar, in the lower-left corner, select the current branch name. +1. In the search box, start typing the branch name. +1. From the dropdown list, select the branch. -To switch between your authored and assigned merge requests, select the -dropdown list in the top of the sidebar to open a list of merge requests. You must commit or discard all your changes before switching to a different merge -request. +## Create a branch -## Switching branches +To create a branch from the current branch in the Web IDE: -To switch between branches of the current project repository, select the dropdown list -in the top of the sidebar to open a list of branches. -You must commit or discard all your changes before switching to a -different branch. +1. On the status bar, in the lower-left corner, select the current branch name. +1. From the dropdown list, select **Create new branch...**. +1. Enter the branch name. +1. Press <kbd>Enter</kbd>. -## Markdown editing +If you don't have write access to the repository, **Create new branch...** is not visible. -> - Support for pasting images [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/22822) in GitLab 13.1. -> - Side-by-side Markdown preview [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68274) in GitLab 14.3. - -To edit Markdown files in the Web IDE: +## Commit changes -1. Go to your repository, and navigate to the Markdown page you want to edit. -1. Select **Open in Web IDE**, and GitLab loads the page in a tab in the editor. -1. Make your changes to the file. GitLab supports [GitLab Flavored Markdown (GLFM)](../../markdown.md). -1. When your changes are complete, select **Commit** in the left sidebar. -1. Add a commit message, select the branch you want to commit to, and select **Commit**. +To commit changes in the Web IDE: -When editing, you can upload local images by pasting them directly in the Markdown file. -The image is uploaded to the same directory and is named `image.png` by default. -If another file already exists with the same name, a numeric suffix is automatically -added to the filename. +1. On the activity bar on the left, select **Source Control**, + or press <kbd>Control</kbd>+<kbd>Shift</kbd>+<kbd>G</kbd>. +1. Enter your commit message. +1. Select **Commit & Push**. +1. Commit to the current branch, or create a new branch. -There are two ways to preview Markdown content in the Web IDE: +## Use the command palette -1. At the top of the file's tab, select **Preview Markdown** to preview the formatting - in your file. You can't edit the file in this view. - 1. To add more changes to the file, select **Edit**. -1. Right-click or use the keyboard shortcut `Command/Control + Shift + P` and - select **Preview Markdown** to toggle a live Markdown preview panel. +In the Web IDE, you can access many commands through the command palette. +To open the command palette and run a command in the Web IDE: -<!--- start_remove The following content will be removed on remove_date: '2023-02-01' --> +1. Press <kbd>Shift</kbd>+<kbd>Command</kbd>+<kbd>P</kbd>. +1. In the search box, start typing the command name. +1. From the dropdown list, select the command. -## Live Preview (removed) +## Edit settings -WARNING: -This feature was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108627) in GitLab 15.8 -and is planned for removal in 15.9. This change is a breaking change. +You can use the settings editor to view and modify your user and workspace settings. +To open the settings editor in the Web IDE: -> [Renamed](https://gitlab.com/gitlab-org/gitlab/-/issues/213853) from _Client Side Evaluation_ to _Live Preview_ in GitLab 13.0. +- On the top menu bar, select **File > Preferences > Settings**, + or press <kbd>Command</kbd>+<kbd>,</kbd>. -You can use the Web IDE to preview JavaScript projects right in the browser. -This feature uses CodeSandbox to compile and bundle the JavaScript used to -preview the web application. +In the settings editor, you can search for the settings you want to modify. - +## Edit keyboard shortcuts -Additionally, for public projects an **Open in CodeSandbox** button is available -to transfer the contents of the project into a public CodeSandbox project to -quickly share your project with others. +You can use the keyboard shortcuts editor to view and modify the default keybindings for all available commands. +To open the keyboard shortcuts editor in the Web IDE: -### Enable Live Preview +- On the top menu bar, select **File > Preferences > Keyboard Shortcuts**, + or press <kbd>Command</kbd>+<kbd>K</kbd> then <kbd>Command</kbd>+<kbd>S</kbd>. -With Live Preview enabled, you can preview projects with a `package.json` file and -a `main` entry point inside the Web IDE. +In the keyboard shortcuts editor, you can search for: -Live Preview is enabled for all projects on GitLab.com. If you are an administrator -of a self-managed GitLab instance, and you want to enable Live Preview: +- The keybindings you want to change +- The commands you want to add or remove keybindings for -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > General**. -1. Scroll to **Web IDE** and select **Expand**: -  -1. Select **Enable Live Preview** and select **Save changes**. +Keybindings are based on your keyboard layout. If you change your keyboard layout, existing keybindings are updated automatically. -[In GitLab 12.9 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/268288), -third-party assets and libraries required for Live Preview are hosted at -`https://sandbox-prod.gitlab-static.net` when it is enabled. However, some libraries -are still served from other third-party services, which may or may not be desirable -in your environment. +## Change themes -An example `package.json`: +You can choose between different themes for the Web IDE. The default theme for the Web IDE is **GitLab Dark**. -```json -{ - "main": "index.js", - "dependencies": { - "vue": "latest" - } -} -``` +To change the Web IDE theme: -<!--- end_remove --> +1. On the top menu bar, select **File > Preferences > Theme > Color Theme**, + or press <kbd>Command</kbd>+<kbd>K</kbd> then <kbd>Command</kbd>+<kbd>T</kbd>. +1. From the dropdown list, preview the themes with the arrow keys. +1. Select a theme. -## Interactive Web Terminals for the Web IDE +The active color theme is stored in the [user settings](#edit-settings). -> [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/211685) from GitLab Ultimate to GitLab Free in 13.1. +<!-- ## Privacy and data collection for extensions -WARNING: -Interactive Web Terminals for the Web IDE is currently in [**Beta**](../../../policy/alpha-beta-support.md#beta-features). -GitLab.com shared runners [do not yet support Interactive Web Terminals](https://gitlab.com/gitlab-org/gitlab/-/issues/24674), -so you must use your own private runner to make use of this feature. +The Web IDE Extension Marketplace is based on Open VSX. Open VSX does not collect any +data about you or your activities on the platform. -[Interactive Web Terminals](../../../ci/interactive_web_terminal/index.md) -give the project [Maintainers](../../permissions.md#project-members-permissions) -user access to a terminal to interact with the runner directly from -GitLab, including through the Web IDE. +However, the privacy and data collection practices of extensions available on Open VSX can vary. +Some extensions might collect data to provide personalized recommendations or to improve the functionality. +Other extensions might collect data for analytics or advertising purposes. -### Runner configuration +To protect your privacy and data: -Some things must be configured in the runner for the interactive web terminal -to work: +- Carefully review the permissions requested by an extension before you install the extension. +- Keep your extensions up to date to ensure that any security or privacy vulnerabilities are addressed promptly. --> -- The runner needs to have - [`[session_server]` configured properly](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-session_server-section). - This section requires at least a `session_timeout` value (which defaults to 1800 - seconds) and a `listen_address` value. If `advertise_address` is not defined, `listen_address` is used. -- If you are using a reverse proxy with your GitLab instance, web terminals must be - [enabled](../../../administration/integration/terminal.md#enabling-and-disabling-terminal-support). +## Interactive web terminals for the Web IDE (Beta) -If you have the terminal open and the job has finished with its tasks, the -terminal blocks the job from finishing for the duration configured in -[`[session_server].session_timeout`](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-session_server-section) -until you close the terminal window. - -NOTE: -Not all executors are -[supported](https://docs.gitlab.com/runner/executors/#compatibility-chart). -The [File Sync](#file-syncing-to-web-terminal) feature is supported on Kubernetes runners only. - -### Web IDE configuration file - -To enable the Web IDE terminals you must create the file -`.gitlab/.gitlab-webide.yml` inside the repository's root. This -file is fairly similar to the [`.gitlab-ci.yml` file](../../../ci/yaml/index.md) -syntax but with some restrictions: - -- No global blocks (such as `before_script` or `after_script`) can be defined. -- Only one job named `terminal` can be added to this file. -- Only the keywords `image`, `services`, `tags`, `before_script`, `script`, and - `variables` are allowed to be used to configure the job. -- To connect to the interactive terminal, the `terminal` job must be still alive - and running, otherwise the terminal cannot connect to the job's session. - By default the `script` keyword has the value `sleep 60` to prevent - the job from ending and giving the Web IDE enough time to connect. This means - that, if you override the default `script` value, you have to add a command - which would keep the job running, like `sleep`. - -For example, with this configuration file: - -```yaml -terminal: - # This can be any image that has the necessary runtime environment for your project. - image: node:10-alpine - before_script: - - apk update - script: sleep 60 - variables: - RAILS_ENV: "test" - NODE_ENV: "test" -``` - -After the terminal starts, the console is displayed and you can access -the project repository files. - -When you use the `image` keyword, a container with the specified image is created. -If you use the [shell executor](https://docs.gitlab.com/runner/executors/shell.html) -or the [SSH executor](https://docs.gitlab.com/runner/executors/ssh.html), `image` has no effect. - -The terminal job is branch dependent. The configuration file used to trigger -and configure the terminal is the one in the selected branch of the Web IDE. -If no configuration file exists in a branch, an error message is displayed. - -### Running interactive terminals in the Web IDE - -If Interactive Terminals are available for the current user, the **Terminal** button is visible in the right sidebar of the Web IDE. Select this button to open -or close the terminal tab. - -After opening, the tab shows the **Start Web Terminal** button. This button may -be disabled if the environment is not configured correctly. If so, a status -message describes the issue. Here are some reasons why **Start Web Terminal** -may be disabled: - -- `.gitlab/.gitlab-webide.yml` does not exist or is set up incorrectly. -- No active private runners are available for the project. - -If active, selecting the **Start Web Terminal** button loads the terminal view -and start connecting to the runner's terminal. At any time, the **Terminal** tab -can be closed and reopened and the state of the terminal is not affected. - -When the terminal is started and is successfully connected to the runner, then the -runner's shell prompt appears in the terminal. From here, you can enter -commands executed in the runner's environment. This is similar -to running commands in a local terminal or through SSH. - -While the terminal is running, it can be stopped by selecting **Stop Terminal**. -This disconnects the terminal and stops the runner's terminal job. From here, -select **Restart Terminal** to start a new terminal session. - -### File syncing to web terminal - -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/5276) in GitLab 12.0. -> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/211686) from GitLab Ultimate to GitLab Free in 13.1. - -File changes in the Web IDE can be synced to a running web terminal. -This enables users to test their code changes in a preconfigured terminal -environment. - -NOTE: -Only file changes in the Web IDE are synced to the terminal. -Changes made in the terminal are **not** synced to the Web IDE. -This feature is only available for Kubernetes runners. - -To enable file syncing to the web terminal, the `.gitlab/.gitlab-webide.yml` -file needs to have a `webide-file-sync` service configured. Here is an example -configuration for a Node JS project which uses this service: - -```yaml -terminal: - # This can be any image that has the necessary runtime environment for your project. - image: - name: node:10-alpine - services: - - name: registry.gitlab.com/gitlab-org/webide-file-sync:latest - alias: webide-file-sync - entrypoint: ["/bin/sh"] - command: ["-c", "sleep 5 && ./webide-file-sync -project-dir $CI_PROJECT_DIR"] - ports: - # The `webide-file-sync` executable defaults to port 3000. - - number: 3000 -``` - -- The `webide-file-sync` executable must start **after** the project - directory is available. This is why we must add `sleep 5` to the `command`. - See [this issue](https://gitlab.com/gitlab-org/webide-file-sync/-/issues/7) for - more information. -- `$CI_PROJECT_DIR` is a - [predefined CI/CD variable](../../../ci/variables/predefined_variables.md) - for GitLab Runners. This is where your project's repository resides. - -After you have configured the web terminal for file syncing, then when the web -terminal is started, a **Terminal** status is visible in the status bar. - - - -Changes made to your files via the Web IDE sync to the running terminal -when: - -- <kbd>Control</kbd> + <kbd>S</kbd> (or <kbd>Command</kbd> + <kbd>S</kbd> on Mac) - is pressed while editing a file. -- You select any area outside the file editor after editing a file. -- A file or folder is created, deleted, or renamed. - -### Known issues - -The Web IDE has a few limitations: - -- Interactive Terminals is in a beta phase and continues to be improved in upcoming releases. In the meantime, the user is limited to having only one - active terminal at a time. -- LFS files can be rendered and displayed but they cannot be updated and committed using the Web IDE. If an LFS file is modified and pushed to the repository, the LFS pointer in the repository is overwritten with the modified LFS file content. +When you set up a remote development server in the Web IDE, you can use interactive web terminals to: -### Troubleshooting +- Access a remote shell on the server. +- Interact with the server's file system and execute commands remotely. -- If the terminal's text is gray and unresponsive, then the terminal has stopped - and it can no longer be used. A stopped terminal can be restarted by selecting - **Restart Terminal**. -- If the terminal displays **Connection Failure**, then the terminal could not - connect to the runner. Try to stop and restart the terminal. If the - problem persists, double check your runner configuration. - -## Related topics +You cannot use interactive web terminals to interact with a runner. +However, you can use a terminal to install dependencies and compile and debug code. -- [Web IDE Beta](../web_ide_beta/index.md) +For more information about configuring a workspace that supports interactive web terminals, see [remote development](../remote_development/index.md). |