Skip to content

Commit 21d34e2

Browse files
doodzikmatifali
authored andcommitted
fix(docs): add dotfiles module reference (#14675)
Co-authored-by: Muhammad Atif Ali <me@matifali.dev> Co-authored-by: Muhammad Atif Ali <atif@coder.com>
1 parent b754034 commit 21d34e2

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/dotfiles.md

+14
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,20 @@ explains how it loads your repo.
1111

1212
You can read more on dotfiles best practices [here](https://dotfiles.github.io).
1313

14+
## Module
15+
16+
Coder's [dotfiles module](https://registry.coder.com/modules/dotfiles) abstracts
17+
Coder's dotfiles command into a module. This will prompt the user for their
18+
dotfiles repository URL on workspace creation using a coder_parameter.
19+
20+
```hcl
21+
module "dotfiles" {
22+
source = "registry.coder.com/modules/dotfiles/coder"
23+
version = "~>1.0.15"
24+
agent_id = coder_agent.example.id
25+
}
26+
```
27+
1428
## Templates
1529

1630
Templates can prompt users for their dotfiles repo using the following pattern:

0 commit comments

Comments
 (0)