VS Code Remote / GitHub Codespaces Container Definitions
Visual Studio Code Remote Development and GitHub Codespaces
Open your code in the cloud, in a local container, on a remote machine, or in WSL and take advantage of VS Code's full feature set.
A development container is a running Docker container with a well-defined tool/runtime stack and its prerequisites. The VS Code Remote - Containers extension and GitHub Codespaces allow you to open or clone code in a local or cloud-hosted dev container and take advantage of VS Code's full development feature set.
This repository contains a set of dev container definitions to help get you up and running with a containerized environment. The definitions describe the appropriate container image, runtime arguments for starting the container, and VS Code extensions that should be installed. Each provides a container configuration file (
devcontainer.json) and other needed files that you can drop into any existing folder as a starting point for containerizing your project. You can use the the Add Development Container Configuration Files... command to add one to your project or codespace.
The vscode-remote-try-* repositories may also be of interest if you are looking for complete sample projects.
Adding a definition to a project or codespace
- Either create a codespace for your repository or set up your local machine for use with the Remote - Containers extension, start VS Code, and open your project folder.
- Press F1, and select the Add Development Container Configuration Files... command for Remote-Containers or Codespaces.
- Pick one of the recommended definitions from the list or select Show All Definitions... to see all of them. You may need to choose the From a predefined container configuration definition... option if your project has an existing Dockerfile or Docker Compose file. Answer any questions that appear.
- See the definition's
READMEfor configuration options. A link is available in the
.devcontainer/devcontainer.jsonfile added to your folder.
- Run Remote-Containers: Reopen in Container to use it locally, or Codespaces: Rebuild Container from within a codespace.
Adding a definition to a repository
You can share a customized dev container definition for your project by adding the files under
.devcontainer to source control.
Anyone who then opens a local copy of your repo in VS Code will be prompted to reopen the folder in a container, provided they have the Remote - Containers extension installed. Additionally, this will be used whenever someone creates a codespace in GitHub Codespaces for the repository.
Your team now has a consistent environment and tool-chain and new contributors or team members can be productive quickly. First-time contributors will require less guidance and there will be fewer issues related to environment setup.
If you want to try a sample project which already has a dev container, check out one of the following repositories:
containers- Contains reusable dev container definitions.
script-library- Includes scripts used in this repository to install things. Also useful in your own Dockerfiles.
repository-containers- Dev container definitions for working public source code repositories. Only used by Remote - Containers.
container-templates- Contains templates for creating your own container definitions or to contribute back.
Can I just reuse an existing container image or Docker / Docker Compose configuration?
Yes! If you have a Dockerfile or Docker Compose file in your project/repository, follow the same steps to add a definition and you'll be prompted to select a Dockerfile or Docker Compose file and customize from there. If you then commit these files to a Git repository, you can use it with GitHub Codespaces as well. If you prefer, you can also start up the container manually and attach to it. However, note that many images will be missing things like
git that you will want to use. There are scripts in the script-library like the common script that can help adding these to your existing Dockerfile or image.
What is the goal of
devcontainer.json file is similar to
launch.json for debugging, but designed to launch (or attach to) a development container instead. At its simplest, all you need is a
.devcontainer/devcontainer.json file in your project that references an image,
docker-compose.yml, and a few properties. You can adapt it for use in a wide variety of situations.
Why do Dockerfiles in this repo use
RUN statements with commands separated by
RUN statement creates a Docker image "layer". If one
RUN statement adds temporary contents, these contents remain in this layer in the image even if they are deleted in a subsequent
RUN. This means the image takes more storage locally and results in slower image download times if you publish the image to a registry. You can resolve this problem by using a
RUN statement that includes any clean up steps (separated by
&&) after a given operation. See CONTRIBUTING.md for more tips.
Contributing and feedback
Have a question or feedback?
- Contribute or provide feedback for the VS Code Remote extensions or GitHub Codespaces.
- Search existing issues with dev container definitions or report a problem.
- Contribute a development container definition to the repository.
Copyright (c) Microsoft Corporation. All rights reserved.
Licensed under the MIT License. See LICENSE.