Text of code.visualstudio.com › docs › devcontainers › create-dev-container as Styx crawled it on Nov 19, 2026. The page may have changed since. Only its words are kept, without pictures or layout, and only the first part of a long page.

Open the live page

Create a Dev Container

AI agents: See llms.txt for documentation discovery and navigation. Documentation articles are also available as Markdown by appending .md to the article URL. Join VS Code at Microsoft Ignite or catch the sessions online. A year of VS Code, wrapped. Explore the highlights. Create a Dev Container View as Markdown Ask in VS Code Ask in VS Code Insiders The Visual Studio Code Dev Containers extension lets you use a Docker container as a full-featured development environment.

It allows you to open any folder or repository inside a container and take advantage of Visual Studio Code's full feature set. A devcontainer.json file in your project tells VS Code how to access (or create) a development container with a well-defined tool and runtime stack. This container can be used to run an application or to provide separate tools, libraries, or runtimes needed for working with a codebase. Path to creating a dev container In this document, we'll go through the steps for creating a development (dev) container in VS Code: Create a devcontainer.json , which describes how VS Code should start the container and what to do after it connects.

Make and persist changes to the dev container, such as installation of new software, through use of a Dockerfile. Configure multiple containers through Docker Compose. As you make changes, build your dev container to ensure changes take effect. After any of the steps above, you'll have a fully functioning dev container, and you can either continue to the next step of this tutorial to add more features, or stop and begin working in the dev environment you currently have.

Note: The Dev Containers extension has a Dev Containers: Add Dev Container Configuration Files... command that lets you pick a pre-defined container configuration from a list. If you'd prefer to have a complete dev container immediately rather than building up the devcontainer.json and Dockerfile step-by-step, you can skip ahead to Automate dev container creation . Create a devcontainer.json file VS Code's container configuration is stored in a devcontainer.json file.

This file is similar to the launch.json file for debugging configurations, but is used for launching (or attaching to) your development container instead. The dev container configuration is either located under .devcontainer/devcontainer.json or stored as a .devcontainer.json file (note the dot-prefix) in the root of your project. You can use an image as a starting point for your devcontainer.json . An image is like a mini-disk drive with various tools and an operating system pre-installed.

You can pull images from a container registry, which is a collection of repositories that store images. Here is a simple example devcontainer.json that uses a pre-built TypeScript and Node.js VS Code Development Container image : { "image" : "mcr.microsoft.com/devcontainers/typescript-node:0-18" } You can alter your configuration to do things such as: Install additional tools such as Git in the container. Automatically install extensions.

Forward or publish additional ports. Set runtime arguments. Reuse or extend your existing Docker Compose setup . Add more Advanced container configuration . For this example, if you'd like to install the Code Spell Checker extension into your container and automatically forward port 3000, your devcontainer.json would look like: { "image" : "mcr.microsoft.com/devcontainers/typescript-node" , "customizations" : { "vscode" : { "extensions" : [ "streetsidesoftware.code-spell-checker" ] } }, "forwardPorts" : [ 3000 ] } Note: Additional configuration will already be added to the container based on what's in the base image.

For example, we add the streetsidesoftware.code-spell-checker extension above, and the container will also include "dbaeumer.vscode-eslint" as that's part of mcr.microsoft.com/devcontainers/typescript-node . This happens automatically when pre-building using devcontainer.json, which you may read more about in the pre-build section . With the above devcontainer.json , your dev container is functional, and you can connect to and start developing within it.

Try it out with the Dev Containers: Reopen in Container command: After running this command, when VS Code restarts, you're now within a Node.js and TypeScript dev container with port 3000 forwarded and the ESLint extension installed. Once you're connected, notice the green remote indicator on the left of the Status bar to show you are connected to your dev container: Additional dev container scenarios Through a devcontainer.json file, you can: Spin up a stand-alone container to isolate your toolchain or speed up setup.

Work with a container deployed application defined by an image, Dockerfile , or Docker Compose . Use Docker or Kubernetes from inside a dev container to build and deploy your app. If devcontainer.json 's supported workflows do not meet your needs, you can also attach to an already running container instead . Tip: Want to use a remote Docker host? See the Develop on a remote Docker host article for details on setup. Install additional software You may want to install additional software in your dev container.

Once VS Code is connected to the container, you can open a VS Code terminal and execute any command against the OS inside the container. This allows you to install new command-line utilities and spin up databases or application services from inside the Linux container. Most container images are based on Debian or Ubuntu, where the apt or apt-get command is used to install new packages. You can learn more about the command in Ubuntu's documentation .

Alpine images include a similar apk command while CentOS / RHEL / Oracle SE / Fedora images use yum or more recently dnf . Documentation for the software you want to install will usually provide specific instructions, but you may not need to prefix commands with sudo if you are running as root in the container. For example: # If running as root apt-get update apt-get install < packag e> If you are running as root, you can install software as long as sudo is configured in your container.

All predefined containers have sudo set up, but the Add a non-root user to a container article can help you set this up for your own containers. Regardless, if you install and configure sudo , you'll be able to use it when running as any user including root. # If sudo is installed and configured sudo apt-get update sudo apt-get install < packag e> Let's say you want to install Git. You could run the following commands in the integrated terminal in VS Code: # If sudo is installed and configured sudo apt-get update # Install Git sudo apt-get install git You may also use the "features" property in the devcontainer.json to install tools and languages from a pre-defined set of Features or even your own.

For example, you could install the latest version of the Azure CLI with the following: "features" : { "ghcr.io/devcontainers/features/azure-cli:1" : { "version" : "latest" } } See the Dev Container Features specification for more details. Rebuild When editing the contents of the .devcontainer folder, you'll need to rebuild for changes to take effect. Use the Dev Containers: Rebuild Container command for your container to update.

If you use agent chat in the container, review how to preserve chat sessions across rebuilds before rebuilding. However, if you rebuild the container, you will have to reinstall anything you've installed manually. To avoid this problem, you can use the postCreateCommand property in devcontainer.json or a custom Dockerfile . A custom Dockerfile will benefit from Docker's build cache and result in faster rebuilds than postCreateCommand .

However, the Dockerfile runs before the dev container is created and the workspace folder is mounted and therefore does not have access to the files in the workspace folder. A Dockerfile is most suitable for installing packages and tools independent of your workspace files. The postCreateCommand actions are run once the

The rest of this page is on the live site.