For short or blended options like -y as compared to --confirm (the long option), use one dash (-). For long options, use two dashes (-- as in --confirm). Blended options are short options combined into one statement, like -y -d -v put together as -ydv.
Always use -y to ensure nothing stops and prompts for more than 30 seconds.
When using options prefer a longer name (--name versus the short -n) to make the scripts more self-documenting. The exception here is -y.
When using options that have a value passed, add an = between and surround the value with "''" (--name="'value'"). This ensures that the argument is not split between different versions/editions of Chocolatey. This also ensures that values like . and \ are not escaped by PowerShell.
These suggestions may need to be validated to ensure that Boxstarter will work with them due to some of its overrides.
https://github.com/Microsoft/windows-dev-box-setup-scripts/blob/7393a07208fefc5f3d1f645764f42d7607ef8597/dev_web.ps1#L24
-y
as compared to--confirm
(the long option), use one dash (-
). For long options, use two dashes (--
as in--confirm
). Blended options are short options combined into one statement, like-y -d -v
put together as-ydv
.-y
to ensure nothing stops and prompts for more than 30 seconds.--name
versus the short-n
) to make the scripts more self-documenting. The exception here is-y
.=
between and surround the value with"''"
(--name="'value'"
). This ensures that the argument is not split between different versions/editions of Chocolatey. This also ensures that values like.
and\
are not escaped by PowerShell.These suggestions may need to be validated to ensure that Boxstarter will work with them due to some of its overrides.