Skip to content

Commit ef75a79

Browse files
authored
choco*: add short options (#18015)
1 parent f3c2b58 commit ef75a79

File tree

10 files changed

+28
-28
lines changed

10 files changed

+28
-28
lines changed

pages/windows/choco-apikey.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@
99

1010
- Display a specific source and its API key:
1111

12-
`choco apikey --source "{{source_url}}"`
12+
`choco apikey {{[-s|--source]}} "{{source_url}}"`
1313

1414
- Set an API key for a source:
1515

16-
`choco apikey --source "{{source_url}}" --key "{{api_key}}"`
16+
`choco apikey {{[-s|--source]}} "{{source_url}}" {{[-k|--api-key]}} "{{api_key}}"`
1717

1818
- Remove an API key for a source:
1919

20-
`choco apikey --source "{{source_url}}" --remove`
20+
`choco apikey {{[-s|--source]}} "{{source_url}}" --remove`

pages/windows/choco-info.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@
99

1010
- Display information for a local package only:
1111

12-
`choco info {{package}} --local-only`
12+
`choco info {{package}} {{[-l|--local-only]}}`
1313

1414
- Specify a custom source to receive packages information from:
1515

16-
`choco info {{package}} --source {{source_url|alias}}`
16+
`choco info {{package}} {{[-s|--source]}} {{source_url|alias}}`
1717

1818
- Provide a username and password for authentication:
1919

20-
`choco info {{package}} --user {{username}} --password {{password}}`
20+
`choco info {{package}} {{[-u|--user]}} {{username}} {{[-p|--password]}} {{password}}`

pages/windows/choco-list.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@
1313

1414
- Display a list including local programs:
1515

16-
`choco list --include-programs`
16+
`choco list {{[-i|--include-programs]}}`
1717

1818
- Display only approved packages:
1919

2020
`choco list --approved-only`
2121

2222
- Specify a custom source to display packages from:
2323

24-
`choco list --source {{source_url|alias}}`
24+
`choco list {{[-s|--source]}} {{source_url|alias}}`
2525

2626
- Provide a username and password for authentication:
2727

pages/windows/choco-new.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
- Create a new package in a custom output directory:
1919

20-
`choco new {{package}} --output-directory {{path/to/directory}}`
20+
`choco new {{package}} {{[--out|--output-directory]}} {{path/to/directory}}`
2121

2222
- Create a new package with specific 32-bit and 64-bit installer URLs:
2323

pages/windows/choco-pack.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313

1414
- Package a NuGet specification to a specific directory:
1515

16-
`choco pack {{path\to\specification_file}} --output-directory {{path\to\output_directory}}`
16+
`choco pack {{path\to\specification_file}} {{[--out|--output-directory]}} {{path\to\output_directory}}`

pages/windows/choco-pin.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@
1010

1111
- Pin a package at its current version:
1212

13-
`choco pin add --name {{package}}`
13+
`choco pin add {{[-n|--name]}} {{package}}`
1414

1515
- Pin a package at a specific version:
1616

17-
`choco pin add --name {{package}} --version {{version}}`
17+
`choco pin add {{[-n|--name]}} {{package}} --version {{version}}`
1818

1919
- Remove a pin for a specific package:
2020

21-
`choco pin remove --name {{package}}`
21+
`choco pin remove {{[-n|--name]}} {{package}}`

pages/windows/choco-push.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
66
- Push a compiled `nupkg` to the specified feed:
77

8-
`choco push --source {{https://push.chocolatey.org/}}`
8+
`choco push {{[-s|--source]}} {{https://push.chocolatey.org/}}`
99

1010
- Push a compiled `nupkg` to the specified feed with a timeout in seconds (default is 2700):
1111

12-
`choco push --source {{https://push.chocolatey.org/}} --execution-timeout {{500}}`
12+
`choco push {{[-s|--source]}} {{https://push.chocolatey.org/}} {{[--timeout|--execution-timeout]}} {{500}}`

pages/windows/choco-search.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,16 @@
1313

1414
- Only include exact matches in the results:
1515

16-
`choco search {{query}} --exact`
16+
`choco search {{query}} {{[-e|--exact]}}`
1717

1818
- Confirm all prompts automatically:
1919

20-
`choco search {{query}} --yes`
20+
`choco search {{query}} {{[-y|--yes]}}`
2121

2222
- Specify a custom source to search for packages in:
2323

24-
`choco search {{query}} --source {{source_url|alias}}`
24+
`choco search {{query}} {{[-s|--source]}} {{source_url|alias}}`
2525

2626
- Provide a username and password for authentication:
2727

28-
`choco search {{query}} --user {{username}} --password {{password}}`
28+
`choco search {{query}} {{[-u|--user]}} {{username}} {{[-p|--password]}} {{password}}`

pages/windows/choco-source.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,24 @@
99

1010
- Add a new package source:
1111

12-
`choco source add --name {{name}} --source {{url}}`
12+
`choco source add {{[-n|--name]}} {{name}} {{[-s|--source]}} {{url}}`
1313

1414
- Add a new package source with credentials:
1515

16-
`choco source add --name {{name}} --source {{url}} --user {{username}} --password {{password}}`
16+
`choco source add {{[-n|--name]}} {{name}} {{[-s|--source]}} {{url}} {{[-u|--user]}} {{username}} {{[-p|--password]}} {{password}}`
1717

1818
- Add a new package source with a client certificate:
1919

20-
`choco source add --name {{name}} --source {{url}} --cert {{path\to\certificate_file}}`
20+
`choco source add {{[-n|--name]}} {{name}} {{[-s|--source]}} {{url}} --cert {{path\to\certificate_file}}`
2121

2222
- Enable a package source:
2323

24-
`choco source enable --name {{name}}`
24+
`choco source enable {{[-n|--name]}} {{name}}`
2525

2626
- Disable a package source:
2727

28-
`choco source disable --name {{name}}`
28+
`choco source disable {{[-n|--name]}} {{name}}`
2929

3030
- Remove a package source:
3131

32-
`choco source remove --name {{name}}`
32+
`choco source remove {{[-n|--name]}} {{name}}`

pages/windows/choco.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,19 @@
22

33
> The Chocolatey package manager.
44
> Some subcommands such as `install` have their own usage documentation.
5-
> More information: <https://chocolatey.org>.
5+
> More information: <https://docs.chocolatey.org/en-us/choco/commands/>.
66
77
- Execute a Chocolatey command:
88

99
`choco {{command}}`
1010

1111
- Display help:
1212

13-
`choco -?`
13+
`choco {{[-h|--help]}}`
1414

1515
- Display help for a specific command:
1616

17-
`choco {{command}} -?`
17+
`choco {{command}} {{[-h|--help]}}`
1818

1919
- Display version:
2020

0 commit comments

Comments
 (0)