- Introduction
- Getting Started
- Gitpod Tutorial
- Use Cases
- Languages
- Configure
- Workspaces
- User settings
- Repositories
- Organizations
- Authentication
- Billing
- References
- .gitpod.yml
- IDEs & editors
- Integrations
- Gitpod CLI
- Gitpod API
- Gitpod URL
- Compatibility
- Enterprise
- Overview
- Setup and Preparation
- Deploying
- Configure your Gitpod Instance
- Administration
- Upgrading
- Background
- Reference
- Archive
- Help
- Contribute
- Troubleshooting
FAQs
Is there a limit of IDE/editor connections to Gitpod?
There is no hard-limit about how many IDE/editors can be connected to a running Gitpod workspace. All connected IDEs/editors will have access to the same underlying file system and directories.
What version of VS Code runs in Gitpod (in the browser)?
VS Code in the browser in Gitpod uses a fork of VS Code called openvscode-server. Gitpod actively monitors VS Code’s release cycle, and releases the latest version of VS Code shortly after the upstream repository is updated. You can find more information about which version of VS Code is running in the browser by navigating to “Help > About” from a running Gitpod workspace.
Does Gitpod VS Code settings sync work with other products (e.g. Codespaces)?
Gitpod doesn’t currently support settings sync with other hosted VS Code environments, such as Codespaces or vscode.dev.
My VS Code extensions are not syncing, what should I do?
- When installing an extension in Gitpod using the
Install (Do Not Sync)
option. - Extensions defined in
gitpod.yml
- Extensions manually installed from a
vsix
file
Can I use both a desktop IDE and a browser editor in Gitpod?
Yes, you can. Both desktop and browser IDEs/editors have full access to files and directories within the workspace. So, when you connect to your Gitpod workspace from your Desktop you can also access your workspace via your browser. This means browser-based editing can either be used as your first-choice editor, or as a “fall back” alternative option for when you want to make edits on the move. With Gitpod, where and how you edit your code is very flexible.
What is the preferred IDE/editor for Gitpod?
There are many supported ways to edit your code in Gitpod, there is no preferred experience. Gitpod is intended to be flexible to allow you and your team to use the tools you are most familiar and comfortable with. You can edit code in Gitpod using:
- JetBrains IDE’s via JetBrains Gateway
- VS Code in the browser and VS Code on desktop
- Command-line based editors such as Vim
Please see the IDEs & editors documentation for more details.
How do desktop and browser differ regarding performance?
Using a desktop editor like JetBrains or VS Code Desktop, files persist in the Gitpod workspace, however a copy of files is fetched to the client to improve performance. All desktop clients communicate via the SSH protocol. Most processing tasks like intellisense and auto-completion are executed in the server (the Gitpod workspace). You can optimize your in-terminal typing experience using local echo or typeahead.
Do I need a license to use JetBrains and Gitpod?
The licensing of Remote Development is handled on the local machine and is covered by your existing active IDE license. See JetBrains documentation for more.
Will Gitpod support all the JetBrains IDE’s?
Yes, the plan is to eventually support all of the JetBrains IDE’s. Please refer to the Gitpod roadmap for future updates.
Does Gitpod support the IntelliJ IDEA Community edition?
No, JetBrains Remote Development and Gateway are available only in the IntelliJ IDEA Ultimate edition, please refer to IntelliJ IDEA FAQ.
Will Gitpod support JetBrains Fleet?
JetBrains Fleet is a next-generation IDE from JetBrains. The currently supported method of using JetBrains IDE’s with Gitpod is on desktop via JetBrains Gateway, please refer to our documentation for current IDE and editor support and the Gitpod roadmap for future updates.
Can I use JetBrains Projector with Gitpod?
Gitpod does not officially support JetBrains Projector. Gitpod has support for JetBrains Gateway, which is the primary tool for remote development when using JetBrains IDE’s.
How do I download or upload files to my workspace?
VS Code
To download a file in VS Code, right-click on it in the Explorer
panel and choose the Download...
option. To upload files, you have two options: either right-click inside the Explorer
panel and select Upload...
, or simply drag and drop the files into the Explorer
panel.
Other IDEs
For other IDEs you can use several methods to transfer files across. Listing a few below.
SCP:
- Copy the SSH command for your workspace.
- Paste the command into a local terminal.
- Replace
ssh
withscp
at the beginning of the command. - Specify the files you want to transfer and the remote destination path. For example:
# Upload a file
scp index.js 'gitpodio-website-687avh6runv@gitpodio-website-687avh6runv.ssh.ws-us105.gitpod.io:/workspace/website'
# Upload a folder
scp -r Images/ 'gitpodio-website-687avh6runv@gitpodio-website-687avh6runv.ssh.ws-us105.gitpod.io:/workspace/website'
A web based file manager:
- Run the following command snippet inside a Gitpod workspace terminal:
(cd /tmp; curl -sLO https://github.com/mjpclab/go-http-file-server/releases/download/v1.15.15/ghfs-1.15.15-linux-amd64.zip; unzip -qqo ghfs*.zip; (sleep 1; u=$(gp url 1111); echo $u; gp preview $u --external) & ./ghfs -l 1111 -r /workspace -U)
- This will give you a basic file manager web interface on port 1111.
- You can easily download and upload (drag-and-drop) files by visiting port 1111 address.
WebDAV:
- Start a WebDAV server on your Gitpod workspace. You may run such a command inside your workspace:
pip install wsgidav cheroot; gp ports visibility 1111:public; wsgidav --host=0.0.0.0 --port=1111 --root=/workspace --auth=anonymous
- Run
gp url 1111
command to obtain the URL for port 1111, and then copy the output. - Use the 1111 port address to connect to the WebDAV server using applications like Finder (macOS) or File Explorer (Windows).
How do I connect Cursor or VSCodium to Gitpod?
To connect Cursor or VSCodium to a Gitpod workspace, follow these steps:
- Install the Gitpod extension, which is available on both the VS Code Marketplace and Open VSX.
- Open the Gitpod extension in Cursor or VSCodium.
- Authenticate with Gitpod.
- Once authenticated, you will be able to connect to all available workspaces.
- To create a new workspace, use the Gitpod CLI or Gitpod dashboard (as of now).