feat: Add .chezmoi.args template variable

twpayne · Oct 29, 2021 · 9d621f7 · 9d621f7
1 parent 4c89ec8
commit 9d621f7
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 0 deletions.
diff --git a/docs/REFERENCE.md b/docs/REFERENCE.md
@@ -1762,6 +1762,7 @@ chezmoi provides the following automatically-populated variables:
 | Variable                   | Type       | Value                                                                                                                           |
 | -------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------- |
 | `.chezmoi.arch`            | `string`   | Architecture, e.g. `amd64`, `arm`, etc. as returned by [runtime.GOARCH](https://pkg.go.dev/runtime?tab=doc#pkg-constants).      |
+| `.chezmoi.args`            | `[]string` | The arguments passed to the `chezmoi` command, starting with the program command.                                               |
 | `.chezmoi.fqdnHostname`    | `string`   | The fully-qualified domain name hostname of the machine chezmoi is running on.                                                  |
 | `.chezmoi.group`           | `string`   | The group of the user running chezmoi.                                                                                          |
 | `.chezmoi.homeDir`         | `string`   | The home directory of the user running chezmoi.                                                                                 |

diff --git a/internal/cmd/config.go b/internal/cmd/config.go
@@ -889,6 +889,7 @@ func (c *Config) defaultTemplateData() map[string]interface{} {
 	return map[string]interface{}{
 		"chezmoi": map[string]interface{}{
 			"arch":         runtime.GOARCH,
+			"args":         os.Args,
 			"fqdnHostname": fqdnHostname,
 			"group":        group,
 			"homeDir":      c.homeDir,

diff --git a/internal/cmd/testdata/scripts/templatevars.txt b/internal/cmd/testdata/scripts/templatevars.txt
@@ -6,6 +6,9 @@ chezmoi execute-template '{{ .chezmoi.arch }}'
 [ppc64] stdout ppc64
 [ppc64le] stdout ppc64le
 
+chezmoi execute-template '{{ index .chezmoi.args 1 }}'
+stdout execute-template
+
 chezmoi execute-template '{{ .chezmoi.homeDir }}'
 stdout ${HOME@R}