Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs for templates apply command #388

Merged
merged 2 commits into from
Feb 2, 2023
Merged

Docs for templates apply command #388

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1ca68a7
templates apply command
joshspicer Jan 30, 2023
c3d66f5
Update apply.md
joshspicer Jan 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/templates/apply.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Applying a Dev Container Template to a folder with the CLI

## Summary

The CLI can be used to apply (download) a [Dev Container Template](https://containers.dev/implementors/templates) to a provided folder.

Templates can be published via the `templates publish` command - see [the template-starter repo](https://github.com/devcontainers/template-starter) for more information.

To see all the available options, run `devcontainers templates apply --help`.

## Example

To apply the [debian template](https://github.com/devcontainers/templates/tree/main/src/debian) to a local folder with the CLI, execute the following steps.

![example](https://user-images.githubusercontent.com/23246594/215609996-c1109c72-1a05-410e-83a6-86a782cce929.png)
joshspicer marked this conversation as resolved.
Show resolved Hide resolved

Any omitted `templateArgs` will be substituted with the `default` value declared in the Template's `devcontainer-template.json`.