diff --git a/docs/dotfiles.md b/docs/dotfiles.md index ba5409ccd1537..5b6e5beb1c60c 100644 --- a/docs/dotfiles.md +++ b/docs/dotfiles.md @@ -11,6 +11,20 @@ explains how it loads your repo. You can read more on dotfiles best practices [here](https://dotfiles.github.io). +## Module + +Coder's [dotfiles module](https://registry.coder.com/modules/dotfiles) abstracts +Coder's dotfiles command into a module. This will prompt the user for their +dotfiles repository URL on workspace creation using a coder_parameter. + +```hcl +module "dotfiles" { + source = "registry.coder.com/modules/dotfiles/coder" + version = "~>1.0.15" + agent_id = coder_agent.example.id +} +``` + ## Templates Templates can prompt users for their dotfiles repo using the following pattern: