Skip to content

Commit 6dd6404

Browse files
authored
add dotfiles module reference
1 parent 7ea8a22 commit 6dd6404

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/dotfiles.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,21 @@ 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)
17+
abstracts Coder's dotfiles command into a module. This will prompt the
18+
user for their dotfiles repository URL on template creation using a
19+
coder_parameter.
20+
21+
```hcl
22+
module "dotfiles" {
23+
source = "registry.coder.com/modules/dotfiles/coder"
24+
version = "~>1.0.15"
25+
agent_id = coder_agent.example.id
26+
}
27+
```
28+
1429
## Templates
1530

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

0 commit comments

Comments
 (0)