Repository files navigation

Development Container Templates A simple set of dev container 'templates' to help get you up and running with a containerized environment.

Adevelopment container is a runningDocker container with a well-defined tool/runtime stack and its prerequisites. It allows you to use a container as a full-featured development environment which can be used to run an application, to separate tools, libraries, or runtimes needed for working with a codebase, and to aid in continuous integration and testing.

This repository contains a set ofDev Container Templates which are source files packaged together that encode configuration for a complete development environment. A Template can be used in a new or existing project, and asupporting tool will use the configuration from the template to build a development container.

• src - A collection of subfolders, each declaring a template. Each subfolder contains at least adevcontainer-template.json and adevcontainer.json.
• test - Mirroringsrc, a folder-per-template with at least atest.sh script. These tests are executed by theCI.

A variety of tools and servicessupport the Dev Container Spec, and they may provide direct integrations with the Templates in this repo. For instance,Visual Studio Code andGitHub Codespaces provide a user-friendly interface to configure the Templates hosted in this repository, as well as thecommunity-contributed Templates. Additionally, you can customize your dev container with additional availableFeatures.

For more information, please refer to the following documents forVS Code andGithub Codespaces.

The@devcontainers/cli offers adevcontainer templates apply command to apply a Template hosted in the supported OCI registry.

devcontainer templates applyApply a template to the projectOptions:      --help              Show help                                                                            [boolean]      --version           Show version number                                                                  [boolean]  -w, --workspace-folder  Target workspace folder to apply Template                   [string] [required] [default: "."]  -t, --template-id       Reference to a Template in a supported OCI registry                        [string] [required]  -a, --template-args     Arguments to replace within the provided Template, provided as JSON   [string] [default: "{}"]  -f, --features          Features to add to the provided Template, provided as JSON.           [string] [default: "[]"]      --log-level         Log level.                               [choices: "info", "debug", "trace"] [default: "info"]      --tmp-dir           Directory to use for temporary files. If not provided, the system default will be inferred.                                                                                                                [string]

devcontainer templates apply --workspace-folder . \    --template-id ghcr.io/devcontainers/templates/cpp:latest \    --template-args '{ "imageVariant": "debian-12" }' \    --features '[{ "id": "ghcr.io/devcontainers/features/azure-cli:1", "options": { "version" : "1" } }]'

TheDev Container Template specification outlines a pattern for community members and organizations to self-author Templates in repositories they control.

A starter repositorydevcontainers/template-starter andGitHub Action are available to help bootstrap self-authored Templates.

We are eager to hear your feedback on self-authoring! Please provide comments and feedback onspec issue #71.

This repository will accept improvement and bug fix contributions related to thecurrent set of maintained templates.

Issues related to these templates can be reported inan issue in this repository.

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