Heads up! On October 1, we introduced Gitpod Flex. You can swap between documentation by using the switcher in the left navigation bar.

Cursor

Gitpod works with any remote and SSH compatible editor, including Cursor.

Step 1 - Install the CLI and setup your SSH configuration

The easiest way to setup SSH configuration is by installing the Gitpod CLI.

Once installed, run gitpod env ssh-config to update your local SSH configuration.

To validate ensure the directory ~/.ssh/gitpod is created on your local machine.

Step 2 - Find the host for your environment

You can find the host name on your started environment details page.

The host format is: <environment-id>.gitpod.environment

For example: 01922350-2462-79da-8c80-770fe4275aa2.gitpod.environment

copying host id from app

Note: You do not need the ssh command when connecting to Cursor.

Step 3 - Connect with your environment

Finally, paste the host into the connect to host box.

connecting to host

Once connected you will need to open your source code.

Source code is cloned into the /workspaces/ directory.

Select /workspaces/<your-repository-name> to open your code.

opening folder

Useful information

  • Ports are not forwarded automatically, you will need to add them manually to the ports view to view localhost URLs.

Was this helpful?