search

microsoft / winget-cli

WinGet is the Windows Package Manager. This project includes a CLI (Command Line Interface), PowerShell modules, and a COM (Component Object Model) API (Application Programming Interface).
https://learn.microsoft.com/windows/package-manager/
MIT License
22.5k stars 1.39k forks source link

Add more examples of installer switches to docs #4535

Open SpecterShell opened 3 weeks ago

SpecterShell commented 3 weeks ago

Questions:

  1. Should we split the Silent and the SilentWithProgress switches into two columns?

  2. Should we add examples for each type of installer?

    Microsoft Reviewers: Open in CodeFlow
github-actions[bot] commented 3 weeks ago

@check-spelling-bot Report

:red_circle: Please review

See the :open_file_folder: files view or the :scroll:action log for details.

Unrecognized words (8)

actualinstaller advancedinstaller exenoui indigorose revenera tarma unattendedmodeui webhelp

Previously acknowledged words that are now absent ata bitspace EPester epth flexera helplib hrow issuetitle mapview Mta oop PFM rzkzqaqjwj sfs STARTUPINFOW testdata visualstudiocode :arrow_right:
To accept :heavy_check_mark: these unrecognized words as correct and remove the previously acknowledged and now absent words, run the following commands ... in a clone of the [git@github.com:SpecterShell/winget-cli.git](https://github.com/SpecterShell/winget-cli.git) repository on the `docs-installer-switches` branch ([:information_source: how do I use this?]( https://github.com/check-spelling/check-spelling/wiki/Accepting-Suggestions)): ``` sh curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/v0.0.21/apply.pl' | perl - 'https://github.com/microsoft/winget-cli/actions/runs/9362588104/attempts/1' ```
Available :books: dictionaries could cover words not in the :blue_book: dictionary This includes both **expected items** (549) from .github/actions/spelling/expect.txt and **unrecognized words** (8) Dictionary | Entries | Covers -|-|- [cspell:win32/src/win32.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/win32/src/win32.txt)|53509|20| [cspell:python/src/python/python-lib.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/python/src/python/python-lib.txt)|3873|3| [cspell:python/src/python/python.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/python/src/python/python.txt)|453|2| [cspell:python/src/common/extra.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/python/src/common/extra.txt)|741|2| [cspell:php/php.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/php/php.txt)|2597|2| [cspell:npm/npm.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/npm/npm.txt)|288|2| [cspell:django/django.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/django/django.txt)|859|2| [cspell:csharp/csharp.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/csharp/csharp.txt)|19|2| [cspell:sql/src/tsql.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/sql/src/tsql.txt)|455|1| [cspell:scala/scala.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/scala/scala.txt)|833|1| Consider adding them using (in `.github/workflows/spelling3.yml`): ``` yml with: extra_dictionaries: cspell:win32/src/win32.txt cspell:python/src/python/python-lib.txt cspell:python/src/python/python.txt cspell:python/src/common/extra.txt cspell:php/php.txt cspell:npm/npm.txt cspell:django/django.txt cspell:csharp/csharp.txt cspell:sql/src/tsql.txt cspell:scala/scala.txt ``` To stop checking additional dictionaries, add: ``` yml with: check_extra_dictionaries: '' ```
Warnings (1) See the [:open_file_folder: files](4535/files/) view or the [:scroll:action log](https://github.com/microsoft/winget-cli/actions/runs/9362588104/job/25771616943#step:4:1) for details. [:information_source: Warnings](https://github.com/check-spelling/check-spelling/wiki/Event-descriptions) | Count -|- [:information_source: unexpected-line-ending](https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#unexpected-line-ending) | 4 See [:information_source: Event descriptions](https://github.com/check-spelling/check-spelling/wiki/Event-descriptions) for more information.
If the flagged items are :exploding_head: false positives If items relate to a ... * binary file (or some other file you wouldn't want to check at all). Please add a file path to the `excludes.txt` file matching the containing file. File paths are Perl 5 Regular Expressions - you can [test]( https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files. `^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md]( ../tree/HEAD/README.md) (on whichever branch you're using). * well-formed pattern. If you can write a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it, try adding it to the `patterns.txt` file. Patterns are Perl 5 Regular Expressions - you can [test]( https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines. Note that patterns can't match multiline strings.
github-actions[bot] commented 3 weeks ago

@check-spelling-bot Report

:red_circle: Please review

See the :open_file_folder: files view or the :scroll:action log for details.

Unrecognized words (8)

actualinstaller advancedinstaller exenoui indigorose revenera tarma unattendedmodeui webhelp

Previously acknowledged words that are now absent ata bitspace EPester epth flexera helplib hrow issuetitle mapview Mta oop PFM rzkzqaqjwj sfs STARTUPINFOW testdata visualstudiocode :arrow_right:
To accept :heavy_check_mark: these unrecognized words as correct and remove the previously acknowledged and now absent words, run the following commands ... in a clone of the [git@github.com:SpecterShell/winget-cli.git](https://github.com/SpecterShell/winget-cli.git) repository on the `docs-installer-switches` branch ([:information_source: how do I use this?]( https://github.com/check-spelling/check-spelling/wiki/Accepting-Suggestions)): ``` sh curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/v0.0.21/apply.pl' | perl - 'https://github.com/microsoft/winget-cli/actions/runs/9362697249/attempts/1' ```
Available :books: dictionaries could cover words not in the :blue_book: dictionary This includes both **expected items** (549) from .github/actions/spelling/expect.txt and **unrecognized words** (8) Dictionary | Entries | Covers -|-|- [cspell:win32/src/win32.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/win32/src/win32.txt)|53509|20| [cspell:python/src/python/python-lib.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/python/src/python/python-lib.txt)|3873|3| [cspell:python/src/python/python.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/python/src/python/python.txt)|453|2| [cspell:python/src/common/extra.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/python/src/common/extra.txt)|741|2| [cspell:php/php.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/php/php.txt)|2597|2| [cspell:npm/npm.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/npm/npm.txt)|288|2| [cspell:django/django.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/django/django.txt)|859|2| [cspell:csharp/csharp.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/csharp/csharp.txt)|19|2| [cspell:sql/src/tsql.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/sql/src/tsql.txt)|455|1| [cspell:scala/scala.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/scala/scala.txt)|833|1| Consider adding them using (in `.github/workflows/spelling3.yml`): ``` yml with: extra_dictionaries: cspell:win32/src/win32.txt cspell:python/src/python/python-lib.txt cspell:python/src/python/python.txt cspell:python/src/common/extra.txt cspell:php/php.txt cspell:npm/npm.txt cspell:django/django.txt cspell:csharp/csharp.txt cspell:sql/src/tsql.txt cspell:scala/scala.txt ``` To stop checking additional dictionaries, add: ``` yml with: check_extra_dictionaries: '' ```
Warnings (1) See the [:open_file_folder: files](4535/files/) view or the [:scroll:action log](https://github.com/microsoft/winget-cli/actions/runs/9362697249/job/25771937073#step:4:1) for details. [:information_source: Warnings](https://github.com/check-spelling/check-spelling/wiki/Event-descriptions) | Count -|- [:information_source: unexpected-line-ending](https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#unexpected-line-ending) | 4 See [:information_source: Event descriptions](https://github.com/check-spelling/check-spelling/wiki/Event-descriptions) for more information.
If the flagged items are :exploding_head: false positives If items relate to a ... * binary file (or some other file you wouldn't want to check at all). Please add a file path to the `excludes.txt` file matching the containing file. File paths are Perl 5 Regular Expressions - you can [test]( https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files. `^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md]( ../tree/HEAD/README.md) (on whichever branch you're using). * well-formed pattern. If you can write a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it, try adding it to the `patterns.txt` file. Patterns are Perl 5 Regular Expressions - you can [test]( https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines. Note that patterns can't match multiline strings.
denelon commented 3 weeks ago

Splitting into columns might help users, and if you are pointing to some relatively stable manifests with switches, it might help. I'd just be concerned about a manifest getting removed or installer type changing, but permalinks might work.