IDEs in Cloud Development Environments

OpenShift Dev Spaces supports multiple Integrated Development Environments (IDEs) that can be used in workspaces. The default IDE is Microsoft Visual Studio Code - Open Source.

The che-editors.yaml file features the devfiles of all supported IDEs. For the file location, see Related information.

Supported IDEs

The default IDE in a new workspace is Microsoft Visual Studio Code - Open Source. Alternatively, you can choose another supported IDE:

Expand
Table 1. Supported IDEs
IDE Status id Note

Microsoft Visual Studio Code - Open Source

Available

  • che-incubator/che-code/latest
  • che-incubator/che-code/insiders
  • latest is the default IDE that loads in a new workspace when the URL parameter or che-editor.yaml is not used.
  • insiders is the development version.

JetBrains IntelliJ IDEA Ultimate Edition (over JetBrains Gateway)

Available

  • che-incubator/che-idea-server/latest
  • che-incubator/che-idea-server/next
  • latest is the stable version.
  • next is the development version.

JetBrains IDEs (over JetBrains Toolbox)

Available

  • che-incubator/che-idea-server/toolbox
  • Connects a local JetBrains IDE to a workspace through the JetBrains Toolbox application.

Which IDE should I choose?

Use Microsoft Visual Studio Code - Open Source if you want a browser-based experience with no local installation. Use JetBrains IntelliJ IDEA if your team already uses JetBrains IDEs and you prefer a desktop client connected to the remote workspace over SSH. Visual Studio Code - Open Source is the default and requires no additional setup. JetBrains requires installing JetBrains Gateway or JetBrains Toolbox on your local machine.

Repository-level IDE configuration in OpenShift Dev Spaces

You can store IDE configuration files directly in the remote Git repository that contains your project source code. This way, one common IDE configuration is applied to all new workspaces that feature a clone of that repository. Such IDE configuration files might include the following:

  • The /.che/che-editor.yaml file that stores a definition of the chosen IDE.
  • IDE-specific configuration files that one would typically store locally for a desktop IDE. For example, the /.vscode/extensions.json file.

Microsoft Visual Studio Code - Open Source

The OpenShift Dev Spaces build of Microsoft Visual Studio Code - Open Source is the default IDE of a new workspace.

You can automate installation of Microsoft Visual Studio Code extensions from the Open VSX registry at workspace startup. For instructions on automating extension installation and configuring che-editor.yaml, see Related information. To configure IDE preferences on a per-workspace basis, invoke the Command Palette and select Preferences: Open Workspace Settings.

You might see your organization's branding in this IDE if your organization customized it through a branded build.

Use Tasks to find and run the commands specified in devfile.yaml. The following Dev Spaces commands are available by clicking Dev Spaces in the Status Bar or through the Command Palette:

  • Dev Spaces: Open Dashboard
  • Dev Spaces: Open OpenShift Console
  • Dev Spaces: Stop Workspace
  • Dev Spaces: Restart Workspace
  • Dev Spaces: Restart Workspace from Local Devfile
  • Dev Spaces: Open Documentation