Repository files navigation

IMPORTANT NOTE: Dev containers have a new, expanded home in thedev containers GitHub org! We're so excited to connect with you there. To learn more, you can check out ourmigration announcement.

This repository is no longer active and was archived in November 2023. We've migrated most of the contents of this repo to thedevcontainers GitHub org, as part of the work on theopen Dev Container specification.

• Features managed by the Dev Container spec maintainers (such as the VS Code team) are now indevcontainers/features.
• Definitions/Templates managed by the Dev Container spec maintainers are now indevcontainers/templates.
• mcr.microsoft.com/devcontainers andmcr.microsoft.com/vscode/devcontainers images are now published fromdevcontainers/images.

For new Templates/Features, you can now self-publish and optionally make them visible in-tool by following the steps one of the quick start repositories:Templates quick start,Features quick start. No need to submit a PR here anymore.

For more details, you can review theannouncement issue and latestarchiving announcement.

Visual Studio Code Dev Containers 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.

IMPORTANT NOTE: As noted in the section above, this repository is no longer active and will be archived in November 2023.

Adevelopment container is a runningDocker container with a well-defined tool/runtime stack and its prerequisites. TheVS Code Dev Containers extension andGitHub 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 ofDev Container definition templates 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 theAdd Development Container Configuration Files... command to add one to your project or codespace.

Thevscode-remote-try-* repositories may also be of interest if you are looking for complete sample projects.

1. Eithercreate a codespace for your repository orset up your local machine for use with the Dev Containers extension, start VS Code, and open your project folder.
2. PressF1, and select theAdd Development Container Configuration Files... command forDev Containers orCodespaces.
3. Pick one of the recommended definitions from the list or selectShow All Definitions... to see all of them. You may need to choose theFrom a predefined container configuration definition... option if your project has an existing Dockerfile or Docker Compose file. Answer any questions that appear.
4. See the definition'sREADME for configuration options. A link is available in the.devcontainer/devcontainer.json file added to your folder.
5. RunRemote-Containers: Reopen in Container to use it locally, orCodespaces: Rebuild Container from within a codespace.

You can share a customized Dev Container definitions 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 theDev Containers extension installed. Additionally, this will be used whenever someone creates a codespace inGitHub 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:

• Node Sample
• Python Sample
• Go Sample
• Java Sample
• .NET Core Sample
• Rust Sample
• C++ Sample
• PHP Sample

• containers - Contains reusable Dev Container definitions.
• script-library - Includes scripts used in this repository to install things. Also useful in your own Dockerfiles.
• container-templates - Contains templates for creating your own container definitions or tocontribute back.

Yes! If you have a Dockerfile or Docker Compose file in your project/repository, follow thesame 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 withGitHub Codespaces as well. If you prefer, you can also start up the container manually andattach to it. However, note that many images will be missing things likegit that you will want to use. There are scripts in thescript-library like thecommon script that can help adding these to your existing Dockerfile or image.

Adevcontainer.json file is similar tolaunch.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,Dockerfile, ordocker-compose.yml, and a few properties. You canadapt it for use in a wide variety of situations.

Have a question or feedback?

We've migrated most of the contents of this repo to thedevcontainers GitHub org, as part of the work on theopen Dev Container specification.

• Features managed by the Dev Container spec maintainers are now indevcontainers/features.
• Definitions/Templates managed by the Dev Container spec maintainers are now indevcontainers/templates.
• mcr.microsoft.com/devcontainers andmcr.microsoft.com/vscode/devcontainers images are now published fromdevcontainers/images.

As a result, this repository only used for community definitions that have not been migrated elsewhere by their owners. If you are a community owner and want us to remove an existing definition here, feel free to submit a PR to do so!

For new Templates/Features, you can now self-publish and optionally make them visible in-tool by following the steps one of the quick start repositories:Templates quick start,Features quick start.

You can also:

• Provide feedback for theVS Code Dev Containers extension orGitHub Codespaces.
• Discuss theDev Container spec orjoin the Slack channel
• Make proposals for improvments to theDev Container spec repository.
• Contribute to theDev Container CLI.

This project has adopted theMicrosoft Open Source Code of Conduct.For more information see theCode of Conduct FAQ orcontactopencode@microsoft.com with any additional questions or comments.

Copyright (c) Microsoft Corporation. All rights reserved.
Licensed under the MIT License. SeeLICENSE.

For images generated from this repository, seeLICENSE andNOTICE.txt.