Quickstart guide for GitLab Remote Development workspaces Close To search repositories and projects, login to gitlab.com . Suggestions GitLab Duo Agent Platform Code Suggestions (AI) CI/CD GitLab on AWS GitLab on Google Cloud Why GitLab? * Platform Execution & Workflows * CI/CD * Source Code Management * Agile Delivery Security & Governance * Application Security Testing * Governance & Compliance * Supply Chain Security Context & AI * Agentic Orchestration * Context Graph * Visibility & Measurement Explore the Platform Why GitLab One platform for speed with control across your software lifecycle. Learn more * Solutions Outcomes * DevOps Modernization * Security Modernization * AI Modernization By size * Enterprise * Small Business * Startups Industries * Financial Services * Public Sector * Telecommunications * Automotive * Education * Aerospace View all Solutions GitLab Transcend Catch our latest innovations announced at the last Transcend. Read the blog * Pricing * Resources Discover * Docs * University * Demo Series * Demo Hub * Services Connect * Blog * Community * Customers * Partners * Events View all resources What’s new in GitLab Stay updated with our latest features and improvements. Read the latest * Company * About * Jobs * Press * Handbook * Leadership * Investor relations * Trust Center * AI Transparency Center * Newsletter * Contact us * Talk to sales * Support portal * Customer portal Request a demo Get free trial Sign in Get free trial Ship at agent speed. Prove every step. Transcend returns on October 6. Register now Blog Engineering Quickstart guide for GitLab Remote Development workspaces Published on: June 26, 2023 5 min read Quickstart guide for GitLab Remote Development workspaces Learn how to create a workspace from your GitLab account and work directly from the remote development environment. Itzik Gan Baruch tutorial DevOps CI/CD GitLab 16.0 introduced Remote Development workspaces (beta) , an exciting addition to the GitLab platform that empowers teams to build and deliver software more efficiently. This guide provides step-by-step instructions on how to create a workspace directly from your GitLab account and work directly from the remote development environment. You will work in the Web IDE, a Visual Studio Code browser version, seamlessly integrated into the workspace. From this quick start, you will learn how to create a workspace, use the Web IDE Terminal to install dependencies or start your server, and view your running application. To learn more about Remote Development in GitLab, we recommend reading this informative blog post, " A first look at workspaces ," and the workspaces docs . Here are the steps covered in this tutorial: * Prerequisites * Locate DevFile at the root of repository * Create your workspace * Install dependencies and previewing your application in the workspace * Make changes to the application and previewing the updated version * Commit the change * Explore the demo * Try out workspaces Prerequisites Prior to enabling developers to create workspaces, there are a few prerequisites such as bring your own Kubernetes cluster, and install and configure the GitLab agent for Kubernetes on it. Additionally, certain configuration steps must be completed on the cluster. You can find detailed instructions for all these steps in our workspaces prequisites documentation . Once the prerequisites are properly configured, developers who hold Developer role or above within the root group will gain the ability to create workspaces. Locate DevFile at the root of repository A devfile is a declarative configuration file, in YAML syntax, used to define and describe the development environment for a software project. It provides a standardized way to specify the necessary tools, languages, runtimes, and other components required for developing an application. To initiate a workspace, it is necessary to have a devfile located at the root of the repository. In this blog post, we will utilize a project that contains a devfile, accessible here . Copy schemaVersion : 2.2.0 components : - name : tooling-container attributes : gl/inject-editor : true container : # NOTE: THIS IMAGE EXISTS ONLY FOR DEMO PURPOSES AND WILL NOT BE MAINTAINED image : registry.gitlab.com/gitlab-org/remote-development/gitlab-remote-development-docs/debian-bullseye-ruby-3.2-node-18.12:rubygems-3.4-git-2.33-lfs-2.9-yarn-1.22-graphicsmagick-1.3.36-gitlab-workspaces memoryRequest : 1024M memoryLimit : 2048M cpuRequest : 500m cpuLimit : 1000m endpoints : - name : http-3000 targetPort : 3000 For more information, see the GitLab documentation and devfile documentation . Create your workspace * Make sure you have a Developer role or above in the root group, and the above prerequisites configured properly. * Fork this project to the GitLab group for which you have a Developer role or above. * Switch contexts and select Your work . * Select Workspaces . * Select New workspace . * Select the project you forked or another project that has a .devfile.yaml file at the root of the repository. * Select the cluster agent owned by the group the project belongs to. * In Time before automatic termination , enter the number of hours until the workspace automatically terminates. This timeout is a safety measure to prevent a workspace from consuming excessive resources or running indefinitely. * Select Create workspace . The workspace will be deployed to the cluster and might take a few minutes to start. To access the workspace, under Preview, select the workspace link. Install dependencies and previewing your application in the workspace After creating your workspace, the Web IDE using VS Code is injected into it, and the repository is cloned to the image. Consequently, you gain immediate access to your code and can commence working on it right away. You can now open the terminal, install any missing dependencies, and start the application. * To open the terminal, from the left menu, select Terminal , New Terminal . * Type npm install to install the dependencies listed in the package.json file. * Type npm start to start the application. The log will indicate that the application has started on port 3000. You can now access your application by opening the browser and using the workspace URL. Change the number before ‘workspace’ in the URL to the port number on which your application is listening (e.g., 3000). For example, if your workspace URL is https://<prefix>-workspace-73241-25728545-rqvpjm.workspaces.gitlab.dev , and your application is running on port 3000, update <prefix> to 3000 to access your application. Make changes to the application and previewing the updated version In the Web IDE, navigate to the server.js file, modify the text in line 9. Afterward, refresh the browser where your application is opened to see the applied changes. Commit the change * In the Web IDE click on the merge icon in the activity bar. * Click the line with the server.js to view your change side by side. * To stage your change, click the plus icon next to server.js . * Type a commit message describing your change. * Click Commit. * Click Sync changes to push the commit to the GitLab server. More resources * Explore further with this click-through demo of workspaces . * Learn how to install VS Code on a cloud provider VM and set up remote access . Try out workspaces Remote Development workspaces offer a convenient and efficient way to work on projects without the need for local development setups. They provide a streamlined workflow and enable developers to focus on writing code rather than dealing with complex environment setups. By adopting workspaces, developers can collaborate effectively, improve productivity, and simplify the development process. Give workspaces a try and revolutionize your remote development experience today! Cover image by Pankaj Patel on Unsplash Share this article Stay in the know with GitLab's monthly newsletter All fields required More to explore View all blog posts Engineering Co-Create: Building GitLab with our users Read the blog Engineering Git was built for humans — agents need an upgrade Read the blog Engineering From chaos to context: Building an AI dev workflow Read the blog We want to hear from you Enjoyed reading this blog post or have questions or feedback? Share your thoughts by creating a new topic in the GitLab community forum. Share your feedback Start building faster today See what your team can do with the intelligent orchestration platform for DevSecOps. Get your free trial Contact sales ® Footer links Pricing * View plans * Why Premium? * Why Ultimate? Contact Us * Contact sales * Support portal * Customer portal * Status * Terms of use * Privacy statement * Platform * Explore the platform * Agentic Orchestration * CI/CD * Context Graph * Why GitLab Topics * CI/CD * GitOps * DevOps * Version Control * DevSecOps * Cloud Native * AI for Coding * Agentic AI Solutions * DevOps modernization * Security modernization * AI modernization * Financial services * Public sector * Telecommunications * Automotive * Education * Aerospace * Enterprise * Small business * Startups * GitOps * Software composition analysis * Value stream management * All solutions Resources * Install * Quick start guides * Docs * University * Demo Series * Demo Hub * Services * Blog * Community * Customers * Partners * Events * Newsletter * What's new * All resources Company * About * Jobs * Press * Handbook * Leadership * Investor relations * Trust Center * AI Transparency Center * Sustainability * Diversity, inclusion and belonging (DIB) * Modern Slavery Transparency Statement * * * * Git is a trademark of Software Freedom Conservancy and our use of 'GitLab' is under license View page source Edit this page Please contribute © 2026 GitLab Inc.