Connecting Local IDE

Connect your preferred local development environment to Codesphere workspaces, enabling you to work with cloud-based resources using the tools you know and love. Codesphere supports multiple workflows: Git-based synchronization, the VS Code extension for real-time remote connections, and SSH connections for any SSH-capable editor (including JetBrains IDEs, Vim, Emacs, and more).

Git-Based Workflow (Easiest)

The most common and often preferred approach is to work locally as you always have, using Git as your synchronization mechanism. This method allows you to use any IDE or editor on your local machine without special configuration.

How it works:

1. Clone your repository and work locally with your preferred IDE (VS Code, IntelliJ, vim, etc.)
2. Make changes, commit, and push to your Git repository
3. Codesphere automatically syncs changes on each commit when Git automations are configured or a CLI automation is set up
4. Your Codesphere workspace updates automatically, triggering builds and deployments as configured

This workflow is ideal for teams who want to maintain their existing development practices while leveraging the platform's infrastructure for builds, testing, and deployments. No special plugins or connections required. Just your normal Git workflow.

Git Automations

Configure GitHub, GitLab, or Bitbucket, Jenkins or Azure DevOps automations to automatically update your Codesphere workspaces on every push.

VS Code Extension

The Codesphere VS Code extension uses Microsoft's tunnel functionality to establish a secure connection between your local VS Code and Codesphere workspaces, syncing code changes instantly.

Setup:

1. Install the extension from the VS Code Marketplace or search for "Codesphere" in VS Code's Extensions view
2. Click the Codesphere icon in the activity bar and sign in
3. Select your workspace and click Create Tunnel
4. Authenticate with GitHub by copying the code into the browser prompt
5. Once setup completes, click Connect and select GitHub authentication

Your VS Code will reload and connect to the workspace. Access your Codesphere terminal, trigger CI pipelines, and use Git integration directly from your local IDE. View all tunnel connections in the Remote Explorer tab.

SSH Client Connections

For cluster configurations that allow direct network access, you can connect using SSH-based approaches. This method works with JetBrains IDEs (IntelliJ IDEA, PyCharm, WebStorm, etc.) and any other editor that supports SSH remote development.

Prerequisites

• Direct IP access must be enabled in your Codesphere cluster configuration
• SSH client installed and configured inside your workspace (i.e. nix-env -iA nixpkgs.openssh_hpn & keys configured)

Connecting via SSH

1. Obtain Connection Details: Get the IP address and SSH credentials for your workspace
2. Configure IDE:
   • For JetBrains IDEs: Use JetBrains Gateway or the Remote Development feature to connect via SSH
   • For other editors: Configure SSH remote development using your editor's documentation
3. Establish Connection: Connect using the provided IP address and credentials
4. Set Remote Path: Map your local project directory to the workspace path

Network Requirements

SSH client connections require specific cluster and networking configurations. Contact your platform administrator to verify if this option is available in your installation.