Creating and managing workspaces
Create, rename, switch between and delete workspaces.
Overview
Create a workspace for each project or API you work with. A workspace can be stored inside Relay, or in a folder you choose so you can share it with Git.
You create workspaces from the workspace menu at the top of the sidebar, and rename and delete them in the Workspaces window.
Create a workspace
- In the sidebar, click the workspace menu and choose New Workspace….
- Enter a name.
- For Location, select In Relay to let Relay store the workspace, or In a Folder to store it as files in a folder you choose.
- If you selected In a Folder, click Choose… and name a new folder. You can also choose an empty folder that already exists.
- Click Create.
The new workspace opens in the current window.
To create a workspace without switching any window to it, choose Edit Workspaces… from the workspace menu, then click Add Workspace at the bottom of the Workspaces window's sidebar. Relay creates a workspace named New Workspace, stored in Relay.
To add a workspace that's already in a folder, such as one a teammate shared in a Git repository, choose File > Open Workspace…. For more information, see Storing a workspace in a folder.
Switch workspaces
In the sidebar, click the workspace menu and choose a workspace from the Workspace section. Only the current window switches.
To work in two workspaces at once, choose File > New Window, then switch the new window to the other workspace.
Rename a workspace
- Choose Edit Workspaces… from the workspace menu.
- In the Workspaces window's sidebar, Control-click the workspace and choose Rename.
- Enter a name and press Return.
You can also select the workspace and click its name at the top of the window. Enter a name in the Rename Workspace popover and click Save.
Delete a workspace
- Choose Edit Workspaces… from the workspace menu.
- In the Workspaces window's sidebar, Control-click the workspace and choose Delete.
- Click Delete to confirm.
Deleting a workspace deletes its collections, environments and variables. Any window that was showing it switches to the first workspace in the list.
For a workspace stored in a folder, the command is Remove from Relay instead. Relay stops showing the workspace, but its folder and files stay where they are, and you can open it again with File > Open Workspace….
Relay always keeps at least one workspace, so you can't delete the last one. Create another workspace first.
Tip
Undo workspace changes
Creating, renaming, deleting and moving workspaces can be undone. Choose Edit > Undo in the window where you made the change: the main window for a workspace created from the workspace menu, or the Workspaces window for changes made there. Undoing the creation of a workspace switches the window back to the workspace it showed before.
See Also
- Understanding workspaces: Learn how workspaces, collections, folders and drafts fit together.
- Storing a workspace in a folder: Keep a workspace as files in a folder you choose and share it with Git.
- Managing environments: Switch between sets of variables for development, staging and production.