-
Notifications
You must be signed in to change notification settings - Fork 469
/
variables.md.yaml
409 lines (409 loc) · 11.2 KB
/
variables.md.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
sections:
'':
cacheDir:
default: >-
`$XDG_CACHE_HOME/chezmoi` <br/>
`$HOME/.cache/chezmoi` <br/>
`%USERPROFILE%/.cache/chezmoi`
description: Cache directory
color:
default: '`auto`'
description: Colorize output
data:
type: object
description: Template data
destDir:
default: >-
`$HOME` <br/>
`%USERPROFILE%`
description: Destination directory
encryption:
description: Encryption type, either `age` or `gpg`
env:
type: object
description: Extra environment variables for scripts and commands
format:
default: '`json`'
description: Format for data output, either `json` or `yaml`
mode:
default: '`file`'
description: Mode in target dir, either `file` or `symlink`
pager:
default: '`$PAGER`'
description: Default pager CLI command
persistentState:
default: >-
`$XDG_CONFIG_HOME/chezmoi/chezmoi.boltdb` <br/>
`$HOME/.config/chezmoi/chezmoi.boltdb` <br/>
`%USERPROFILE%/.config/chezmoi/chezmoi.boltdb`
description: Location of the persistent state file
progress:
type: bool
description: Display progress bars
scriptEnv:
type: object
description: Extra environment variables for scripts and commands
scriptTempDir:
description: Temporary directory for scripts
sourceDir:
default: >-
`$XDG_SHARE_HOME/chezmoi` <br/>
`$HOME/.local/share/chezmoi` <br/>
`%USERPROFILE%/.local/share/chezmoi`
description: Source directory
umask:
type: int
default: '*from system*'
description: Umask
useBuiltinAge:
default: '`auto`'
description: Use builtin age if `age` command is not found in `$PATH`
useBuiltinGit:
default: '`auto`'
description: Use builtin git if `git` command is not found in `$PATH`
verbose:
type: bool
description: Make output more verbose
workingTree:
default: '*source directory*'
description: git working tree directory
add:
encrypt:
type: bool
description: Encrypt by default
secrets:
default: '`warning`'
description: Action when secrets are found when adding files
templateSymlinks:
type: bool
description: Template symlinks to source and home dirs
age:
args:
type: '[]string'
description: Extra args to age CLI command
command:
default: '`age`'
description: age CLI command
identity:
description: age identity file
identities:
type: '[]string'
description: age identity files
passphrase:
type: bool
description: Use age passphrase instead of identity
recipient:
description: age recipient
recipients:
type: '[]string'
description: age recipients
recipientsFile:
description: age recipients file
recipientsFiles:
type: '[]string'
description: age recipients files
suffix:
default: '`.age`'
description: Suffix appended to age-encrypted files
symmetric:
type: bool
description: Use age symmetric encryption
awsSecretsManager:
profile:
description: AWS shared profile name
region:
description: AWS region
azureKeyVault:
defaultVault:
description: Default Azure Key Vault name
bitwarden:
command:
default: '`bw`'
description: Bitwarden CLI command
bitwardenSecrets:
command:
default: '`bws`'
description: Bitwarden Secrets CLI command
cd:
args:
type: '[]string'
description: Extra args to shell in `cd` command
command:
description: Shell to run in `cd` command
completion:
custom:
type: bool
description: Enable custom shell completions
dashlane:
args:
type: '[]string'
description: Extra args to Dashlane CLI command
command:
default: '`dcli`'
description: Dashlane CLI command
diff:
args:
type: '[]string'
default: '*see `diff` below*'
description: Extra args to external diff command
command:
description: External diff command
exclude:
type: '[]string'
description: Entry types to exclude from diffs
pager:
description: Diff-specific pager
reverse:
type: bool
description: Reverse order of arguments to diff
scriptContents:
type: bool
default: '`true`'
description: Show script contents
doppler:
args:
type: '[]string'
description: Extra args to Doppler CLI command
command:
default: '`doppler`'
description: Doppler CLI command
config:
type: string
description: Default config (aka environment) if none is specified
project:
type: string
description: Default project name if none is specified
edit:
apply:
type: bool
description: Apply changes on exit
args:
type: '[]string'
description: Extra args to edit command
command:
default: '`$EDITOR` / `$VISUAL`'
description: Edit command
hardlink:
type: bool
default: '`true`'
description: Invoke editor with a hardlink to the source file
minDuration:
type: duration
default: '`1s`'
description: Minimum duration for edit command
watch:
type: bool
description: Automatically apply changes when files are saved
ejson:
keyDir:
type: string
description: Path to directory containing private keys. Defaults to /opt/ejson/keys. Setting the EJSON_KEYDIR environment will also set this value, with lower precedence.
key:
type: string
description: The private key to use for decryption, will supersede using the keyDir if set.
git:
autoAdd:
type: bool
description: Add changes to the source state after any change
autoCommit:
type: bool
description: Commit changes to the source state after any change
autoPush:
type: bool
description: Push changes to the source state after any change
command:
default: '`git`'
description: git CLI command
commitMessageTemplate:
type: string
description: Commit message template
commitMessageTemplateFile:
type: string
description: Commit message template file (relative to source directory)
gitHub:
refreshPeriod:
type: duration
default: '`1m`'
description: Minimum duration between identical GitHub API requests
gopass:
command:
default: '`gopass`'
description: gopass CLI command
gpg:
args:
type: '[]string'
description: Extra args to GPG CLI command
command:
default: '`gpg`'
description: GPG CLI command
recipient:
description: GPG recipient
recipients:
type: '[]string'
description: GPG recipients
suffix:
default: '`.asc`'
description: Suffix appended to GPG-encrypted files
symmetric:
type: bool
description: Use symmetric GPG encryption
hcpVaultSecrets:
applicationName:
type: string
description: Default application name if none is specified
args:
type: '[]string'
description: Extra args to HCP Vault Secrets CLI command
command:
default: '`vlt`'
description: HCP Vault Secrets CLI command
organizationId:
type: string
description: Default organization ID if none is specified
projectId:
type: string
description: Default project ID if none is specified
hooks:
'*command*`.post.args`':
type: '[]string'
description: Extra arguments to command to run after *command*
'*command*`.post.command`':
type: '[]string'
description: Command to run after *command*
'*command*`.pre.args`':
type: '[]string'
description: Extra arguments to command to run before *command*
'*command*`.pre.command`':
type: '[]string'
description: Command to run before *command*
interpreters:
'*extension*.`args`':
type: '[]string'
description: See section on "Scripts on Windows"
'*extension*.`command`':
default: '*special*'
description: See section on "Scripts on Windows"
keepassxc:
args:
type: '[]string'
description: Extra args to KeePassXC CLI command
command:
default: '`keepassxc-cli`'
description: KeePassXC CLI command
database:
description: KeePassXC database
mode:
default: '`cache-password`'
description: See section on KeePassXC
prompt:
type: bool
default: '`true`'
description: Prompt for password
keeper:
args:
type: '[]string'
description: Extra args to Keeper CLI command
command:
default: '`keeper`'
description: Keeper CLI command
lastpass:
command:
default: '`lpass`'
description: LastPass CLI command
merge:
args:
type: '[]string'
default: '*see `merge` below*'
description: Extra args to three-way merge CLI command
command:
description: Three-way merge CLI command
onepassword:
cache:
type: bool
default: '`true`'
description: Enable optional caching provided by `op`
command:
default: '`op`'
description: 1Password CLI command
prompt:
type: bool
default: '`true`'
description: Prompt for sign-in when no valid session is available
pass:
command:
default: '`pass`'
description: Pass CLI command
passhole:
args:
type: '[]string'
description: Extra args to Passhole CLI command
command:
default: '`ph`'
description: Passhole CLI command
prompt:
type: bool
default: '`true`'
description: Prompt for password
pinentry:
args:
type: '[]string'
description: Extra args to pinentry CLI command
command:
description: pinentry CLI command
options:
type: '[]string'
default: '*see `pinentry` below*'
description: Extra options for pinentry
rbw:
command:
default: '`rbw`'
description: Unofficial Bitwarden CLI command
secret:
args:
type: '[]string'
description: Extra args to secret CLI command
command:
description: Generic secret CLI command
status:
exclude:
type: '[]string'
description: Entry types to exclude from status
pathStyle:
type: string
default: '`relative`'
description: How to present the path to files in status output
template:
options:
type: '[]string'
default: '`["missingkey=error"]`'
description: Template options
textconv:
'':
type: '[]object'
description: See section on "textconv"
vault:
command:
default: '`vault`'
description: Vault CLI command
update:
apply:
type: 'bool'
default: '`true`'
description: Apply after pulling
args:
type: '[]string'
description: Extra args to update command
command:
description: Update command
recurseSubmodules:
type: bool
default: '`true`'
description: Update submodules recursively
verify:
exclude:
type: '[]string'
description: Entry types to exclude from verify
warnings:
'':
type: object
description: See section on "Warnings"