Workspace management in the Cloud Shell Editor

The Cloud Shell Editor comes with the ability to manage your projects as workspaces. A workspace usually represents the root folder of your project and includes your project-specific configuration files. A Home workspace (based on your Home directory) is created for you automatically.

With workspaces, you can specify persistent settings, run and debug configurations, and UI states (like open files) for all the folders in your workspace.

This page demonstrates how to create, open, save, and close a workspace as well as configure Cloud Shell Editor and workspace settings.

Creating a new workspace

To create a new workspace:

  1. Using the Cloud Shell terminal, first create a new directory to use as your workspace:
    • Use mkdir to manually create a brand new directory
    • Use git clone to copy in an existing repository
  2. Once your directory is ready, you can open it as a new workspace with File > Open Workspace....

Opening a workspace

You can open a workspace in one of the following ways:

  • Click the Open Workspace button in the Cloud Shell Editor Explorer view.

    Alternatively, you can access File > Open Workspace....

    Open Workspace button accessible in Explorer when no workspaces are currently open

  • Select a recently opened workspace from the Recent section within the Welcome to Cloud Shell window.

    Alternatively, you can access File > Open Recent Workspace....

    Recently opened workspaces like hello-world-1 and appengine-guestbook-python available under Recent. Clicking their linked names opens the workspace in the Explorer

Other actions

Opening a Home workspace

To operate using a Home workspace, all you need to do is open your Home directory as your workspace with File > Open Workspace... and choose your Home directory from the folder dropdown menu.

Saving a workspace

Once you've added project folders to your workspace and configured it to your liking, you can save your workspace under a new name with File>Save Workspace As....

Closing a workspace

To close your workspace, you have to navigate to File>Close Workspace and click OK when prompted to confirm this action.

Configuring settings

The Cloud Shell Editor's behavior and interface are easily configured with the Settings menu. You can define your preferences for debugging configurations, YAML editing support, and Command Palette history limits, among a variety of settings using this Settings editor. Settings are accessible through File>Settings>Open Preferences.

Broadly, there are two types of settings:

  • User settings: Globally-applicable settings, applied to all your instances of the Cloud Shell Editor.
  • Workspace settings: Workspace-specific settings, applied to only the currently active workspace. These settings are saved in the .theia/settings.json file in your workspace folder and can be shared via version control or by downloading the workspace folder.

To search for a setting, you can use the Search Settings search bar that returns a set of settings that match your query, filtering out those that don't relate to your criteria. The settings themselves can be set either by filling in the input field, choosing an option from a dropdown menu, or toggling a checkbox.

Settings interface with tabs for User and Workspace with Debug settings being viewed