Repository files navigation

The Docker extension makes it easy to build, manage, and deploy containerized applications from Visual Studio Code. It also provides one-click debugging of Node.js, Python, and .NET inside a container.

Check out theWorking with containers topic on the Visual Studio Code documentation site to get started.

The Docker extension wiki has troubleshooting tips and additional technical information.

Install Docker on your machine and add it to the system path.

On Linux, you shouldenable rootless Docker and set the generated Docker context to "rootless" (more secure) orenable Docker CLI for the non-root user account (less secure) that will be used to run VS Code.

To install the extension, open the Extensions view, search fordocker to filter results and select Docker extension authored by Microsoft.

You can get IntelliSense when editing yourDockerfile anddocker-compose.yml files, with completions and syntax help for common commands.

In addition, you can use the Problems panel (Ctrl+Shift+M on Windows/Linux,Shift+Command+M on Mac) to view common errors forDockerfile anddocker-compose.yml files.

You can add Docker files to your workspace by opening the Command Palette (F1) and usingDocker: Add Docker Files to Workspace command. The command will generate aDockerfile and.dockerignore file and add them to your workspace. The command will also ask you if you want to add Docker Compose files as well, but this is optional.

The extension can scaffold Docker files for most popular development languages (C#, Node.js, Python, Ruby, Go, and Java) and customizes the generated Docker files accordingly. When these files are created, we also create the necessary artifacts to provide first-class debugging support for Node.js, Python, and .NET (C#).

The Docker extension contributes a Docker Explorer view to VS Code. The Docker Explorer lets you examine and manage Docker assets: containers, images, volumes, networks, and container registries.

The right-click menu provides access to commonly used commands for each type of asset.

You can rearrange the Docker view panes by dragging them up or down with a mouse and use the context menu to hide or show them.

Many of the most common Docker commands are built right into the Command Palette:

You can run Docker commands to manageimages,networks,volumes,image registries, andDocker Compose. In addition, theDocker: Prune System command will remove stopped containers, dangling images, and unused networks and volumes.

Docker Compose lets you define and run multi-container applications with Docker. OurCompose Language Service in the Docker extension gives you IntelliSense and tab completions when authoringdocker-compose.yml files. PressCtrl+Space to see a list of valid Compose directives.

We also provide tooltips when you hover over a Docker Compose YAML attribute.

WhileCompose Up allows you to run all of your services at once, our new featureCompose Up - Select Services lets you select any combination of the services you want to run.

Once yourCompose Up command completes, navigate to the Docker Explorer to view your services as a Compose Group. This allows you to start, stop, and view the logs of each service as a group.

You can display the content and push, pull, or delete images fromDocker Hub andAzure Container Registry:

An image in an Azure Container Registry can be deployed to Azure App Service directly from VS Code. SeeDeploy images to Azure App Service to get started. For more information about how to authenticate to and work with registries, seeUsing container registries.

You can debug services built using Node.js, Python, or .NET (C#) that are running inside a container. The extension offers custom tasks that help with launching a service under the debugger and with attaching the debugger to a running service instance. For more information, seeDebug containerized apps andCustomize the Docker extension.

You can start Azure CLI (command-line interface) in a standalone, Linux-based container withDocker Images: Run Azure CLI command. This gives you access to the full Azure CLI command set in an isolated environment. For more information on available commands, seeGet started with Azure CLI.

Seethe contribution guidelines for ideas and guidance on how to improve the extension. Thank you!

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

VS Code collects usage data and sends it to Microsoft to help improve our products and services. Read ourprivacy statement to learn more. If you don’t wish to send usage data to Microsoft, you can set thetelemetry.telemetryLevel setting tooff. Learn more in ourFAQ.

MIT