diff --git a/.build/compile.step b/.build/compile.step
index df0452e71d..62aaf4ec6b 100644
--- a/.build/compile.step
+++ b/.build/compile.step
@@ -108,14 +108,12 @@
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index fce17313d4..2bfa507794 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -2,7 +2,7 @@
REPORTING A SECURITY FINDING?
Stop, this is not the correct place to provide a security disclosure.
-Please go to https://chocolatey.org/security for the proper disclosure process.
+Please go to https://docs.chocolatey.org/en-us/information/security for the proper disclosure process.
BEFORE YOU SUBMIT AN ISSUE:
diff --git a/.github/ISSUE_TEMPLATE/AskQuestion.md b/.github/ISSUE_TEMPLATE/AskQuestion.md
index e8d529bfe0..a2c10d7513 100644
--- a/.github/ISSUE_TEMPLATE/AskQuestion.md
+++ b/.github/ISSUE_TEMPLATE/AskQuestion.md
@@ -5,7 +5,7 @@ about: Do you have a question?
STOP RIGHT HERE - DO NOT CREATE A TICKET FOR A QUESTION ON THIS REPOSITORY
-1. Start with https://chocolatey.org/docs/troubleshooting (Troubleshooting) and https://chocolatey.org/docs/chocolatey-faqs (FAQs) to see if your question or issue already has an answer. You can also explore https://chocolatey.org/docs (which are pretty comprehensive, but not always the most searchable).
+1. Start with https://docs.chocolatey.org/en-us/troubleshooting (Troubleshooting) and https://docs.chocolatey.org/en-us/faqs (FAQs) to see if your question or issue already has an answer. You can also explore https://docs.chocolatey.org/en-us/ (which are pretty comprehensive, but not always the most searchable).
2. If not found or resolved, please see https://chocolatey.org/support to see what avenues are available to you based on whether you are an open source user or a licensed customer (have a commercial edition).
diff --git a/.github/ISSUE_TEMPLATE/ReportPackageIssue.md b/.github/ISSUE_TEMPLATE/ReportPackageIssue.md
index 8cb2de665b..ddf94ac11e 100644
--- a/.github/ISSUE_TEMPLATE/ReportPackageIssue.md
+++ b/.github/ISSUE_TEMPLATE/ReportPackageIssue.md
@@ -5,14 +5,14 @@ about: Something went wrong with an installation? Want a package to be added to
STOP RIGHT HERE - DO NOT CREATE A TICKET FOR PACKAGES ON THIS REPOSITORY
-This is the repository for choco.exe, the command line interface for Chocolatey, and issues/feature suggestions should be limited to only choco. For a package failure, typically you would be reporting an issue with a package on the community package repository, which is not what this repository represents. In fact, the community repository and all of its packages represents about 5% of the packages in existence and less than half of the usage of choco itself.
+This is the repository for choco.exe, the command line interface for Chocolatey, and issues/feature suggestions should be limited to only choco. For a package failure, typically you would be reporting an issue with a package on the community package repository, which is not what this repository represents. In fact, the community repository and all of its packages represents about 5% of the packages in existence and less than half of the usage of choco itself.
In other words Chocolatey != Chocolatey.org Packages.
For all things packages, you have two routes:
-1. If you are having issue with a package or you want to see an enhancement, please see https://chocolatey.org/docs/package-triage-process (Package Triage Process / Becoming a maintainer of existing packages).
-2. If you are looking for packages to be added to the community package repository (aka https://chocolatey.org/packages), please see https://chocolatey.org/docs/package-triage-process#package-request-package-missing (Package Requests).
+1. If you are having issue with a package or you want to see an enhancement, please see https://docs.chocolatey.org/en-us/community-repository/users/package-triage-process (Package Triage Process / Becoming a maintainer of existing packages).
+2. If you are looking for packages to be added to the community package repository (aka https://community.chocolatey.org/packages), please see https://docs.chocolatey.org/en-us/community-repository/users/package-triage-process#package-request-package-missing (Package Requests).
diff --git a/.github/ISSUE_TEMPLATE/ReportWebsiteIssue.md b/.github/ISSUE_TEMPLATE/ReportWebsiteIssue.md
index f9927c6e99..fa551b2019 100644
--- a/.github/ISSUE_TEMPLATE/ReportWebsiteIssue.md
+++ b/.github/ISSUE_TEMPLATE/ReportWebsiteIssue.md
@@ -1,13 +1,13 @@
---
name: Website - Report Issue / Suggest Feature
-about: Something weird about https://chocolatey.org or do you want to suggest a feature?
+about: Something weird about https://community.chocolatey.org or do you want to suggest a feature?
---
STOP RIGHT HERE - DO NOT CREATE A TICKET FOR THE WEBSITE ON THIS REPOSITORY
This is the repository for choco.exe, the command line interface for Chocolatey, and issues/feature suggestions should be limited to only choco.
-For Chocolatey Gallery aka Chocolatey Community Package Repository, you will need to head over to https://github.com/chocolatey/chocolatey.org and file a ticket there.
+For Chocolatey Gallery aka Chocolatey Community Package Repository, you will need to head over to https://github.com/chocolatey/home and file a ticket there.
diff --git a/.github/SECURITY.md b/.github/SECURITY.md
index fc8bb5354b..43998ec9bb 100644
--- a/.github/SECURITY.md
+++ b/.github/SECURITY.md
@@ -2,5 +2,5 @@
Security reports should never start out in the open. Please follow up directly
with the team if you have a contact. If not you can always start with the
-information at https://chocolatey.org/security to see instructions on how to
-provide the disclosure. Thank you!
+information at https://docs.chocolatey.org/en-us/information/security to see
+instructions on how to provide the disclosure. Thank you!
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
new file mode 100644
index 0000000000..73b3553bb8
--- /dev/null
+++ b/.github/workflows/build.yml
@@ -0,0 +1,42 @@
+name: Chocolatey Builds
+
+on:
+ # Trigger on pushes to master and stable, or with pull requests
+ push:
+ branches:
+ - master
+ - stable
+ pull_request:
+ branches:
+ - master
+ - stable
+
+ # Allows you to run this workflow manually from the Actions tab
+ workflow_dispatch:
+
+jobs:
+ # Build using mono on Ubuntu
+ ubuntu-build:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+ - name: Build with Mono
+ run: |
+ chmod +x build.sh
+ $GITHUB_WORKSPACE//build.sh -v
+ # Build on Windows
+ windows-build:
+ runs-on: windows-latest
+ steps:
+ - uses: actions/checkout@v2
+ - name: Build with .Net Framework
+ run: .\build.bat -v
+ # Build using mono on MacOS
+ macos-build:
+ runs-on: macos-latest
+ steps:
+ - uses: actions/checkout@v2
+ - name: Build with Mono
+ run: |
+ chmod +x build.sh
+ $GITHUB_WORKSPACE//build.sh -v
\ No newline at end of file
diff --git a/.gitignore b/.gitignore
index 301537b097..32976f4a68 100644
--- a/.gitignore
+++ b/.gitignore
@@ -36,3 +36,5 @@ SolutionVersion.vb
src/_dotCover.chocolatey/
src/_dotTrace.chocolatey/
src/chocolatey.sln.GhostDoc.xml
+
+docs/generated
\ No newline at end of file
diff --git a/.travis.yml b/.travis.yml
index bf92067bca..e1f2471ade 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -1,6 +1,7 @@
language: csharp
+dist: bionic
mono:
- - 5.20.1
+ - 6.12.0
install:
- sudo apt-get install mono-devel
- nuget restore src/chocolatey.sln
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 93d10607aa..a9fb907c5e 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -156,7 +156,7 @@ We've also brought in the long desired logging with no colorization. You can set
## [0.10.8](https://github.com/chocolatey/choco/issues?q=milestone%3A0.10.8+is%3Aclosed) (August 30, 2017)
-With this release, Package Parameters are fully supported from both the user side and the packaging side. Check out [the documentation](https://chocolatey.org/docs/helpers-get-packageparameters) and check out the [walkthrough](https://chocolatey.org/docs/how-to-parse-package-parameters-argument) on how to use package parameters in your packaging. Note if you are pushing packages to the community repository, you must continue to take a dependency on the `chocolatey-core.extension` as a polyfill for older versions until at least six months after a new feature is released.
+With this release, Package Parameters are fully supported from both the user side and the packaging side. Check out [the documentation](https://docs.chocolatey.org/en-us/create/functions/get-packageparameters) and check out the [walkthrough](https://docs.chocolatey.org/en-us/guides/create/parse-packageparameters-argument) on how to use package parameters in your packaging. Note if you are pushing packages to the community repository, you must continue to take a dependency on the `chocolatey-core.extension` as a polyfill for older versions until at least six months after a new feature is released.
What you can do with logging has greatly increased your ability to have more power over how it works and deeper output to determine errors (we've expanded `--trace` [#1379](https://github.com/chocolatey/choco/issues/1379)). This release also gives packagers and users more power when working with the AutoUninstaller - opt-out ([#1257](https://github.com/chocolatey/choco/issues/1257)) and passing arguments to the uninstaller ([#1133](https://github.com/chocolatey/choco/issues/1133)).
@@ -463,7 +463,7 @@ What was planned for 0.9.10.4 is now 0.10.0. This is due partly to a breaking ch
### BREAKING CHANGES
* [Security] Checksum requirement and enhancements - see [#112](https://github.com/chocolatey/choco/issues/112)
-Checksums in package scripts are meant as a measure to validate the originally intended downloaded resources used in the creation of a package are the same files that are received at a future date. This also ensures that the same files that are checked by all parts of moderation (if applicable) are the same files that are received by users for a package. This is seen mostly on the community repository because it is public and packages are subject to copyright laws (distribution rights), which typically requires the package scripts to download software from the official distribution locations. The Chocolatey framework has had the ability to use checksums in package scripts since [July 2014](https://chocolatey.org/packages/chocolatey/0.9.8.24#releasenotes).
+Checksums in package scripts are meant as a measure to validate the originally intended downloaded resources used in the creation of a package are the same files that are received at a future date. This also ensures that the same files that are checked by all parts of moderation (if applicable) are the same files that are received by users for a package. This is seen mostly on the community repository because it is public and packages are subject to copyright laws (distribution rights), which typically requires the package scripts to download software from the official distribution locations. The Chocolatey framework has had the ability to use checksums in package scripts since [July 2014](https://community.chocolatey.org/packages/chocolatey/0.9.8.24#releasenotes).
**What is the requirement?** choco will now fail if a package download resources from HTTP/FTP and does not use checksums to verify those downloaded resources. The requirement for HTTP/FTP is [#112](https://github.com/chocolatey/choco/issues/112). We are considering also requiring it for [HTTPS (#895)](https://github.com/chocolatey/choco/issues/895) as well. You can optionally set a feature (`allowEmptyChecksumsSecure`) to ensure packages using HTTPS also use checksums.
@@ -474,11 +474,11 @@ Checksums in package scripts are meant as a measure to validate the originally i
**Can I shut this behavior off or opt out per package?**
You can shut off the checksum requirement by enabling the feature `allowEmptyChecksums`. This will return Chocolatey to previous behavior. We strongly recommend against it.
-You can shut it off or turn it per package install/upgrade with `--allow-empty-checksums` and `--require-checksums`, respectively. See https://chocolatey.org/docs/commands-install / https://chocolatey.org/docs/commands-upgrade.
+You can shut it off or turn it per package install/upgrade with `--allow-empty-checksums` and `--require-checksums`, respectively. See https://docs.chocolatey.org/en-us/choco/commands/install / https://docs.chocolatey.org/en-us/choco/commands/upgrade.
You can also disable the feature `allowEmptyChecksumsSecure` to enforce checksums for packages that download from secure locations (HTTPS).
-**Other things I should know?** Users also now have the ability to pass their own checksums and checksumtypes into the install. See https://chocolatey.org/docs/commands-install / https://chocolatey.org/docs/commands-upgrade.
+**Other things I should know?** Users also now have the ability to pass their own checksums and checksumtypes into the install. See https://docs.chocolatey.org/en-us/choco/commands/install / https://docs.chocolatey.org/en-us/choco/commands/upgrade.
### KNOWN ISSUES
* [Known Issues](https://github.com/chocolatey/choco/labels/Bug)
@@ -552,7 +552,7 @@ You can also disable the feature `allowEmptyChecksumsSecure` to enforce checksum
## [0.9.10](https://github.com/chocolatey/choco/issues?q=milestone%3A0.9.10+is%3Aclosed) (June 17, 2016)
-
+
The "I got 99 problems, but a package manager ain't one" release. With the release of 0.9.10 (or if you prefer 0.9.10.0), we're about to make everything 100% better in your Windows package management world. We've addressed over 100 features and bugs in this release. We looked at how we could improve PowerShell and we've come out with a [competely internal host](https://github.com/chocolatey/choco/issues/8) that can Prompt and Read-Host in a way that times out and selects default values after a period of time. Speaking of PowerShell, how about some tab completion `choco <tab>` to `choco install node<tab>`? How about never having to [close and reopen your shell again](https://github.com/chocolatey/choco/issues/664)?
@@ -562,7 +562,7 @@ Here's one you probably never knew existed - extensions. Chocolatey has had the
We redesigned our `choco new` default packaging template and we've made managing templates as easy as managing packages.
-`choco search`/`choco list` has so many enhancements, you may not need to visit dot org again. [See it in action](https://chocolatey.org/docs/commands-list#see-it-in-action).
+`choco search`/`choco list` has so many enhancements, you may not need to visit dot org again. [See it in action](https://docs.chocolatey.org/en-us/choco/commands/list#see-it-in-action).
* [search -v provides moderation related information and a world of nuspec information](https://github.com/chocolatey/choco/issues/493)
* [search by id only](https://github.com/chocolatey/choco/issues/663)
* [search by id exact](https://github.com/chocolatey/choco/issues/453)
@@ -615,8 +615,8 @@ This further restricts the default installation location by removing all permiss
* Uninstall-ChocolateyEnvironmentVariable function - see [#772](https://github.com/chocolatey/choco/issues/772)
* Get-UninstallRegistryKey function - see [#739](https://github.com/chocolatey/choco/issues/739)
* Pro/Business - Ubiquitous Install Directory Switch - see [#258](https://github.com/chocolatey/choco/issues/258)
- * Pro/Business - Runtime Virus Scanning - see [virus scanning](https://chocolatey.org/docs/features-virus-check)
- * Pro/Business - Private CDN cache for downloads - see [private CDN cache](https://chocolatey.org/docs/features-private-cdn)
+ * Pro/Business - Runtime Virus Scanning - see [virus scanning](https://docs.chocolatey.org/en-us/features/virus-check)
+ * Pro/Business - Private CDN cache for downloads - see [private CDN cache](https://docs.chocolatey.org/en-us/features/private-cdn)
* Pro/Business - Sync "choco installed status" with "Windows installed status" - see [#567](https://github.com/chocolatey/choco/issues/567)
### BUG FIXES
@@ -994,13 +994,13 @@ We'll try to capture everything here that you should know about. Please call `ch
### FEATURES
* In app documentation! Use `choco -?`, `choco -h` or `choco commandName -?` to learn about each command, complete with examples!
- * WhatIf/Noop mode for all commands (`--noop` can also be specified as `-whatif`) - see [Chocolatey #263](https://github.com/chocolatey/chocolatey/issues/263) and [Default Options and Switches](https://chocolatey.org/docs/commands-reference#how-to-pass-options-switches)
+ * WhatIf/Noop mode for all commands (`--noop` can also be specified as `-whatif`) - see [Chocolatey #263](https://github.com/chocolatey/chocolatey/issues/263) and [Default Options and Switches](https://docs.chocolatey.org/en-us/choco/commands#how-to-pass-options-switches)
* Performs like a package manager, expect to see queries failing because of unmet dependency issues.
* **New Commands:**
- 1. `pin` - Suppress upgrades. This allows you to 'pin' an install to a particular version - see [#1](https://github.com/chocolatey/choco/issues/1), [Chocolatey #5](https://github.com/chocolatey/chocolatey/issues/5) and [Pin Command](https://chocolatey.org/docs/commands-pin)
- 2. `apikey` - see [ApiKey Command](https://chocolatey.org/docs/commands-apikey)
- 3. `new` - see [New Command](https://chocolatey.org/docs/commands-new) and [Chocolatey #157](https://github.com/chocolatey/chocolatey/issues/157)
- * New ways to pass arguments! See [How to Pass Options/Switches](https://chocolatey.org/docs/commands-reference#how-to-pass-options-switches)
+ 1. `pin` - Suppress upgrades. This allows you to 'pin' an install to a particular version - see [#1](https://github.com/chocolatey/choco/issues/1), [Chocolatey #5](https://github.com/chocolatey/chocolatey/issues/5) and [Pin Command](https://docs.chocolatey.org/en-us/choco/commands/pin)
+ 2. `apikey` - see [ApiKey Command](https://docs.chocolatey.org/en-us/create/commands/api-key)
+ 3. `new` - see [New Command](https://docs.chocolatey.org/en-us/create/commands/new) and [Chocolatey #157](https://github.com/chocolatey/chocolatey/issues/157)
+ * New ways to pass arguments! See [How to Pass Options/Switches](https://docs.chocolatey.org/en-us/choco/commands#how-to-pass-options-switches)
* Did we mention there is a help menu that is actually helpful now? Shiny!
* AutoUninstaller!!!! But it is not enabled by default this version. See [#15](https://github.com/chocolatey/choco/issues/15), [#9](https://github.com/chocolatey/choco/issues/9) and [Chocolatey #6](https://github.com/chocolatey/chocolatey/issues/6)
* **New Helpers:**
@@ -1011,7 +1011,7 @@ Probably a lot of bug fixes that may not make it here, but here are the ones we
* Fix - Cannot upgrade from prerelease to same version released - see [Chocolatey #122](https://github.com/chocolatey/chocolatey/issues/122)
* Fix - install `--force` should not use cache - see [Chocolatey #199](https://github.com/chocolatey/chocolatey/issues/199)
- * Fix - force dependencies as well - see [--force-dependencies](https://chocolatey.org/docs/commands-install) and [Chocolatey #199](https://github.com/chocolatey/chocolatey/issues/199)
+ * Fix - force dependencies as well - see [--force-dependencies](https://docs.chocolatey.org/en-us/choco/commands/install) and [Chocolatey #199](https://github.com/chocolatey/chocolatey/issues/199)
* Fix - Chocolatey should not stop on error - see [Chocolatey #192](https://github.com/chocolatey/chocolatey/issues/192)
* Fix - Upgrading does not remove previous version - see [Chocolatey #259](https://github.com/chocolatey/chocolatey/issues/259)
* Fix - Non-elevated shell message spills errors - see [Chocolatey #540](https://github.com/chocolatey/chocolatey/issues/540)
@@ -1036,7 +1036,7 @@ Probably a lot of bug fixes that may not make it here, but here are the ones we
* Add $env:CHOCOLATEY_VERSION - see [Chocolatey #251](https://github.com/chocolatey/chocolatey/issues/251)
* Replace ascii cue with visual cues - see [Chocolatey #376](https://github.com/chocolatey/chocolatey/pull/376)
* Uninstall all versions of an app - see [Chocolatey #389](https://github.com/chocolatey/chocolatey/issues/389)
- * Add parameters in packages.config files - see [Packages.config](https://chocolatey.org/docs/commands-install#packages.config), [Chocolatey #472](https://github.com/chocolatey/chocolatey/issues/472), and [#10](https://github.com/chocolatey/choco/issues/10)
+ * Add parameters in packages.config files - see [Packages.config](https://docs.chocolatey.org/en-us/choco/commands/install#packages.config), [Chocolatey #472](https://github.com/chocolatey/chocolatey/issues/472), and [#10](https://github.com/chocolatey/choco/issues/10)
* Choco pack should support `-version` - see [Chocolatey #526](https://github.com/chocolatey/chocolatey/issues/526)
* Enhancements to Start-ChocolateyProcessAsAdmin - see [Chocolatey #564](https://github.com/chocolatey/chocolatey/pull/564)
* Install-ChocolateyFileAssociation - add label to new file types - see [Chocolatey #564](https://github.com/chocolatey/chocolatey/pull/564)
diff --git a/CHANGELOG_LICENSED.md b/CHANGELOG_LICENSED.md
index 9933f78cb9..7354b9c3e4 100644
--- a/CHANGELOG_LICENSED.md
+++ b/CHANGELOG_LICENSED.md
@@ -93,7 +93,7 @@ When we first released package reducer, it was in a preview mode to allow for fo
### FEATURES
* Run background service interactively - sometimes you install applications that are unattended but cannot be silent.
-If you want self-service to interactively manage installations, run `choco feature enable --name=useBackgroundServiceInteractively`. This requires that you use the `ChocolateyLocalAdmin` account with the Chocolatey-managed password as passwords are not stored and the service would need to produce that at runtime. There are some security considerations and why this is not turned on by default. Please see [interactive self-service consideration](https://chocolatey.org/docs/features-agent-service#interactive-self-service-consideration).
+If you want self-service to interactively manage installations, run `choco feature enable --name=useBackgroundServiceInteractively`. This requires that you use the `ChocolateyLocalAdmin` account with the Chocolatey-managed password as passwords are not stored and the service would need to produce that at runtime. There are some security considerations and why this is not turned on by default. Please see [interactive self-service consideration](https://docs.chocolatey.org/en-us/features/self-service-anywhere#interactive-self-service-consideration).
### BUG FIXES
* Windows Service Management Functions:
@@ -160,7 +160,7 @@ If you want self-service to interactively manage installations, run `choco featu
### IMPROVEMENTS
* Self-Service / Background Mode:
- * Allow commands to be configurable. Covered in more detail at https://chocolatey.org/docs/features-agent-service#setup.
+ * Allow commands to be configurable. Covered in more detail at https://docs.chocolatey.org/en-us/features/self-service-anywhere#setup.
## 1.12.3 (September 8, 2017)
@@ -231,13 +231,13 @@ Among the bug fixes, we've brought Package Internalizer to the MSP edition of Ch
If you have a significant number of Chocolatey packages you manage, you may notice that you also may have a pretty significant space usage under the Chocolatey lib directory. Package reducer automatically decreases the size of nupkg files to around 5KB and removes installers and zips automatically from your package install directories. This may allow you to save GBs of usage for a large amount of packages being managed.
- To learn more about Package Reducer and `choco optimize`, please see https://chocolatey.org/docs/features-package-reducer.
+ To learn more about Package Reducer and `choco optimize`, please see https://docs.chocolatey.org/en-us/features/package-reducer.
* Package Audit (C4B) - Learn Who and When
Reporting is very important, and auditing not only when your installations occurred but who installed them can be critical. There is nothing that presents this kind of information as easily as you will be able to gather it with Chocolatey for Business (C4B) and Package Audit.
- To learn more about Package Audit, please see https://chocolatey.org/docs/features-package-audit.
+ To learn more about Package Audit, please see https://docs.chocolatey.org/en-us/features/package-audit.
### IMPROVEMENTS
* Package Internalizer (Choco Download):
@@ -271,18 +271,18 @@ This release brings Package Throttle, Package Synchronizer's "Show All Packages
If you are using self-service functionality, when you upgrade to v1.10, you will need to go to those sources that you allow to be self-service and ensure they are selected to allow self-service (`choco source list`). Otherwise by default users are going to be locked out of using those sources. The move to opt-in is best from a security standpoint and we want to give you the ability to have folks opt-in to the better behavior.
- To change this behavior back to the way it was previously, simply run `choco disable -n useBackgroundServiceWithSelfServiceSourcesOnly`. For more details see `choco feature list` or https://chocolatey.org/docs/chocolatey-configuration#self-service-background-mode
+ To change this behavior back to the way it was previously, simply run `choco disable -n useBackgroundServiceWithSelfServiceSourcesOnly`. For more details see `choco feature list` or https://docs.chocolatey.org/en-us/configuration#self-service-background-mode
### FEATURES
* Package Throttle - Throttle Bandwidth / Rate Limit Download Speeds
- By default, Chocolatey downloads packages and resources as fast as it can. Package Throttle gives you a way to slow down Chocolatey so it doesn't overwhelm any bandwidth restrictions you may have. This is done as both a setting and per package install/upgrade. This is in bits per second (not bytes, bits is what most network traffic is measured in). When adding at runtime, simply add `--bps=VALUE`. To set the value in the configuration, call `choco config set maximumDownloadRateBitsPerSecond VALUE`. For more details see https://chocolatey.org/docs/features-package-reducer.
+ By default, Chocolatey downloads packages and resources as fast as it can. Package Throttle gives you a way to slow down Chocolatey so it doesn't overwhelm any bandwidth restrictions you may have. This is done as both a setting and per package install/upgrade. This is in bits per second (not bytes, bits is what most network traffic is measured in). When adding at runtime, simply add `--bps=VALUE`. To set the value in the configuration, call `choco config set maximumDownloadRateBitsPerSecond VALUE`. For more details see https://docs.chocolatey.org/en-us/features/package-reducer.
* Package Synchronizer's Show All Packages In Programs and Features
This means packages that do not have an underlying installation can still show up in Programs and Features and be managed there as well, which allows for legacy inventory reporting systems to see all the software that is installed in the same way that Chocolatey is able to. A picture can probably best explain this feature, check out [All Package In Programs and Features](https://raw.githubusercontent.com/chocolatey/choco-wiki/e619d5d25018f9362d50749ee86554ebc4f4f04d/images/features/features_packages_in_programs_and_features.png)
- To turn this feature on, simply run the following command `choco feature enable -n showAllPackagesInProgramsAndFeatures`. For more details on the feature, see https://chocolatey.org/docs/chocolatey-configuration#package-synchronizer and https://chocolatey.org/docs/features-synchronize. This does require one additional run of `choco` to take affect (same when disabling the feature), hopefully we can remove that in the future.
+ To turn this feature on, simply run the following command `choco feature enable -n showAllPackagesInProgramsAndFeatures`. For more details on the feature, see https://docs.chocolatey.org/en-us/configuration#package-synchronizer and https://docs.chocolatey.org/en-us/features/package-synchronization/packages-to-programs. This does require one additional run of `choco` to take affect (same when disabling the feature), hopefully we can remove that in the future.
* Package-less Install / Direct Installer - Install and upgrade directly from installers (MSIs, EXEs, etc)!
@@ -383,7 +383,7 @@ This release brings Package Throttle, Package Synchronizer's "Show All Packages
This release brings the coveted PackageBuilder UI to the Pro+ license (minus auto detection) and adds a tabbed interface that allows you to fill out the entire nuspec. Package Synchronizer now has `choco sync` to compliment the automatic synchronization. The sync command brings all unmanaged software in Programs and Features under Chocolatey management.
### FEATURES
- * Package Synchronizer v2 - `choco sync` to associate existing packages with unmanaged software - see https://chocolatey.org/docs/features-synchronize#sync-command
+ * Package Synchronizer v2 - `choco sync` to associate existing packages with unmanaged software - see https://docs.chocolatey.org/en-us/features/package-synchronization/sync-command#sync-command
* Package Builder UI:
* Starts at Professional edition (minus autodetection)
* Tabbed interface
@@ -418,7 +418,7 @@ This release brings the coveted PackageBuilder UI to the Pro+ license (minus aut
## 1.8.4 (January 5, 2017)
### FEATURES
- * Support Self-Service Install / Background Mode - see https://chocolatey.org/docs/features-agent-service
+ * Support Self-Service Install / Background Mode - see https://docs.chocolatey.org/en-us/features/self-service-anywhere
* Manage Windows Services
We've introduced some service management functions to the business edition. `Install-ChocolateyWindowsService`, `Uninstall-ChocolateyWindowsService`, `Start-ChocolateyWindowsService`, and `Stop-ChocolateyWindowsService`. Those will be documented soon enough. For now some example code should suffice.
@@ -513,7 +513,7 @@ Uninstall-ChocolateyWindowsService -Name 'chocolatey-agent'
## 1.8.0 (November 16, 2016)
-Package Builder has some major improvements in this release, including a new UI! See https://chocolatey.org/blog/package-builder-announcements for details! While building some of the features for the enhancements for this release, we've made quite a few tweaks and fixes to Package Builder and we think you are going to like the results. Being able to generate packages from the installed software on a reference system is huge (`choco new --from-programs-and-features`)!
+Package Builder has some major improvements in this release, including a new UI! See https://blog.chocolatey.org/2016/11/package-builder-announcements/ for details! While building some of the features for the enhancements for this release, we've made quite a few tweaks and fixes to Package Builder and we think you are going to like the results. Being able to generate packages from the installed software on a reference system is huge (`choco new --from-programs-and-features`)!
Pro users now have the ability to download packages (minus internalization). This is fantastic if you want to pull down a lot of packages quickly from a remote source. Or pull down packages and push them up to an internal source.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index c75b28ff86..721513a3c2 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -45,10 +45,10 @@ Submitting an Issue (or a Bug)? See the **[Submitting Issues](https://github.com
Do not submit issues for missing `SolutionVersion.cs`. Please see [Compiling / Building Source](https://github.com/chocolatey/choco#compiling--building-source).
### Package Issue?
-Please see [Request Package Fixes or Updates / Become a maintainer of an existing package](https://chocolatey.org/docs/package-triage-process).
+Please see [Request Package Fixes or Updates / Become a maintainer of an existing package](https://docs.chocolatey.org/en-us/community-repository/users/package-triage-process).
### Package Request? Package Missing?
-If you are looking for packages to be added to the community feed (aka https://chocolatey.org/packages), please see [Package Requests](https://chocolatey.org/docs/package-triage-process#package-request-package-missing).
+If you are looking for packages to be added to the community feed (aka https://community.chocolatey.org/packages), please see [Package Requests](https://docs.chocolatey.org/en-us/community-repository/users/package-triage-process#package-request-package-missing).
### Submitting an Enhancement / Feature Request?
If this is for choco (the CLI tool), this is the right place. See below. Otherwise see [Submitting Issues](https://github.com/chocolatey/choco#submitting-issues) for enhancements to the website, enhancements to the ChocolateyGUI, etc.
@@ -222,7 +222,7 @@ A commit should observe the following:
A commit message should observe the following (based on ["A Note About Git Commit Messages"](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)):
- * The first line of the commit message should be a short description around 50 characters in length and be prefixed with the GitHub issue it refers to with parentheses surrounding that. If the GitHub issue is #25, you should have `(GH-25)` prefixed to the message.
+ * The first line of the commit message should be a short description around 50 characters in length and be prefixed with the GitHub issue it refers to with parentheses surrounding that. If the GitHub issue is #25, you should have `(#25)` prefixed to the message. **NOTE:** Previously, the requirement was to use something like `(GH-25)` in commit messages, however, that approach has been deprecated.
* If the commit is about documentation, the message should be prefixed with `(doc)`.
* If it is a trivial commit or one of formatting/spaces fixes, it should be prefixed with `(maint)`.
* After the subject, skip one line and fill out a body if the subject line is not informative enough.
@@ -235,7 +235,7 @@ A commit message should observe the following (based on ["A Note About Git Commi
A good example of a commit message is as follows:
```
-(GH-7) Installation Adds All Required Folders
+(#7) Installation Adds All Required Folders
Previously the installation script worked for the older version of
Chocolatey. It does not work similarly for the newer version of choco
diff --git a/GenerateDocs.ps1 b/GenerateDocs.ps1
index a736cc996e..0be09afc32 100644
--- a/GenerateDocs.ps1
+++ b/GenerateDocs.ps1
@@ -24,26 +24,43 @@ $psModuleLocation = [System.IO.Path]::GetFullPath("$thisDirectory\src\chocolatey
$docsFolder = [System.IO.Path]::GetFullPath("$thisDirectory\docs\generated")
$chocoExe = [System.IO.Path]::GetFullPath("$thisDirectory\code_drop\chocolatey\console\choco.exe")
$lineFeed = "`r`n"
-$sourceLocation = 'https://github.com/chocolatey/choco/tree/stable/'
+$sourceLocation = 'https://github.com/chocolatey/choco/blob/stable/'
$sourceCommands = $sourceLocation + 'src/chocolatey/infrastructure.app/commands'
$sourceFunctions = $sourceLocation + 'src/chocolatey.resources/helpers/functions'
$global:powerShellReferenceTOC = @'
+---
+Order: 40
+xref: powershell-reference
+Title: PowerShell Reference
+Description: PowerShell Functions aka Helpers Reference
+RedirectFrom:
+ - docs/helpers-reference
+ - docs/HelpersReference
+---
+
# PowerShell Functions aka Helpers Reference
+
+## Summary
+
+In your Chocolatey packaging, you have the ability to use these functions (and others with Chocolatey's [PowerShell Extensions](xref:extensions)) to work with all aspects of software management. Keep in mind Chocolatey's automation scripts are just PowerShell, so you can do manage anything you want.
+
+> :memo: **NOTE** These scripts are for package scripts, not for use directly in PowerShell. This is in the create packages section, not the using Chocolatey section.
+
## Main Functions
-These functions call other functions and many times may be the only thing you need in your [[chocolateyInstall.ps1 file|ChocolateyInstallPS1]].
+These functions call other functions and many times may be the only thing you need in your [chocolateyInstall.ps1 file](xref:chocolatey-install-ps1).
-* [[Install-ChocolateyPackage|HelpersInstallChocolateyPackage]]
-* [[Install-ChocolateyZipPackage|HelpersInstallChocolateyZipPackage]]
-* [[Install-ChocolateyPowershellCommand|HelpersInstallChocolateyPowershellCommand]]
-* [[Install-ChocolateyVsixPackage|HelpersInstallChocolateyVsixPackage]]
+* [Install-ChocolateyPackage](xref:install-chocolateypackage)
+* [Install-ChocolateyZipPackage](xref:install-chocolateyzippackage)
+* [Install-ChocolateyPowershellCommand](xref:install-chocolateypowershellcommand)
+* [Install-ChocolateyVsixPackage](xref:install-chocolateyvsixpackage)
## Error / Success Functions
-* [[Write-ChocolateySuccess|HelpersWriteChocolateySuccess]] - **DEPRECATED**
-* [[Write-ChocolateyFailure|HelpersWriteChocolateyFailure]] - **DEPRECATED**
+* [Write-ChocolateySuccess](xref:write-chocolateysuccess) - **DEPRECATED**
+* [Write-ChocolateyFailure](xref:write-chocolateyfailure) - **DEPRECATED**
You really don't need a try catch with Chocolatey PowerShell files anymore.
@@ -53,13 +70,13 @@ You really don't need a try catch with Chocolatey PowerShell files anymore.
When creating packages that need to run one of the following commands below, one should add the tag `admin` to the nuspec.
-* [[Install-ChocolateyPackage|HelpersInstallChocolateyPackage]]
-* [[Start-ChocolateyProcessAsAdmin|HelpersStartChocolateyProcessAsAdmin]]
-* [[Install-ChocolateyInstallPackage|HelpersInstallChocolateyInstallPackage]]
-* [[Install-ChocolateyPath|HelpersInstallChocolateyPath]] - when specifying machine path
-* [[Install-ChocolateyEnvironmentVariable|HelpersInstallChocolateyEnvironmentVariable]] - when specifying machine path
-* [[Install-ChocolateyExplorerMenuItem|HelpersInstallChocolateyExplorerMenuItem]]
-* [[Install-ChocolateyFileAssociation|HelpersInstallChocolateyFileAssociation]]
+* [Install-ChocolateyPackage](xref:install-chocolateypackage)
+* [Start-ChocolateyProcessAsAdmin](xref:start-chocolateyprocessasadmin)
+* [Install-ChocolateyInstallPackage](xref:install-chocolateyinstallpackage)
+* [Install-ChocolateyPath](xref:install-chocolateypath) - when specifying machine path
+* [Install-ChocolateyEnvironmentVariable](xref:install-chocolateyenvironmentvariable) - when specifying machine path
+* [Install-ChocolateyExplorerMenuItem](xref:install-chocolateyexplorermenuitem)
+* [Install-ChocolateyFileAssociation](xref:install-chocolateyfileassociation)
### Non-Administrator Safe Functions
@@ -67,18 +84,19 @@ When you have a need to run Chocolatey without Administrative access required (n
These are the functions from above as one list.
-* [[Install-ChocolateyZipPackage|HelpersInstallChocolateyZipPackage]]
-* [[Install-ChocolateyPowershellCommand|HelpersInstallChocolateyPowershellCommand]]
-* [[Write-ChocolateySuccess|HelpersWriteChocolateySuccess]]
-* [[Write-ChocolateyFailure|HelpersWriteChocolateyFailure]]
-* [[Get-ChocolateyWebFile|HelpersGetChocolateyWebFile]]
-* [[Get-ChocolateyUnzip|HelpersGetChocolateyUnzip]]
-* [[Install-ChocolateyPath|HelpersInstallChocolateyPath]] - when specifying user path
-* [[Install-ChocolateyEnvironmentVariable|HelpersInstallChocolateyEnvironmentVariable]] - when specifying user path
-* [[Install-ChocolateyDesktopLink|HelpersInstallChocolateyDesktopLink]] - **DEPRECATED** - see [[Install-ChocolateyShortcut|HelpersInstallChocolateyShortcut]]
-* [[Install-ChocolateyPinnedTaskBarItem|HelpersInstallChocolateyPinnedTaskBarItem]]
-* [[Install-ChocolateyShortcut|HelpersInstallChocolateyShortcut]] - v0.9.9+
-* [[Update-SessionEnvironment|HelpersUpdateSessionEnvironment]]
+* [Install-ChocolateyZipPackage](xref:install-chocolateyzippackage)
+* [Install-ChocolateyPowershellCommand](xref:install-chocolateypowershellcommand)
+* [Write-ChocolateySuccess](xref:write-chocolateysuccess)
+* [Write-ChocolateyFailure](xref:write-chocolateyfailure)
+* [Get-ChocolateyWebFile](xref:get-chocolateywebfile)
+* [Get-ChocolateyUnzip](xref:get-chocolateyunzip)
+* [Install-ChocolateyPath](xref:install-chocolateypath) - when specifying user path
+* [Install-ChocolateyEnvironmentVariable](xref:install-chocolateyenvironmentvariable) - when specifying user path
+* [Install-ChocolateyDesktopLink](xref:install-chocolateydesktoplink) - **DEPRECATED** - see [Install-ChocolateyShortcut](xref:install-chocolateyshortcut)
+* [Install-ChocolateyPinnedTaskBarItem](xref:install-chocolateypinnedtaskbaritem)
+* [Install-ChocolateyShortcut](xref:install-chocolateyshortcut) - v0.9.9+
+* [Update-SessionEnvironment](xref:update-sessionenvironment)
+* [Get-PackageParameters](xref:get-packageparameters) - v0.10.8+
## Complete List (alphabetical order)
@@ -111,11 +129,17 @@ function Replace-CommonItems($text) {
if ($text -eq $null) {return $text}
$text = $text.Replace("`n",$lineFeed)
- $text = $text -replace '(community feed[s]?|community repository)', '[$1](https://chocolatey.org/packages)'
+ $text = $text -replace "\*\*NOTE:\*\*", "> :memo: **NOTE**"
+ $text = $text -replace '(community feed[s]?[^\]]|community repository)', '[$1](https://community.chocolatey.org/packages)'
$text = $text -replace '(Chocolatey for Business|Chocolatey Professional|Chocolatey Pro)(?=[^\w])', '[$1](https://chocolatey.org/compare)'
$text = $text -replace '(Pro[fessional]\s?/\s?Business)', '[$1](https://chocolatey.org/compare)'
$text = $text -replace '([Ll]icensed editions)', '[$1](https://chocolatey.org/compare)'
$text = $text -replace '([Ll]icensed versions)', '[$1](https://chocolatey.org/compare)'
+ $text = $text -replace '\(https://docs.chocolatey.org/en-us/create/automatic-packages\)', '(xref:automatic-packaging)'
+ $text = $text -replace 'Learn more about using this at https://docs.chocolatey.org/en-us/guides/create/parse-packageparameters-argument', '[Learn more](xref:parse-package-parameters)'
+ $text = $text -replace 'at https://docs.chocolatey.org/en-us/guides/create/parse-packageparameters-argument#step-3---use-core-community-extension', 'in [the docs](xref:parse-package-parameters#step-3-use-core-community-extension)'
+ $text = $text -replace 'https://docs.chocolatey.org/en-us/guides/create/parse-packageparameters-argument', 'https://docs.chocolatey.org/en-us/guides/create/parse-packageparameters-argument'
+ $text = $text -replace '\[community feed\)\]\(https://community.chocolatey.org/packages\)', '[community feed](https://community.chocolatey.org/packages))'
Write-Output $text
}
@@ -195,11 +219,12 @@ param(
$commandText = $commandText -creplace '^(Usage|Troubleshooting|Examples|Exit Codes|Connecting to Chocolatey.org|See It In Action|Alternative Sources|Resources|Packages.config|Scripting \/ Integration - Best Practices \/ Style Guide)', '## $1'
$commandText = $commandText -replace '^(Commands|How To Pass Options)', '## $1'
$commandText = $commandText -replace '^(WebPI|Windows Features|Ruby|Cygwin|Python)\s*$', '### $1'
- $commandText = $commandText -replace 'NOTE\:', '**NOTE:**'
- $commandText = $commandText -replace 'the command reference', '[[how to pass arguments|CommandsReference#how-to-pass-options--switches]]'
- $commandText = $commandText -replace '(community feed[s]?|community repository)', '[$1](https://chocolatey.org/packages)'
+ $commandText = $commandText -replace 'NOTE\:', '> :memo: **NOTE**'
+ $commandText = $commandText -replace '\*> :memo: \*\*NOTE\*\*\*', '> :memo: **NOTE**'
+ $commandText = $commandText -replace 'the command reference', '[how to pass arguments](xref:choco-commands#how-to-pass-options-switches)'
+ $commandText = $commandText -replace '(community feed[s]?|community repository)', '[$1](https://comminty.chocolatey.org/packages)'
#$commandText = $commandText -replace '\`(apikey|install|upgrade|uninstall|list|search|info|outdated|pin)\`', '[[`$1`|Commands$1]]'
- $commandText = $commandText -replace '\`([choco\s]*)(apikey|install|upgrade|uninstall|list|search|info|outdated|pin)\`', '[[`$1$2`|Commands$2]]'
+ $commandText = $commandText -replace '\`([choco\s]*)(apikey|install|upgrade|uninstall|list|search|info|outdated|pin)\`', '[`$1$2`](xref:choco-command-$2)'
$commandText = $commandText -replace '^(.+):\s(.+.gif)$', ''
$commandText = $commandText -replace '^(\s+)\<\?xml', "~~~xml$lineFeed`$1', "`$1$lineFeed~~~"
@@ -207,17 +232,31 @@ param(
$commandText = $commandText -replace '(Pro[fessional]\s?/\s?Business)', '[$1](https://chocolatey.org/compare)'
$commandText = $commandText -replace '([Ll]icensed editions)', '[$1](https://chocolatey.org/compare)'
$commandText = $commandText -replace '([Ll]icensed versions)', '[$1](https://chocolatey.org/compare)'
+ $commandText = $commandText -replace 'https://raw.githubusercontent.com/wiki/chocolatey/choco/images', '/assets/images'
+ $commandText = $commandText -replace 'https://chocolatey.org/docs/features-automatically-recompile-packages', 'https://docs.chocolatey.org/en-us/guides/create/recompile-packages'
+ $commandText = $commandText -replace 'https://chocolatey.org/docs/features-private-cdn', 'https://docs.chocolatey.org/en-us/features/private-cdn'
+ $commandText = $commandText -replace 'https://chocolatey.org/docs/features-virus-check', 'https://docs.chocolatey.org/en-us/features/virus-check'
+ $commandText = $commandText -replace 'https://chocolatey.org/docs/features-synchronize', 'https://docs.chocolatey.org/en-us/features/package-synchronization'
+ $commandText = $commandText -replace 'explicity', 'explicit'
+ $commandText = $commandText -replace 'https://chocolatey.org/docs/features-create-packages-from-installers', 'https://docs.chocolatey.org/en-us/features/package-builder'
+ $commandText = $commandText -replace 'See https://chocolatey.org/docs/features-create-packages-from-installers', 'See more information about [Package Builder features](xref:package-builder)'
+ $commandText = $commandText -replace 'See https://docs.chocolatey.org/en-us/features/package-builder', 'See more information about [Package Builder features](xref:package-builder)'
+ $commandText = $commandText -replace 'https://chocolatey.org/docs/features-install-directory-override', 'https://docs.chocolatey.org/en-us/features/install-directory-override'
+ $commandText = $commandText -replace 'y.org/docs/features-package-reducer', 'y.org/docs/en-us/features/package-reducer'
+ $commandText = $commandText -replace 'https://chocolatey.org/docs/features-package-reducer', 'https://docs.chocolatey.org/en-us/features/package-reducer'
+ $commandText = $commandText -replace 'https://chocolatey.org/docs/en-us/features/package-reducer', 'https://docs.chocolatey.org/en-us/features/package-reducer'
+ $commandText = $commandText -replace '\[community feed\)\]\(https://community.chocolatey.org/packages\)', '[community feed](https://community.chocolatey.org/packages))'
$optionsSwitches = @'
## $1
-**NOTE:** Options and switches apply to all items passed, so if you are
+> :memo: **NOTE** Options and switches apply to all items passed, so if you are
running a command like install that allows installing multiple
packages, and you use `--version=1.0.0`, it is going to look for and
try to install version 1.0.0 of every package passed. So please split
out multiple package calls when wanting to pass specific options.
-Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).
+Includes [default options/switches](xref:choco-commands#default-options-and-switches) (included below for completeness).
~~~
'@
@@ -227,7 +266,7 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
$optionsSwitches = @'
## $1
-**NOTE:** Options and switches apply to all items passed, so if you are
+> :memo: **NOTE** Options and switches apply to all items passed, so if you are
running a command like install that allows installing multiple
packages, and you use `--version=1.0.0`, it is going to look for and
try to install version 1.0.0 of every package passed. So please split
@@ -247,19 +286,28 @@ function Convert-CommandReferenceSpecific($commandText) {
param($m)
$commandName = $m.Groups[1].Value
$commandNameUpper = $($commandName.Substring(0,1).ToUpper() + $commandName.Substring(1))
- " * [[$commandName|Commands$($commandNameUpper)]] -"
+ " * [$commandName](xref:choco-command-$($commandName)) -"
}
)
#$commandText = $commandText -replace '\s?\s?\*\s(\w+)\s\-', ' * [[$1|Commands$1]] -'
- $commandText = $commandText.Replace("## Default Options and Switches", "## See Help Menu In Action$lineFeed$lineFeed$lineFeed$lineFeed## Default Options and Switches")
+ $commandText = $commandText.Replace("## Default Options and Switches", "## See Help Menu In Action$lineFeed$lineFeed$lineFeed$lineFeed## Default Options and Switches")
Write-Output $commandText
}
function Generate-TopLevelCommandReference {
Write-Host "Generating Top Level Command Reference"
- $fileName = "$docsFolder\CommandsReference.md"
- $commandOutput = @("# Command Reference$lineFeed")
+ $fileName = "$docsFolder\choco\commands\index.md"
+ $commandOutput = @("---")
+ $commandOutput += @("Order: 40")
+ $commandOutput += @("xref: choco-commands")
+ $commandOutput += @("Title: Commands")
+ $commandOutput += @("Description: Full list of all available Chocolatey commands")
+ $commandOutput += @("RedirectFrom:")
+ $commandOutput += @(" - docs/commandsreference")
+ $commandOutput += @(" - docs/commands-reference")
+ $commandOutput += @("---$lineFeed")
+ $commandOutput += @("# Command Reference$lineFeed")
$commandOutput += @(" $lineFeed")
$commandOutput += $(& $chocoExe -? -r)
$commandOutput += @("$lineFeed~~~$lineFeed")
@@ -268,12 +316,46 @@ function Generate-TopLevelCommandReference {
$commandOutput | %{ Convert-CommandText($_) } | %{ Convert-CommandReferenceSpecific($_) } | Out-File $fileName -Encoding UTF8 -Force
}
-function Generate-CommandReference($commandName) {
- $fileName = Join-Path $docsFolder "Commands$($commandName).md"
+function Move-GeneratedFiles {
+ if(-not(Test-Path "$docsFolder\create\commands")){ mkdir "$docsFolder\create\commands" -EA Continue | Out-Null }
+
+ Move-Item -Path "$docsFolder\choco\commands\apikey.md" -Destination "$docsFolder\create\commands\api-key.md"
+ Move-Item -Path "$docsFolder\choco\commands\new.md" -Destination "$docsFolder\create\commands\new.md"
+ Move-Item -Path "$docsFolder\choco\commands\pack.md" -Destination "$docsFolder\create\commands\pack.md"
+ Move-Item -Path "$docsFolder\choco\commands\push.md" -Destination "$docsFolder\create\commands\push.md"
+}
+
+function Generate-CommandReference($commandName, $order) {
+ if(-not(Test-Path "$docsFolder\choco\commands")){ mkdir "$docsFolder\choco\commands" -EA Continue | Out-Null }
+ $fileName = Join-Path "$docsFolder\choco\commands" "$($commandName.ToLower()).md"
+ $commandNameLower = $commandName.ToLower()
+
Write-Host "Generating $fileName ..."
+ $commandOutput += @("---")
+ $commandOutput += @("Order: $order")
+ $commandOutput += @("xref: choco-command-$commandNameLower")
+
+ if($commandName -eq 'List') {
+ $commandOutput += @("Title: $commandName/Search")
+ $commandOutput += @("Description: $commandName/Search Command (choco $commandNameLower)")
+ } else {
+ $commandOutput += @("Title: $commandName")
+ $commandOutput += @("Description: $commandName Command (choco $commandNameLower)")
+ }
+
+ $commandOutput += @("RedirectFrom:")
+ $commandOutput += @(" - docs/commands$commandNameLower")
+ $commandOutput += @(" - docs/commands-$commandNameLower")
+
+ if($commandName -eq 'Features') {
+ $commandOutput += @("ShowInNavbar: false")
+ $commandOutput += @("ShowInSidebar: false")
+ }
+
+ $commandOutput += @("---$lineFeed")
$commandOutput += @(" $lineFeed")
$commandOutput += $(& $chocoExe $commandName.ToLower() -h -r)
- $commandOutput += @("$lineFeed~~~$lineFeed$lineFeed[[Command Reference|CommandsReference]]")
+ $commandOutput += @("$lineFeed~~~$lineFeed$lineFeed[Command Reference](xref:choco-commands)")
$commandOutput += @("$lineFeed$lineFeed*NOTE:* This documentation has been automatically generated from ``choco $($commandName.ToLower()) -h``. $lineFeed")
$commandOutput | %{ Convert-CommandText $_ $commandName.ToLower() } | Out-File $fileName -Encoding UTF8 -Force
}
@@ -290,16 +372,39 @@ try
if (Test-Path($docsFolder)) { Remove-Item $docsFolder -Force -Recurse -EA SilentlyContinue }
if(-not(Test-Path $docsFolder)){ mkdir $docsFolder -EA Continue | Out-Null }
+ if(-not(Test-Path "$docsFolder\create\functions")){ mkdir "$docsFolder\create\functions" -EA Continue | Out-Null }
Write-Host 'Creating per PowerShell function markdown files...'
+ $helperOrder = 10;
Get-Command -Module $psModuleName -CommandType Function | ForEach-Object -Process { Get-Help $_ -Full } | ForEach-Object -Process { `
$commandName = $_.Name
- $fileName = Join-Path $docsFolder "Helpers$($_.Name.Replace('-','')).md"
- $global:powerShellReferenceTOC += "$lineFeed * [[$commandName|$([System.IO.Path]::GetFileNameWithoutExtension($fileName))]]"
+ $fileName = Join-Path "$docsFolder\create\functions" "$($_.Name.ToLower()).md"
+ $global:powerShellReferenceTOC += "$lineFeed * [$commandName](xref:$([System.IO.Path]::GetFileNameWithoutExtension($fileName)))"
$hasCmdletBinding = (Get-Command -Name $commandName).CmdLetBinding
Write-Host "Generating $fileName ..."
+ $SplitName = $_.Name -split "-"
+ $NameNoHyphen = $_.Name -replace '-', ''
+
+ if($_.Name -eq 'Get-OSArchitectureWidth') {
+ $FormattedName = "get-os-architecture-width"
+ } elseif($_.Name -eq 'Get-UACEnabled') {
+ $FormattedName = "get-uac-enabled"
+ }else {
+ $FormattedName = $SplitName[0].ToLower() + ($SplitName[1] -creplace '[A-Z]', '-$&').ToLower()
+ }
+
@"
+---
+Order: $($helperOrder)
+xref: $($_.Name.ToLower())
+Title: $($_.Name)
+Description: Information on $($_.Name) function
+RedirectFrom:
+ - docs/helpers-$($FormattedName)
+ - docs/helpers$($NameNoHyphen.ToLower())
+---
+
# $($_.Name)
@@ -326,69 +431,139 @@ $( if ($_.ReturnValues -ne $null -and $_.ReturnValues.Length -gt 0 -and -not $_.
## Parameters
$( if ($_.parameters.parameter.count -gt 0) { $_.parameters.parameter | % { Convert-Parameter $_ $commandName }}) $( if ($hasCmdletBinding) { "$lineFeed### <CommonParameters>$lineFeed$($lineFeed)This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see ``about_CommonParameters`` http://go.microsoft.com/fwlink/p/?LinkID=113216 ." } )
-$( if ($_.relatedLinks -ne $null) {Write-Output "$lineFeed## Links$lineFeed$lineFeed"; $_.relatedLinks.navigationLink | ? { $_.linkText -ne $null} | % { Write-Output "* [[$($_.LinkText)|Helpers$($_.LinkText.Replace('-',''))]]$lineFeed" }})
+$( if ($_.relatedLinks -ne $null) {Write-Output "$lineFeed## Links$lineFeed$lineFeed"; $_.relatedLinks.navigationLink | ? { $_.linkText -ne $null} | % { Write-Output "* [$($_.LinkText)](xref:$($_.LinkText.ToLower()))$lineFeed" }})
-[[Function Reference|HelpersReference]]
+[Function Reference](xref:powershell-reference)
-***NOTE:*** This documentation has been automatically generated from ``Import-Module `"`$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1`" -Force; Get-Help $($_.Name) -Full``.
+> :memo: **NOTE** This documentation has been automatically generated from ``Import-Module `"`$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1`" -Force; Get-Help $($_.Name) -Full``.
View the source for [$($_.Name)]($sourceFunctions/$($_.Name)`.ps1)
"@ | Out-File $fileName -Encoding UTF8 -Force
+ $helperOrder = $helperOrder + 10
}
Write-Host "Generating Top Level PowerShell Reference"
- $fileName = Join-Path $docsFolder 'HelpersReference.md'
+ $fileName = Join-Path "$docsFolder\create\functions" 'index.md'
$global:powerShellReferenceTOC += @'
-## Variables
-
-There are also a number of environment variables providing access to some values from the nuspec and other information that may be useful. They are accessed via `$env:variableName`.
+## Chocolatey for Business Functions
-* __chocolateyPackageFolder__ = the folder where Chocolatey has downloaded and extracted the NuGet package, typically `C:\ProgramData\chocolatey\lib\packageName`.
-* __chocolateyPackageName__ (since 0.9.9.0) = The package name, which is equivalent to the `` tag in the nuspec
-* __chocolateyPackageVersion__ (since 0.9.9.0) = The package version, which is equivalent to the `` tag in the nuspec
+ * [Install-ChocolateyWindowsService](xref:install-chocolateywindowsservice)
+ * [Start-ChocolateyWindowsService](xref:start-chocolateywindowsservice)
+ * [Stop-ChocolateyWindowsService](xref:stop-chocolateywindowsservice)
+ * [Uninstall-ChocolateyWindowsService](xref:uninstall-chocolateywindowsservice)
-`chocolateyPackageVersion` may be particularly useful, since that would allow you in some cases to create packages for new releases of the updated software by only changing the `` in the nuspec and not having to touch the `chocolateyInstall.ps1` at all. An example of this:
+## Variables
-~~~powershell
-$url = "http://www.thesoftware.com/downloads/thesoftware-$env:chocolateyPackageVersion.zip"
+There are also a number of environment variables providing access to some values from the nuspec and other information that may be useful. They are accessed via `$env:variableName`.
-Install-ChocolateyZipPackage '$env:chocolateyPackageName' $url $binRoot
-~~~
+### Environment Variables
+
+Chocolatey makes a number of environment variables available (You can access any of these with $env:TheVariableNameBelow):
+
+ * TEMP/TMP - Overridden to the CacheLocation, but may be the same as the original TEMP folder
+ * ChocolateyInstall - Top level folder where Chocolatey is installed
+ * ChocolateyPackageName - The name of the package, equivalent to the `` field in the nuspec (0.9.9+)
+ * ChocolateyPackageTitle - The title of the package, equivalent to the `` field in the nuspec (0.10.1+)
+ * ChocolateyPackageVersion - The version of the package, equivalent to the `` field in the nuspec (0.9.9+)
+ * ChocolateyPackageFolder - The top level location of the package folder - the folder where Chocolatey has downloaded and extracted the NuGet package, typically `C:\ProgramData\chocolatey\lib\packageName`.
+
+#### Advanced Environment Variables
+
+The following are more advanced settings:
+
+ * ChocolateyPackageParameters - Parameters to use with packaging, not the same as install arguments (which are passed directly to the native installer). Based on `--package-parameters`. (0.9.8.22+)
+ * CHOCOLATEY_VERSION - The version of Choco you normally see. Use if you are 'lighting' things up based on choco version. (0.9.9+) - Otherwise take a dependency on the specific version you need.
+ * ChocolateyForceX86 = If available and set to 'true', then user has requested 32bit version. (0.9.9+) - Automatically handled in built in Choco functions.
+ * OS_PLATFORM - Like Windows, OSX, Linux. (0.9.9+)
+ * OS_VERSION - The version of OS, like 6.1 something something for Windows. (0.9.9+)
+ * OS_NAME - The reported name of the OS. (0.9.9+)
+ * IS_PROCESSELEVATED = Is the process elevated? (0.9.9+)
+ * ChocolateyToolsLocation - formerly 'ChocolateyBinRoot' ('ChocolateyBinRoot' will be removed with Chocolatey v2.0.0), this is where tools being installed outside of Chocolatey packaging will go. (0.9.10+)
+
+#### Set By Options and Configuration
+
+Some environment variables are set based on options that are passed, configuration and/or features that are turned on:
+
+ * ChocolateyEnvironmentDebug - Was `--debug` passed? If using the built-in PowerShell host, this is always true (but only logs debug messages to console if `--debug` was passed) (0.9.10+)
+ * ChocolateyEnvironmentVerbose - Was `--verbose` passed? If using the built-in PowerShell host, this is always true (but only logs verbose messages to console if `--verbose` was passed). (0.9.10+)
+ * ChocolateyForce - Was `--force` passed? (0.9.10+)
+ * ChocolateyForceX86 - Was `-x86` passed? (CHECK)
+ * ChocolateyRequestTimeout - How long before a web request will time out. Set by config `webRequestTimeoutSeconds` (CHECK)
+ * ChocolateyResponseTimeout - How long to wait for a download to complete? Set by config `commandExecutionTimeoutSeconds` (CHECK)
+ * ChocolateyPowerShellHost - Are we using the built-in PowerShell host? Set by `--use-system-powershell` or the feature `powershellHost` (0.9.10+)
+
+#### Business Edition Variables
+
+ * ChocolateyInstallArgumentsSensitive - Encrypted arguments passed from command line `--install-arguments-sensitive` that are not logged anywhere. (0.10.1+ and licensed editions 1.6.0+)
+ * ChocolateyPackageParametersSensitive - Package parameters passed from command line `--package-parameters-senstivite` that are not logged anywhere. (0.10.1+ and licensed editions 1.6.0+)
+ * ChocolateyLicensedVersion - What version is the licensed edition on?
+ * ChocolateyLicenseType - What edition / type of the licensed edition is installed?
+
+#### Experimental Environment Variables
+
+The following are experimental or use not recommended:
+
+ * OS_IS64BIT = This may not return correctly - it may depend on the process the app is running under (0.9.9+)
+ * CHOCOLATEY_VERSION_PRODUCT = the version of Choco that may match CHOCOLATEY_VERSION but may be different (0.9.9+) - based on git describe
+ * IS_ADMIN = Is the user an administrator? But doesn't tell you if the process is elevated. (0.9.9+)
+
+#### Not Useful Or Anti-Pattern If Used
+
+ * ChocolateyInstallOverride = Not for use in package automation scripts. Based on `--override-arguments` being passed. (0.9.9+)
+ * ChocolateyInstallArguments = The installer arguments meant for the native installer. You should use chocolateyPackageParameters instead. Based on `--install-arguments` being passed. (0.9.9+)
+ * ChocolateyIgnoreChecksums - Was `--ignore-checksums` passed or the feature `checksumFiles` turned off? (0.9.9.9+)
+ * ChocolateyAllowEmptyChecksums - Was `--allow-empty-checksums` passed or the feature `allowEmptyChecksums` turned on? (0.10.0+)
+ * ChocolateyAllowEmptyChecksumsSecure - Was `--allow-empty-checksums-secure` passed or the feature `allowEmptyChecksumsSecure` turned on? (0.10.0+)
+ * ChocolateyCheckLastExitCode - Should Chocolatey check LASTEXITCODE? Is the feature `scriptsCheckLastExitCode` turned on? (0.10.3+)
+ * ChocolateyChecksum32 - Was `--download-checksum` passed? (0.10.0+)
+ * ChocolateyChecksumType32 - Was `--download-checksum-type` passed? (0.10.0+)
+ * ChocolateyChecksum64 - Was `--download-checksum-x64` passed? (0.10.0)+
+ * ChocolateyChecksumType64 - Was `--download-checksum-type-x64` passed? (0.10.0)+
+ * ChocolateyPackageExitCode - The exit code of the script that just ran - usually set by `Set-PowerShellExitCode` (CHECK)
+ * ChocolateyLastPathUpdate - Set by Chocolatey as part of install, but not used for anything in particular in packaging.
+ * ChocolateyProxyLocation - The explicit proxy location as set in the configuration `proxy` (0.9.9.9+)
+ * ChocolateyDownloadCache - Use available download cache? Set by `--skip-download-cache`, `--use-download-cache`, or feature `downloadCache` (0.9.10+ and licensed editions 1.1.0+)
+ * ChocolateyProxyBypassList - Explicitly set locations to ignore in configuration `proxyBypassList` (0.10.4+)
+ * ChocolateyProxyBypassOnLocal - Should the proxy bypass on local connections? Set based on configuration `proxyBypassOnLocal` (0.10.4+)
+ * http_proxy - Set by original `http_proxy` passthrough, or same as `ChocolateyProxyLocation` if explicitly set. (0.10.4+)
+ * https_proxy - Set by original `https_proxy` passthrough, or same as `ChocolateyProxyLocation` if explicitly set. (0.10.4+)
+ * no_proxy- Set by original `no_proxy` passthrough, or same as `ChocolateyProxyBypassList` if explicitly set. (0.10.4+)
'@
$global:powerShellReferenceTOC | Out-File $fileName -Encoding UTF8 -Force
Write-Host "Generating command reference markdown files"
- Generate-CommandReference('List')
- Generate-CommandReference('Search')
- Generate-CommandReference('Info')
- Generate-CommandReference('Install')
- Generate-CommandReference('Pin')
- Generate-CommandReference('Outdated')
- Generate-CommandReference('Upgrade')
- Generate-CommandReference('Uninstall')
- Generate-CommandReference('Config')
- Generate-CommandReference('Source')
- Generate-CommandReference('Sources')
- Generate-CommandReference('Feature')
- Generate-CommandReference('Features')
- Generate-CommandReference('New')
- Generate-CommandReference('Pack')
- Generate-CommandReference('Apikey')
- Generate-CommandReference('SetApikey')
- Generate-CommandReference('Push')
- Generate-CommandReference('UnpackSelf')
- Generate-CommandReference('Update')
- Generate-CommandReference('Version')
- Generate-CommandReference('Download')
- Generate-CommandReference('Support')
- Generate-CommandReference('Sync')
- Generate-CommandReference('Synchronize')
- Generate-CommandReference('Optimize')
+ Generate-CommandReference 'List' '60'
+ Generate-CommandReference 'Search' '100'
+ Generate-CommandReference 'Info' '40'
+ Generate-CommandReference 'Install' '50'
+ Generate-CommandReference 'Pin' '90'
+ Generate-CommandReference 'Outdated' '80'
+ Generate-CommandReference 'Upgrade' '200'
+ Generate-CommandReference 'Uninstall' '170'
+ Generate-CommandReference 'Config' '10'
+ Generate-CommandReference 'Source' '120'
+ Generate-CommandReference 'Sources' '130'
+ Generate-CommandReference 'Feature' '30'
+ Generate-CommandReference 'Features' '35'
+ Generate-CommandReference 'New' '10'
+ Generate-CommandReference 'Pack' '20'
+ Generate-CommandReference 'ApiKey' '30'
+ Generate-CommandReference 'SetApiKey' '110'
+ Generate-CommandReference 'Push' '40'
+ Generate-CommandReference 'UnpackSelf' '180'
+ Generate-CommandReference 'Update' '190'
+ Generate-CommandReference 'Version' '210'
+ Generate-CommandReference 'Download' '20'
+ Generate-CommandReference 'Support' '140'
+ Generate-CommandReference 'Sync' '150'
+ Generate-CommandReference 'Synchronize' '160'
+ Generate-CommandReference 'Optimize' '70'
Generate-TopLevelCommandReference
+ Move-GeneratedFiles
Exit 0
}
diff --git a/README.md b/README.md
index dcc7af1eaf..82836038ce 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,9 @@
# Chocolatey - like yum or apt-get, but for Windows
You can just call me choco.
-
+
-[](https://chocolatey.org/packages/chocolatey) [](https://chocolatey.org/packages/chocolatey) [](https://www.openhub.net/p/chocolatey)
+[](https://community.chocolatey.org/packages/chocolatey) [](https://community.chocolatey.org/packages/chocolatey) [](https://www.openhub.net/p/chocolatey)
@@ -60,14 +60,14 @@ If you are an open source user requesting support, please remember that most fol
If you are using a [commercial edition of Chocolatey](https://chocolatey.org/compare#compare), you have different terms! Please see [support](https://chocolatey.org/support).
## Information
- * [Chocolatey Website and Community Package Repository](https://chocolatey.org)
+ * [Chocolatey Website and Community Package Repository](https://community.chocolatey.org)
* [Mailing List](http://groups.google.com/group/chocolatey) / [Release Announcements Only Mailing List](https://groups.google.com/group/chocolatey-announce) / [Build Status Mailing List](http://groups.google.com/group/chocolatey-build-status)
* [Twitter](https://twitter.com/chocolateynuget) / [Facebook](https://www.facebook.com/ChocolateySoftware) / [Github](https://github.com/chocolatey)
- * [Blog](https://chocolatey.org/blog) / [Newsletter](https://chocolatey.us8.list-manage1.com/subscribe?u=86a6d80146a0da7f2223712e4&id=73b018498d)
- * [Documentation](https://chocolatey.org/docs) / [Support](https://chocolatey.org/support)
+ * [Blog](https://blog.chocolatey.org/) / [Newsletter](https://chocolatey.us8.list-manage1.com/subscribe?u=86a6d80146a0da7f2223712e4&id=73b018498d)
+ * [Documentation](https://docs.chocolatey.org/en-us/) / [Support](https://chocolatey.org/support)
### Documentation
-Please see the [docs](https://chocolatey.org/docs)
+Please see the [docs](https://docs.chocolatey.org/en-us/)
Give `choco.exe -?` a shot (or `choco.exe -h`). For specific commands, add the command and then the help switch e.g. `choco.exe install -h`.
@@ -82,13 +82,13 @@ Apache 2.0 - see [LICENSE](https://github.com/chocolatey/choco/blob/master/LICEN
## Submitting Issues
- * If you are having issue with a package, please see [Request Package Fixes or Updates / Become a maintainer of an existing package](https://chocolatey.org/docs/package-triage-process).
- * If you are looking for packages to be added to the community feed (aka https://chocolatey.org/packages), please see [Package Requests](https://chocolatey.org/docs/package-triage-process#package-request-package-missing).
+ * If you are having issue with a package, please see [Request Package Fixes or Updates / Become a maintainer of an existing package](https://docs.chocolatey.org/en-us/community-repository/users/package-triage-process).
+ * If you are looking for packages to be added to the community feed (aka https://community.chocolatey.org/packages), please see [Package Requests](https://docs.chocolatey.org/en-us/community-repository/users/package-triage-process#package-request-package-missing).
1. Start with [Troubleshooting](https://github.com/chocolatey/choco/wiki/Troubleshooting) and the [FAQ](https://github.com/chocolatey/choco/wiki/ChocolateyFAQs) to see if your question or issue already has an answer.
1. If not found or resolved, please follow one of the following avenues:
* If you are a licensed customer, please see [support](https://chocolatey.org/support). You can also log an issue to [Licensed Issues](https://github.com/chocolatey/chocolatey-licensed-issues) and we will submit issues to all other places on your behalf. Another avenue is to use email support to have us submit tickets and other avenues on your behalf (allowing you to maintain privacy).
- * If it is an enhancement request or issue with the website (the community package repository aka [https://chocolatey.org](https://chocolatey.org)), please submit the issue to the [Chocolatey.org repo](https://github.com/chocolatey/chocolatey.org).
+ * If it is an enhancement request or issue with the website (the community package repository aka [https://community.chocolatey.org](https://community.chocolatey.org)), please submit the issue to the [Chocolatey.org repo](https://github.com/chocolatey/home).
* If you have found an issue with the GUI (Chocolatey GUI) or you want to submit an enhancement, please see [the ChocolateyGUI repository](https://github.com/chocolatey/ChocolateyGUI#submitting-issues).
* If you have found an issue with the client (choco.exe), you are in the right place. Keep reading below.
@@ -138,7 +138,7 @@ Running the build on Windows should produce an artifact that is tested and ready
#### Other Platforms
##### Prerequisites:
- * Install and configure Mono 5.20.x (Other versions may work but have not been tested).
+ * Install and configure Mono. Mono 5.20 or newer should work, see the Dockerfile for the currently recommended version.
* [Debian based](http://www.mono-project.com/docs/getting-started/install/linux/#debian-ubuntu-and-derivatives)
```sh
@@ -152,6 +152,8 @@ sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 3FA7E0328
echo "deb https://download.mono-project.com/repo/debian stable-buster main" | sudo tee /etc/apt/sources.list.d/mono-official-stable.list
# Debian 9
echo "deb https://download.mono-project.com/repo/debian stable-stretch main" | sudo tee /etc/apt/sources.list.d/mono-official-stable.list
+#Ubuntu 20.04
+echo "deb https://download.mono-project.com/repo/ubuntu stable-focal main" | sudo tee /etc/apt/sources.list.d/mono-official-stable.list
# Ubuntu 18.04
echo "deb https://download.mono-project.com/repo/ubuntu stable-bionic main" | sudo tee /etc/apt/sources.list.d/mono-official-stable.list
# Ubuntu 16.04
@@ -163,57 +165,7 @@ sudo apt-get update
sudo apt-get install mono-devel -y
```
- * [CentOS/RHEL](https://www.mono-project.com/download/stable/#download-lin-centos)
-
-```sh
-### NOT FULLY TESTED AND WORKING ###
-# Switch to root shell
-su
-# Add the EPEL
-yum install epel-release -y
-# Add the key
-pmkeys --import "http://pool.sks-keyservers.net/pks/lookup?op=get&search=0x3fa7e0328081bff6a14da29aa6a19b38d3d831ef"
-
-# Add the package repository
-# CentOS/RHEL 8
-su -c 'curl https://download.mono-project.com/repo/centos8-stable.repo | tee /etc/yum.repos.d/mono-centos8-stable.repo'
-# CentOS/RHEL 7
-su -c 'curl https://download.mono-project.com/repo/centos7-stable.repo | tee /etc/yum.repos.d/mono-centos7-stable.repo'
-# CentOS/RHEL 6
-rpm --import "http://pool.sks-keyservers.net/pks/lookup?op=get&search=0x3fa7e0328081bff6a14da29aa6a19b38d3d831ef"
-
-# Update your system
-yum update -y
-
-# Install mono-devel
-yum install mono-devel -y
-
-```
-
- * [Fedora](https://www.mono-project.com/download/stable/#download-lin-fedora)
-
-```sh
-### NOT FULLY TESTED AND WORKING ###
-
-# Switch to root shell
-su
-# Add the key
-rpm --import "https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF"
-
-# Add the package repository
-# Fedora 29
-su -c 'curl https://download.mono-project.com/repo/centos8-stable.repo | tee /etc/yum.repos.d/mono-centos8-stable.repo'
-# Fedora 28
-su -c 'curl https://download.mono-project.com/repo/centos7-stable.repo | tee /etc/yum.repos.d/mono-centos7-stable.repo'
-
-# Update
-dnf update
-
-# Install mono-devel
-dnf install mono-devel -y
-
-```
-
+ * Other Linux systems; see [Mono install instructions for Linux](https://www.mono-project.com/download/stable/#download-lin)
* Xamarin Studio is helpful for working on source.
* Consider adding the following to your `~/.profile` (or other relevant dot source file):
diff --git a/appveyor.yml b/appveyor.yml
index de40f612a1..8f252f56d3 100644
--- a/appveyor.yml
+++ b/appveyor.yml
@@ -20,9 +20,9 @@ test:
artifacts:
- path: build_output\build_artifacts\compile\msbuild-net-4.0-results.xml
name: Compile.xml
-- path: build_output\build_artifacts\nunit\index.html
+- path: build_output\build_artifacts\tests\index.html
name: NUnitResults.html
-- path: build_output\build_artifacts\opencover\Html\index.htm
+- path: build_output\build_artifacts\codecoverage\Html\index.htm
name: OpenCoverResults.htm
- path: build_output\_BuildInfo.xml
name: BuildInfo.xml
diff --git a/docker/Dockerfile.linux b/docker/Dockerfile.linux
index 54bbc9ec19..f5d825a099 100644
--- a/docker/Dockerfile.linux
+++ b/docker/Dockerfile.linux
@@ -1,4 +1,4 @@
-FROM mono:5.20.1.19
+FROM mono:6.12
MAINTAINER Justin Phelps
diff --git a/docs/generated/CommandsApiKey.md b/docs/generated/CommandsApiKey.md
deleted file mode 100644
index a19189e45f..0000000000
--- a/docs/generated/CommandsApiKey.md
+++ /dev/null
@@ -1,190 +0,0 @@
-
-
-# ApiKey Command (choco apikey)
-
-This lists api keys that are set or sets an api key for a particular
- source so it doesn't need to be specified every time.
-
-Anything that doesn't contain source and key will list api keys.
-
-## Usage
-
- choco apikey []
- choco setapikey []
-
-## Examples
-
- choco apikey
- choco apikey -s https://somewhere/out/there
- choco apikey -s="https://somewhere/out/there/" -k="value"
- choco apikey -s "https://push.chocolatey.org/" -k="123-123123-123"
- choco apikey -s "http://internal_nexus" -k="user:password"
-
-For source location, this can be a folder/file share or an
-http location. When it comes to urls, they can be different from the packages
-url (where packages are searched and installed from). As an example, for
-Chocolatey's community package package repository, the package url is
-https://chocolatey.org/api/v2, but the push url is https://push.chocolatey.org
-(and the deprecated https://chocolatey.org/ as a push url). Check the
-documentation for your choice of repository to learn what the push url is.
-
-For the key, this can be an apikey that is provided by your source repository.
-With some sources, like Nexus, this can be a NuGet API key or it could be a
-user name and password specified as 'user:password' for the API key. Please see
-your repository's documentation (for Nexus, please see
-https://bit.ly/nexus2apikey).
-
-**NOTE:** See scripting in [[how to pass arguments|CommandsReference#how-to-pass-options--switches]] (`choco -?`) for how to
- write proper scripts and integrations.
-
-
-## Connecting to Chocolatey.org (Community Package Repository)
-
-In order to save your API key for https://push.chocolatey.org/,
- log in (or register, confirm and then log in) to
- https://push.chocolatey.org/, go to https://push.chocolatey.org/account,
- copy the API Key, and then use it in the following command:
-
- choco apikey -k -s https://push.chocolatey.org/
-
-
-## Exit Codes
-
-Exit codes that normally result from running this command.
-
-Normal:
- - 0: operation was successful, no issues detected
- - -1 or 1: an error has occurred
-
-If you find other exit codes that we have not yet documented, please
- file a ticket so we can document it at
- https://github.com/chocolatey/choco/issues/new/choose.
-
-
-## Options and Switches
-
-**NOTE:** Options and switches apply to all items passed, so if you are
- running a command like install that allows installing multiple
- packages, and you use `--version=1.0.0`, it is going to look for and
- try to install version 1.0.0 of every package passed. So please split
- out multiple package calls when wanting to pass specific options.
-
-Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).
-
-~~~
-
- -?, --help, -h
- Prints out the help menu.
-
- -d, --debug
- Debug - Show debug messaging.
-
- -v, --verbose
- Verbose - Show verbose messaging. Very verbose messaging, avoid using
- under normal circumstances.
-
- --trace
- Trace - Show trace messaging. Very, very verbose trace messaging. Avoid
- except when needing super low-level .NET Framework debugging. Available
- in 0.10.4+.
-
- --nocolor, --no-color
- No Color - Do not show colorization in logging output. This overrides
- the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
-
- --acceptlicense, --accept-license
- AcceptLicense - Accept license dialogs automatically. Reserved for
- future use.
-
- -y, --yes, --confirm
- Confirm all prompts - Chooses affirmative answer instead of prompting.
- Implies --accept-license
-
- -f, --force
- Force - force the behavior. Do not use force during normal operation -
- it subverts some of the smart behavior for commands.
-
- --noop, --whatif, --what-if
- NoOp / WhatIf - Don't actually do anything.
-
- -r, --limitoutput, --limit-output
- LimitOutput - Limit the output to essential information
-
- --timeout, --execution-timeout=VALUE
- CommandExecutionTimeout (in seconds) - The time to allow a command to
- finish before timing out. Overrides the default execution timeout in the
- configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
-
- -c, --cache, --cachelocation, --cache-location=VALUE
- CacheLocation - Location for download cache, defaults to %TEMP% or value
- in chocolatey.config file.
-
- --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
- AllowUnofficialBuild - When not using the official build you must set
- this flag for choco to continue.
-
- --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
- FailOnStandardError - Fail on standard error output (stderr), typically
- received when running external commands during install providers. This
- overrides the feature failOnStandardError.
-
- --use-system-powershell
- UseSystemPowerShell - Execute PowerShell using an external process
- instead of the built-in PowerShell host. Should only be used when
- internal host is failing. Available in 0.9.10+.
-
- --no-progress
- Do Not Show Progress - Do not show download progress percentages.
- Available in 0.10.4+.
-
- --proxy=VALUE
- Proxy Location - Explicit proxy location. Overrides the default proxy
- location of ''. Available for config settings in 0.9.9.9+, this CLI
- option available in 0.10.4+.
-
- --proxy-user=VALUE
- Proxy User Name - Explicit proxy user (optional). Requires explicity
- proxy (`--proxy` or config setting). Overrides the default proxy user of
- '123'. Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-password=VALUE
- Proxy Password - Explicit proxy password (optional) to be used with
- username. Requires explicity proxy (`--proxy` or config setting) and
- user name. Overrides the default proxy password (encrypted in settings
- if set). Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-bypass-list=VALUE
- ProxyBypassList - Comma separated list of regex locations to bypass on
- proxy. Requires explicity proxy (`--proxy` or config setting). Overrides
- the default proxy bypass list of ''. Available in 0.10.4+.
-
- --proxy-bypass-on-local
- Proxy Bypass On Local - Bypass proxy for local connections. Requires
- explicity proxy (`--proxy` or config setting). Overrides the default
- proxy bypass on local setting of 'True'. Available in 0.10.4+.
-
- --log-file=VALUE
- Log File to output to in addition to regular loggers. Available in 0.1-
- 0.8+.
-
- -s, --source=VALUE
- Source [REQUIRED] - The source location for the key
-
- -k, --key, --apikey, --api-key=VALUE
- ApiKey - The API key for the source. This is the authentication that
- identifies you and allows you to push to a source. With some sources
- this is either a key or it could be a user name and password specified
- as 'user:password'.
-
- --rem, --remove
- Removes an API key from Chocolatey
-
-~~~
-
-[[Command Reference|CommandsReference]]
-
-
-***NOTE:*** This documentation has been automatically generated from `choco apikey -h`.
-
diff --git a/docs/generated/CommandsConfig.md b/docs/generated/CommandsConfig.md
deleted file mode 100644
index 1ada716700..0000000000
--- a/docs/generated/CommandsConfig.md
+++ /dev/null
@@ -1,170 +0,0 @@
-
-
-# Config Command (choco config)
-
-Chocolatey will allow you to interact with the configuration file settings.
-
-**NOTE:** Available in 0.9.9.9+.
-
-## Usage
-
- choco config [list]|get|set|unset []
-
-**NOTE:** `Unset` subcommand available in 0.9.10+.
-
-## Examples
-
- choco config
- choco config list
- choco config get cacheLocation
- choco config get --name cacheLocation
- choco config set cacheLocation c:\temp\choco
- choco config set --name cacheLocation --value c:\temp\choco
- choco config unset proxy
- choco config unset --name proxy
-
-**NOTE:** See scripting in [[how to pass arguments|CommandsReference#how-to-pass-options--switches]] (`choco -?`) for how to
- write proper scripts and integrations.
-
-
-## Exit Codes
-
-Exit codes that normally result from running this command.
-
-Normal:
- - 0: operation was successful, no issues detected
- - -1 or 1: an error has occurred
-
-If you find other exit codes that we have not yet documented, please
- file a ticket so we can document it at
- https://github.com/chocolatey/choco/issues/new/choose.
-
-
-## See It In Action
-
-
-
-
-## Options and Switches
-
-**NOTE:** Options and switches apply to all items passed, so if you are
- running a command like install that allows installing multiple
- packages, and you use `--version=1.0.0`, it is going to look for and
- try to install version 1.0.0 of every package passed. So please split
- out multiple package calls when wanting to pass specific options.
-
-Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).
-
-~~~
-
- -?, --help, -h
- Prints out the help menu.
-
- -d, --debug
- Debug - Show debug messaging.
-
- -v, --verbose
- Verbose - Show verbose messaging. Very verbose messaging, avoid using
- under normal circumstances.
-
- --trace
- Trace - Show trace messaging. Very, very verbose trace messaging. Avoid
- except when needing super low-level .NET Framework debugging. Available
- in 0.10.4+.
-
- --nocolor, --no-color
- No Color - Do not show colorization in logging output. This overrides
- the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
-
- --acceptlicense, --accept-license
- AcceptLicense - Accept license dialogs automatically. Reserved for
- future use.
-
- -y, --yes, --confirm
- Confirm all prompts - Chooses affirmative answer instead of prompting.
- Implies --accept-license
-
- -f, --force
- Force - force the behavior. Do not use force during normal operation -
- it subverts some of the smart behavior for commands.
-
- --noop, --whatif, --what-if
- NoOp / WhatIf - Don't actually do anything.
-
- -r, --limitoutput, --limit-output
- LimitOutput - Limit the output to essential information
-
- --timeout, --execution-timeout=VALUE
- CommandExecutionTimeout (in seconds) - The time to allow a command to
- finish before timing out. Overrides the default execution timeout in the
- configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
-
- -c, --cache, --cachelocation, --cache-location=VALUE
- CacheLocation - Location for download cache, defaults to %TEMP% or value
- in chocolatey.config file.
-
- --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
- AllowUnofficialBuild - When not using the official build you must set
- this flag for choco to continue.
-
- --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
- FailOnStandardError - Fail on standard error output (stderr), typically
- received when running external commands during install providers. This
- overrides the feature failOnStandardError.
-
- --use-system-powershell
- UseSystemPowerShell - Execute PowerShell using an external process
- instead of the built-in PowerShell host. Should only be used when
- internal host is failing. Available in 0.9.10+.
-
- --no-progress
- Do Not Show Progress - Do not show download progress percentages.
- Available in 0.10.4+.
-
- --proxy=VALUE
- Proxy Location - Explicit proxy location. Overrides the default proxy
- location of ''. Available for config settings in 0.9.9.9+, this CLI
- option available in 0.10.4+.
-
- --proxy-user=VALUE
- Proxy User Name - Explicit proxy user (optional). Requires explicity
- proxy (`--proxy` or config setting). Overrides the default proxy user of
- '123'. Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-password=VALUE
- Proxy Password - Explicit proxy password (optional) to be used with
- username. Requires explicity proxy (`--proxy` or config setting) and
- user name. Overrides the default proxy password (encrypted in settings
- if set). Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-bypass-list=VALUE
- ProxyBypassList - Comma separated list of regex locations to bypass on
- proxy. Requires explicity proxy (`--proxy` or config setting). Overrides
- the default proxy bypass list of ''. Available in 0.10.4+.
-
- --proxy-bypass-on-local
- Proxy Bypass On Local - Bypass proxy for local connections. Requires
- explicity proxy (`--proxy` or config setting). Overrides the default
- proxy bypass on local setting of 'True'. Available in 0.10.4+.
-
- --log-file=VALUE
- Log File to output to in addition to regular loggers. Available in 0.1-
- 0.8+.
-
- --name=VALUE
- Name - the name of the config setting. Required with some actions.
- Defaults to empty.
-
- --value=VALUE
- Value - the value of the config setting. Required with some actions.
- Defaults to empty.
-
-~~~
-
-[[Command Reference|CommandsReference]]
-
-
-***NOTE:*** This documentation has been automatically generated from `choco config -h`.
-
diff --git a/docs/generated/CommandsDownload.md b/docs/generated/CommandsDownload.md
deleted file mode 100644
index 19bbf943eb..0000000000
--- a/docs/generated/CommandsDownload.md
+++ /dev/null
@@ -1,250 +0,0 @@
-
-
-# Download Command (choco download)
-
-### Package Copy / Package Downloader
-
-[Chocolatey Professional](https://chocolatey.org/compare) and up (Pro+) starting in version 1.7.1.
-
-Downloads a package from a source and unpacks it.
-
-### Package Internalizer
-
-[Chocolatey for Business](https://chocolatey.org/compare) (C4B) starting at licensed version 1.5.0.
-Chocolatey for Managed Service Providers (MSP) starting in 1.12.1.
-
-Downloads a package from a source, optionally downloading remote
- resources and recompiling the package to use internal resources. This
- takes an existing package and makes it available without any internet
- requirement.
-
-See https://chocolatey.org/docs/features-automatically-recompile-packages
-
-
-## Usage
-
- choco download [] [install_script_variable=value]
-
- Install script variables are values that are discovered in the
- chocolateyInstall.ps1 (or a script it calls). When you find values
- there maybe don't get found and replaced or they use a default
- value and you want to provide a value for them to use instead, you
- can find them and then provide the value you want to pass instead.
- For example, in the Firefox package, it uses a default value of
- 'en-US' for `$locale`. If you want to change that, you can add
- `locale` and a value, which will replace `$locale` in the script,
- e.g. `choco download firefox --internalize locale=en-GB`.
-
-## Examples
-
- choco download sysinternals
-
- #### [Chocolatey for Business](https://chocolatey.org/compare) / Chocolatey for MSP
- choco download notepadplusplus --internalize
- choco download notepadplusplus.install --internalize --resources-location \\server\share
- choco download notepadplusplus.install --internalize --resources-location http://somewhere/internal --append-useoriginallocation
- choco download KB3033929 --internalize -internalize-all-urls --append-useoriginallocation
- choco download firefox --internalize locale=es-AR
-
-
-## See It In Action
-
-Coming soon
-
-## Options and Switches
-
-**NOTE:** Options and switches apply to all items passed, so if you are
- running a command like install that allows installing multiple
- packages, and you use `--version=1.0.0`, it is going to look for and
- try to install version 1.0.0 of every package passed. So please split
- out multiple package calls when wanting to pass specific options.
-
-Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).
-
-~~~
-
- downloading multiple packages, and you use `--version=1.0.0`, it is
- going to look for and try to download version 1.0.0 of every package
-
-
- -?, --help, -h
- Prints out the help menu.
-
- -d, --debug
- Debug - Show debug messaging.
-
- -v, --verbose
- Verbose - Show verbose messaging. Very verbose messaging, avoid using
- under normal circumstances.
-
- --trace
- Trace - Show trace messaging. Very, very verbose trace messaging. Avoid
- except when needing super low-level .NET Framework debugging. Available
- in 0.10.4+.
-
- --nocolor, --no-color
- No Color - Do not show colorization in logging output. This overrides
- the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
-
- --acceptlicense, --accept-license
- AcceptLicense - Accept license dialogs automatically. Reserved for
- future use.
-
- -y, --yes, --confirm
- Confirm all prompts - Chooses affirmative answer instead of prompting.
- Implies --accept-license
-
- -f, --force
- Force - force the behavior. Do not use force during normal operation -
- it subverts some of the smart behavior for commands.
-
- --noop, --whatif, --what-if
- NoOp / WhatIf - Don't actually do anything.
-
- -r, --limitoutput, --limit-output
- LimitOutput - Limit the output to essential information
-
- --timeout, --execution-timeout=VALUE
- CommandExecutionTimeout (in seconds) - The time to allow a command to
- finish before timing out. Overrides the default execution timeout in the
- configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
-
- -c, --cache, --cachelocation, --cache-location=VALUE
- CacheLocation - Location for download cache, defaults to %TEMP% or value
- in chocolatey.config file.
-
- --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
- AllowUnofficialBuild - When not using the official build you must set
- this flag for choco to continue.
-
- --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
- FailOnStandardError - Fail on standard error output (stderr), typically
- received when running external commands during install providers. This
- overrides the feature failOnStandardError.
-
- --use-system-powershell
- UseSystemPowerShell - Execute PowerShell using an external process
- instead of the built-in PowerShell host. Should only be used when
- internal host is failing. Available in 0.9.10+.
-
- --no-progress
- Do Not Show Progress - Do not show download progress percentages.
- Available in 0.10.4+.
-
- --proxy=VALUE
- Proxy Location - Explicit proxy location. Overrides the default proxy
- location of ''. Available for config settings in 0.9.9.9+, this CLI
- option available in 0.10.4+.
-
- --proxy-user=VALUE
- Proxy User Name - Explicit proxy user (optional). Requires explicity
- proxy (`--proxy` or config setting). Overrides the default proxy user of
- '123'. Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-password=VALUE
- Proxy Password - Explicit proxy password (optional) to be used with
- username. Requires explicity proxy (`--proxy` or config setting) and
- user name. Overrides the default proxy password (encrypted in settings
- if set). Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-bypass-list=VALUE
- ProxyBypassList - Comma separated list of regex locations to bypass on
- proxy. Requires explicity proxy (`--proxy` or config setting). Overrides
- the default proxy bypass list of ''. Available in 0.10.4+.
-
- --proxy-bypass-on-local
- Proxy Bypass On Local - Bypass proxy for local connections. Requires
- explicity proxy (`--proxy` or config setting). Overrides the default
- proxy bypass on local setting of 'True'. Available in 0.10.4+.
-
- --log-file=VALUE
- Log File to output to in addition to regular loggers. Available in 0.1-
- 0.8+.
-
- -s, --source=VALUE
- Source - The source to find the package(s) to download. Defaults to
- default feeds.
-
- --version=VALUE
- Version - A specific version to download. Defaults to unspecified.
-
- --pre, --prerelease
- Prerelease - Include Prereleases? Defaults to false.
-
- -u, --user=VALUE
- User - used with authenticated feeds. Defaults to empty.
-
- -p, --password=VALUE
- Password - the user's password to the source. Defaults to empty.
-
- --cert=VALUE
- Client certificate - PFX pathname for an x509 authenticated feeds.
- Defaults to empty.
-
- --cp, --certpassword=VALUE
- Certificate Password - the client certificate's password to the source.
- Defaults to empty.
-
- --out, --outdir, --outputdirectory, --output-directory=VALUE
- OutputDirectory - Specifies the directory for the downloaded Chocolatey
- package file. If not specified, uses the current directory.
-
- -i, --ignoredependencies, --ignore-dependencies
- IgnoreDependencies - Ignore dependencies when installing package(s).
- [Licensed editions](https://chocolatey.org/compare) v1.9.0+ Defaults to false.
-
- --recompile, --internalize
- Recompile / Internalize - Download all external resources and recompile
- the package to use the local resources instead. Business editions only
- (licensed version 1.5.0+).
-
- --resources-location=VALUE
- Resources Location - When internalizing, use this location for resources
- instead of embedding the downloaded resources into the package. Can be a
- file share or an internal url location. When it is a file share, it will
- attempt to download to that location. When it is an internal url, it
- will download locally and give further instructions on where it should
- be uploaded to match package edits. Business editions only (licensed
- version 1.5.1+).
-
- --download-location=VALUE
- Download Location - OPTIONAL - When internalizing, download the
- resources to this location. Used with Resources Location (and defaults
- to Resources Location when not set). Business editions only (licensed
- version 1.8.3+).
-
- -a, --all-urls, --internalize-all, --internalize-all-urls
- All Urls - OPTIONAL - When internalizing, Chocolatey would normally only
- internalize packages with known helpers. Add this switch to make it
- download anytime a URL is found. Business editions only (licensed
- version 1.12.0+).
-
- --append-useoriginallocation, --append-use-original-location
- Append -UseOriginalLocation - When `Install-ChocolateyPackage` is
- internalized, append the `-UseOriginalLocation` parameter to the
- function. Business editions only (licensed version 1.7.0+). Requires at
- least Chocolatey v0.10.1 for `Install-ChocolateyPackage` to recognize
- the switch appropriately. Overrides the feature
- 'internalizeAppendUseOriginalLocation' set to by default to 'True'.
-
- --sdc, --skipdownloadcache, --skip-download-cache
- Skip Download Cache - Use the original download url even if a private
- CDN cache is available for a package. Overrides the default feature
- 'downloadCache' set to 'True'. Business editions only (licensed version
- 1.12.2+). See https://chocolatey.org/docs/features-private-cdn
-
- --dc, --downloadcache, --download-cache, --use-download-cache
- Use Download Cache - Use private CDN cache if available for a package.
- Overrides the default feature 'downloadCache' set to 'True'. Business
- editions only (licensed version 1.12.2+). See https://chocolate-
- y.org/docs/features-private-cdn
-
-~~~
-
-[[Command Reference|CommandsReference]]
-
-
-***NOTE:*** This documentation has been automatically generated from `choco download -h`.
-
diff --git a/docs/generated/CommandsFeature.md b/docs/generated/CommandsFeature.md
deleted file mode 100644
index 1735ebe112..0000000000
--- a/docs/generated/CommandsFeature.md
+++ /dev/null
@@ -1,153 +0,0 @@
-
-
-# Feature Command (choco feature)
-
-Chocolatey will allow you to interact with features.
-
-## Usage
-
- choco feature [list]|disable|enable []
-
-## Examples
-
- choco feature
- choco feature list
- choco feature disable -n=bob
- choco feature enable -n=bob
-
-**NOTE:** See scripting in [[how to pass arguments|CommandsReference#how-to-pass-options--switches]] (`choco -?`) for how to
- write proper scripts and integrations.
-
-
-## Exit Codes
-
-Exit codes that normally result from running this command.
-
-Normal:
- - 0: operation was successful, no issues detected
- - -1 or 1: an error has occurred
-
-If you find other exit codes that we have not yet documented, please
- file a ticket so we can document it at
- https://github.com/chocolatey/choco/issues/new/choose.
-
-
-## Options and Switches
-
-**NOTE:** Options and switches apply to all items passed, so if you are
- running a command like install that allows installing multiple
- packages, and you use `--version=1.0.0`, it is going to look for and
- try to install version 1.0.0 of every package passed. So please split
- out multiple package calls when wanting to pass specific options.
-
-Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).
-
-~~~
-
- -?, --help, -h
- Prints out the help menu.
-
- -d, --debug
- Debug - Show debug messaging.
-
- -v, --verbose
- Verbose - Show verbose messaging. Very verbose messaging, avoid using
- under normal circumstances.
-
- --trace
- Trace - Show trace messaging. Very, very verbose trace messaging. Avoid
- except when needing super low-level .NET Framework debugging. Available
- in 0.10.4+.
-
- --nocolor, --no-color
- No Color - Do not show colorization in logging output. This overrides
- the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
-
- --acceptlicense, --accept-license
- AcceptLicense - Accept license dialogs automatically. Reserved for
- future use.
-
- -y, --yes, --confirm
- Confirm all prompts - Chooses affirmative answer instead of prompting.
- Implies --accept-license
-
- -f, --force
- Force - force the behavior. Do not use force during normal operation -
- it subverts some of the smart behavior for commands.
-
- --noop, --whatif, --what-if
- NoOp / WhatIf - Don't actually do anything.
-
- -r, --limitoutput, --limit-output
- LimitOutput - Limit the output to essential information
-
- --timeout, --execution-timeout=VALUE
- CommandExecutionTimeout (in seconds) - The time to allow a command to
- finish before timing out. Overrides the default execution timeout in the
- configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
-
- -c, --cache, --cachelocation, --cache-location=VALUE
- CacheLocation - Location for download cache, defaults to %TEMP% or value
- in chocolatey.config file.
-
- --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
- AllowUnofficialBuild - When not using the official build you must set
- this flag for choco to continue.
-
- --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
- FailOnStandardError - Fail on standard error output (stderr), typically
- received when running external commands during install providers. This
- overrides the feature failOnStandardError.
-
- --use-system-powershell
- UseSystemPowerShell - Execute PowerShell using an external process
- instead of the built-in PowerShell host. Should only be used when
- internal host is failing. Available in 0.9.10+.
-
- --no-progress
- Do Not Show Progress - Do not show download progress percentages.
- Available in 0.10.4+.
-
- --proxy=VALUE
- Proxy Location - Explicit proxy location. Overrides the default proxy
- location of ''. Available for config settings in 0.9.9.9+, this CLI
- option available in 0.10.4+.
-
- --proxy-user=VALUE
- Proxy User Name - Explicit proxy user (optional). Requires explicity
- proxy (`--proxy` or config setting). Overrides the default proxy user of
- '123'. Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-password=VALUE
- Proxy Password - Explicit proxy password (optional) to be used with
- username. Requires explicity proxy (`--proxy` or config setting) and
- user name. Overrides the default proxy password (encrypted in settings
- if set). Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-bypass-list=VALUE
- ProxyBypassList - Comma separated list of regex locations to bypass on
- proxy. Requires explicity proxy (`--proxy` or config setting). Overrides
- the default proxy bypass list of ''. Available in 0.10.4+.
-
- --proxy-bypass-on-local
- Proxy Bypass On Local - Bypass proxy for local connections. Requires
- explicity proxy (`--proxy` or config setting). Overrides the default
- proxy bypass on local setting of 'True'. Available in 0.10.4+.
-
- --log-file=VALUE
- Log File to output to in addition to regular loggers. Available in 0.1-
- 0.8+.
-
- -n, --name=VALUE
- Name - the name of the source. Required with actions other than list.
- Defaults to empty.
-
-~~~
-
-[[Command Reference|CommandsReference]]
-
-
-***NOTE:*** This documentation has been automatically generated from `choco feature -h`.
-
diff --git a/docs/generated/CommandsFeatures.md b/docs/generated/CommandsFeatures.md
deleted file mode 100644
index d551dc1836..0000000000
--- a/docs/generated/CommandsFeatures.md
+++ /dev/null
@@ -1,153 +0,0 @@
-
-
-# Feature Command (choco features)
-
-Chocolatey will allow you to interact with features.
-
-## Usage
-
- choco feature [list]|disable|enable []
-
-## Examples
-
- choco feature
- choco feature list
- choco feature disable -n=bob
- choco feature enable -n=bob
-
-**NOTE:** See scripting in [[how to pass arguments|CommandsReference#how-to-pass-options--switches]] (`choco -?`) for how to
- write proper scripts and integrations.
-
-
-## Exit Codes
-
-Exit codes that normally result from running this command.
-
-Normal:
- - 0: operation was successful, no issues detected
- - -1 or 1: an error has occurred
-
-If you find other exit codes that we have not yet documented, please
- file a ticket so we can document it at
- https://github.com/chocolatey/choco/issues/new/choose.
-
-
-## Options and Switches
-
-**NOTE:** Options and switches apply to all items passed, so if you are
- running a command like install that allows installing multiple
- packages, and you use `--version=1.0.0`, it is going to look for and
- try to install version 1.0.0 of every package passed. So please split
- out multiple package calls when wanting to pass specific options.
-
-Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).
-
-~~~
-
- -?, --help, -h
- Prints out the help menu.
-
- -d, --debug
- Debug - Show debug messaging.
-
- -v, --verbose
- Verbose - Show verbose messaging. Very verbose messaging, avoid using
- under normal circumstances.
-
- --trace
- Trace - Show trace messaging. Very, very verbose trace messaging. Avoid
- except when needing super low-level .NET Framework debugging. Available
- in 0.10.4+.
-
- --nocolor, --no-color
- No Color - Do not show colorization in logging output. This overrides
- the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
-
- --acceptlicense, --accept-license
- AcceptLicense - Accept license dialogs automatically. Reserved for
- future use.
-
- -y, --yes, --confirm
- Confirm all prompts - Chooses affirmative answer instead of prompting.
- Implies --accept-license
-
- -f, --force
- Force - force the behavior. Do not use force during normal operation -
- it subverts some of the smart behavior for commands.
-
- --noop, --whatif, --what-if
- NoOp / WhatIf - Don't actually do anything.
-
- -r, --limitoutput, --limit-output
- LimitOutput - Limit the output to essential information
-
- --timeout, --execution-timeout=VALUE
- CommandExecutionTimeout (in seconds) - The time to allow a command to
- finish before timing out. Overrides the default execution timeout in the
- configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
-
- -c, --cache, --cachelocation, --cache-location=VALUE
- CacheLocation - Location for download cache, defaults to %TEMP% or value
- in chocolatey.config file.
-
- --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
- AllowUnofficialBuild - When not using the official build you must set
- this flag for choco to continue.
-
- --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
- FailOnStandardError - Fail on standard error output (stderr), typically
- received when running external commands during install providers. This
- overrides the feature failOnStandardError.
-
- --use-system-powershell
- UseSystemPowerShell - Execute PowerShell using an external process
- instead of the built-in PowerShell host. Should only be used when
- internal host is failing. Available in 0.9.10+.
-
- --no-progress
- Do Not Show Progress - Do not show download progress percentages.
- Available in 0.10.4+.
-
- --proxy=VALUE
- Proxy Location - Explicit proxy location. Overrides the default proxy
- location of ''. Available for config settings in 0.9.9.9+, this CLI
- option available in 0.10.4+.
-
- --proxy-user=VALUE
- Proxy User Name - Explicit proxy user (optional). Requires explicity
- proxy (`--proxy` or config setting). Overrides the default proxy user of
- '123'. Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-password=VALUE
- Proxy Password - Explicit proxy password (optional) to be used with
- username. Requires explicity proxy (`--proxy` or config setting) and
- user name. Overrides the default proxy password (encrypted in settings
- if set). Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-bypass-list=VALUE
- ProxyBypassList - Comma separated list of regex locations to bypass on
- proxy. Requires explicity proxy (`--proxy` or config setting). Overrides
- the default proxy bypass list of ''. Available in 0.10.4+.
-
- --proxy-bypass-on-local
- Proxy Bypass On Local - Bypass proxy for local connections. Requires
- explicity proxy (`--proxy` or config setting). Overrides the default
- proxy bypass on local setting of 'True'. Available in 0.10.4+.
-
- --log-file=VALUE
- Log File to output to in addition to regular loggers. Available in 0.1-
- 0.8+.
-
- -n, --name=VALUE
- Name - the name of the source. Required with actions other than list.
- Defaults to empty.
-
-~~~
-
-[[Command Reference|CommandsReference]]
-
-
-***NOTE:*** This documentation has been automatically generated from `choco features -h`.
-
diff --git a/docs/generated/CommandsInfo.md b/docs/generated/CommandsInfo.md
deleted file mode 100644
index 224683c4be..0000000000
--- a/docs/generated/CommandsInfo.md
+++ /dev/null
@@ -1,189 +0,0 @@
-
-
-# Info Command (choco info)
-
-Chocolatey will perform a search for a package local or remote and provide
- detailed information about that package. This is a synonym for
- `choco search --exact --detailed`.
-
-**NOTE:** New as of 0.9.10.0.
-
-
-## Usage
-
- choco info []
-
-## Examples
-
- choco info chocolatey
- choco info googlechrome
- choco info powershell
-
-**NOTE:** See scripting in [[how to pass arguments|CommandsReference#how-to-pass-options--switches]] (`choco -?`) for how to
- write proper scripts and integrations.
-
-
-## Exit Codes
-
-Exit codes that normally result from running this command.
-
-Normal:
- - 0: operation was successful, no issues detected
- - -1 or 1: an error has occurred
-
-Enhanced:
- - 0: operation was successful, no issues detected
- - -1 or 1: an error has occurred
- - 2: no results (enhanced)
-
-**NOTE:** Starting in v0.10.12, if you have the feature 'useEnhancedExitCodes'
- turned on, then choco will provide enhanced exit codes that allow
- better integration and scripting.
-
-If you find other exit codes that we have not yet documented, please
- file a ticket so we can document it at
- https://github.com/chocolatey/choco/issues/new/choose.
-
-
-## Options and Switches
-
-**NOTE:** Options and switches apply to all items passed, so if you are
- running a command like install that allows installing multiple
- packages, and you use `--version=1.0.0`, it is going to look for and
- try to install version 1.0.0 of every package passed. So please split
- out multiple package calls when wanting to pass specific options.
-
-Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).
-
-~~~
-
- -?, --help, -h
- Prints out the help menu.
-
- -d, --debug
- Debug - Show debug messaging.
-
- -v, --verbose
- Verbose - Show verbose messaging. Very verbose messaging, avoid using
- under normal circumstances.
-
- --trace
- Trace - Show trace messaging. Very, very verbose trace messaging. Avoid
- except when needing super low-level .NET Framework debugging. Available
- in 0.10.4+.
-
- --nocolor, --no-color
- No Color - Do not show colorization in logging output. This overrides
- the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
-
- --acceptlicense, --accept-license
- AcceptLicense - Accept license dialogs automatically. Reserved for
- future use.
-
- -y, --yes, --confirm
- Confirm all prompts - Chooses affirmative answer instead of prompting.
- Implies --accept-license
-
- -f, --force
- Force - force the behavior. Do not use force during normal operation -
- it subverts some of the smart behavior for commands.
-
- --noop, --whatif, --what-if
- NoOp / WhatIf - Don't actually do anything.
-
- -r, --limitoutput, --limit-output
- LimitOutput - Limit the output to essential information
-
- --timeout, --execution-timeout=VALUE
- CommandExecutionTimeout (in seconds) - The time to allow a command to
- finish before timing out. Overrides the default execution timeout in the
- configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
-
- -c, --cache, --cachelocation, --cache-location=VALUE
- CacheLocation - Location for download cache, defaults to %TEMP% or value
- in chocolatey.config file.
-
- --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
- AllowUnofficialBuild - When not using the official build you must set
- this flag for choco to continue.
-
- --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
- FailOnStandardError - Fail on standard error output (stderr), typically
- received when running external commands during install providers. This
- overrides the feature failOnStandardError.
-
- --use-system-powershell
- UseSystemPowerShell - Execute PowerShell using an external process
- instead of the built-in PowerShell host. Should only be used when
- internal host is failing. Available in 0.9.10+.
-
- --no-progress
- Do Not Show Progress - Do not show download progress percentages.
- Available in 0.10.4+.
-
- --proxy=VALUE
- Proxy Location - Explicit proxy location. Overrides the default proxy
- location of ''. Available for config settings in 0.9.9.9+, this CLI
- option available in 0.10.4+.
-
- --proxy-user=VALUE
- Proxy User Name - Explicit proxy user (optional). Requires explicity
- proxy (`--proxy` or config setting). Overrides the default proxy user of
- '123'. Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-password=VALUE
- Proxy Password - Explicit proxy password (optional) to be used with
- username. Requires explicity proxy (`--proxy` or config setting) and
- user name. Overrides the default proxy password (encrypted in settings
- if set). Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-bypass-list=VALUE
- ProxyBypassList - Comma separated list of regex locations to bypass on
- proxy. Requires explicity proxy (`--proxy` or config setting). Overrides
- the default proxy bypass list of ''. Available in 0.10.4+.
-
- --proxy-bypass-on-local
- Proxy Bypass On Local - Bypass proxy for local connections. Requires
- explicity proxy (`--proxy` or config setting). Overrides the default
- proxy bypass on local setting of 'True'. Available in 0.10.4+.
-
- --log-file=VALUE
- Log File to output to in addition to regular loggers. Available in 0.1-
- 0.8+.
-
- -s, --source=VALUE
- Source - Source location for install. Can use special 'webpi' or
- 'windowsfeatures' sources. Defaults to sources.
-
- -l, --lo, --localonly, --local-only
- LocalOnly - Only search against local machine items.
-
- --version=VALUE
- Version - Specific version of a package to return.
-
- --pre, --prerelease
- Prerelease - Include Prereleases? Defaults to false.
-
- -u, --user=VALUE
- User - used with authenticated feeds. Defaults to empty.
-
- -p, --password=VALUE
- Password - the user's password to the source. Defaults to empty.
-
- --cert=VALUE
- Client certificate - PFX pathname for an x509 authenticated feeds.
- Defaults to empty. Available in 0.9.10+.
-
- --cp, --certpassword=VALUE
- Certificate Password - the client certificate's password to the source.
- Defaults to empty. Available in 0.9.10+.
-
-~~~
-
-[[Command Reference|CommandsReference]]
-
-
-***NOTE:*** This documentation has been automatically generated from `choco info -h`.
-
diff --git a/docs/generated/CommandsInstall.md b/docs/generated/CommandsInstall.md
deleted file mode 100644
index d6d21bf618..0000000000
--- a/docs/generated/CommandsInstall.md
+++ /dev/null
@@ -1,523 +0,0 @@
-
-
-# Install Command (choco install)
-
-Installs a package or a list of packages (sometimes specified as a
- packages.config). Some may prefer to use `cinst` as a shortcut for
- [[`choco install`|Commandsinstall]].
-
-**NOTE:** 100% compatible with older chocolatey client (0.9.8.32 and below)
- with options and switches. Add `-y` for previous behavior with no
- prompt. In most cases you can still pass options and switches with one
- dash (`-`). For more details, see [[how to pass arguments|CommandsReference#how-to-pass-options--switches]] (`choco -?`).
-
-## Usage
-
- choco install [] []
- cinst [] []
-
-**NOTE:** `all` is a special package keyword that will allow you to install
- all packages from a custom feed. Will not work with Chocolatey default
- feed. THIS IS NOT YET REIMPLEMENTED.
-
-**NOTE:** Any package name ending with .config is considered a
- 'packages.config' file. Please see https://bit.ly/packages_config
-
-**NOTE:** [Chocolatey Pro](https://chocolatey.org/compare) / Business builds on top of a great open source
- experience with quite a few features that enhance the your use of the
- community package repository (when using Pro), and really enhance the
- Chocolatey experience all around. If you are an organization looking
- for a better ROI, look no further than Business - automatic package
- creation from installer files, automatic recompile support, runtime
- malware protection, private CDN download cache, synchronize with
- Programs and Features, etc - https://chocolatey.org/compare.
-
-
-## Examples
-
- choco install sysinternals
- choco install notepadplusplus googlechrome atom 7zip
- choco install notepadplusplus --force --force-dependencies
- choco install notepadplusplus googlechrome atom 7zip -dvfy
- choco install git -y --params="'/GitAndUnixToolsOnPath /NoAutoCrlf'"
- choco install git -y --params="'/GitAndUnixToolsOnPath /NoAutoCrlf'" --install-args="'/DIR=C:\git'"
- # Params are package parameters, passed to the package
- # Install args are installer arguments, appended to the silentArgs
- # in the package for the installer itself
- choco install nodejs.install --version 0.10.35
- choco install git -s "'https://somewhere/out/there'"
- choco install git -s "'https://somewhere/protected'" -u user -p pass
-
-Choco can also install directly from a nuspec/nupkg file. This aids in
- testing packages:
-
- choco install
- choco install
-
-Install multiple versions of a package using -m (AllowMultiple versions)
-
- choco install ruby --version 1.9.3.55100 -my
- choco install ruby --version 2.0.0.59800 -my
- choco install ruby --version 2.1.5 -my
-
-What is `-my`? See option bundling in [[how to pass arguments|CommandsReference#how-to-pass-options--switches]]
- (`choco -?`).
-
-**NOTE:** All of these will add to PATH variable. We'll be adding a special
- option to not allow PATH changes. Until then you will need to manually
- go modify Path to just one Ruby and then use something like uru
- (https://bitbucket.org/jonforums/uru) or pik
- (https://chocolatey.org/packages/pik) to switch between versions.
-
-**NOTE:** See scripting in [[how to pass arguments|CommandsReference#how-to-pass-options--switches]] (`choco -?`) for how to
- write proper scripts and integrations.
-
-
-## Exit Codes
-
-Exit codes that normally result from running this command.
-
-Normal:
- - 0: operation was successful, no issues detected
- - -1 or 1: an error has occurred
-
-Package Exit Codes:
- - 1641: success, reboot initiated
- - 3010: success, reboot required
- - other (not listed): likely an error has occurred
-
-In addition to normal exit codes, packages are allowed to exit
- with their own codes when the feature 'usePackageExitCodes' is
- turned on. Uninstall command has additional valid exit codes.
- Available in v0.9.10+.
-
-Reboot Exit Codes:
- - 350: pending reboot detected, no action has occurred
- - 1604: install suspended, incomplete
-
-In addition to the above exit codes, you may also see reboot exit codes
- when the feature 'exitOnRebootDetected' is turned on. It typically requires
- the feature 'usePackageExitCodes' to also be turned on to work properly.
- Available in v0.10.12+.
-
-## See It In Action
-
-Chocolatey FOSS install showing tab completion and `refreshenv` (a way
- to update environment variables without restarting the shell).
-
-
-
-[Chocolatey Professional](https://chocolatey.org/compare) showing private download cache and virus scan
- protection.
-
-
-
-## Packages.config
-
-Alternative to PackageName. This is a list of packages in an xml manifest for Chocolatey to install. This is like the packages.config that NuGet uses except it also adds other options and switches. This can also be the path to the packages.config file if it is not in the current working directory.
-
-**NOTE:** The filename is only required to end in .config, the name is not required to be packages.config.
-
-~~~xml
-
-
-
-
-
-
-
-~~~
-
-
-## Alternative Sources
-
-Available in 0.9.10+.
-
-### Ruby
-This specifies the source is Ruby Gems and that we are installing a
- gem. If you do not have ruby installed prior to running this command,
- the command will install that first.
- e.g. `choco install compass -source ruby`
-
-### WebPI
-This specifies the source is Web PI (Web Platform Installer) and that
- we are installing a WebPI product, such as IISExpress. If you do not
- have the Web PI command line installed, it will install that first and
- then the product requested.
- e.g. `choco install IISExpress --source webpi`
-
-### Cygwin
-This specifies the source is Cygwin and that we are installing a cygwin
- package, such as bash. If you do not have Cygwin installed, it will
- install that first and then the product requested.
- e.g. `choco install bash --source cygwin`
-
-### Python
-This specifies the source is Python and that we are installing a python
- package, such as Sphinx. If you do not have easy_install and Python
- installed, it will install those first and then the product requested.
- e.g. `choco install sphinx --source python`
-
-### Windows Features
-This specifies that the source is a Windows Feature and we should
- install via the Deployment Image Servicing and Management tool (DISM)
- on the local machine.
- e.g. `choco install IIS-WebServerRole --source windowsfeatures`
-
-
-## Resources
-
- * How-To: A complete example of how you can use the PackageParameters argument
- when creating a Chocolatey Package can be seen at
- https://chocolatey.org/docs/how-to-parse-package-parameters-argument
- * One may want to override the default installation directory of a
- piece of software. See
- https://chocolatey.org/docs/getting-started#overriding-default-install-directory-or-other-advanced-install-concepts.
-
-
-## Options and Switches
-
-**NOTE:** Options and switches apply to all items passed, so if you are
- running a command like install that allows installing multiple
- packages, and you use `--version=1.0.0`, it is going to look for and
- try to install version 1.0.0 of every package passed. So please split
- out multiple package calls when wanting to pass specific options.
-
-Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).
-
-~~~
-
-
-
- -?, --help, -h
- Prints out the help menu.
-
- -d, --debug
- Debug - Show debug messaging.
-
- -v, --verbose
- Verbose - Show verbose messaging. Very verbose messaging, avoid using
- under normal circumstances.
-
- --trace
- Trace - Show trace messaging. Very, very verbose trace messaging. Avoid
- except when needing super low-level .NET Framework debugging. Available
- in 0.10.4+.
-
- --nocolor, --no-color
- No Color - Do not show colorization in logging output. This overrides
- the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
-
- --acceptlicense, --accept-license
- AcceptLicense - Accept license dialogs automatically. Reserved for
- future use.
-
- -y, --yes, --confirm
- Confirm all prompts - Chooses affirmative answer instead of prompting.
- Implies --accept-license
-
- -f, --force
- Force - force the behavior. Do not use force during normal operation -
- it subverts some of the smart behavior for commands.
-
- --noop, --whatif, --what-if
- NoOp / WhatIf - Don't actually do anything.
-
- -r, --limitoutput, --limit-output
- LimitOutput - Limit the output to essential information
-
- --timeout, --execution-timeout=VALUE
- CommandExecutionTimeout (in seconds) - The time to allow a command to
- finish before timing out. Overrides the default execution timeout in the
- configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
-
- -c, --cache, --cachelocation, --cache-location=VALUE
- CacheLocation - Location for download cache, defaults to %TEMP% or value
- in chocolatey.config file.
-
- --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
- AllowUnofficialBuild - When not using the official build you must set
- this flag for choco to continue.
-
- --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
- FailOnStandardError - Fail on standard error output (stderr), typically
- received when running external commands during install providers. This
- overrides the feature failOnStandardError.
-
- --use-system-powershell
- UseSystemPowerShell - Execute PowerShell using an external process
- instead of the built-in PowerShell host. Should only be used when
- internal host is failing. Available in 0.9.10+.
-
- --no-progress
- Do Not Show Progress - Do not show download progress percentages.
- Available in 0.10.4+.
-
- --proxy=VALUE
- Proxy Location - Explicit proxy location. Overrides the default proxy
- location of ''. Available for config settings in 0.9.9.9+, this CLI
- option available in 0.10.4+.
-
- --proxy-user=VALUE
- Proxy User Name - Explicit proxy user (optional). Requires explicity
- proxy (`--proxy` or config setting). Overrides the default proxy user of
- '123'. Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-password=VALUE
- Proxy Password - Explicit proxy password (optional) to be used with
- username. Requires explicity proxy (`--proxy` or config setting) and
- user name. Overrides the default proxy password (encrypted in settings
- if set). Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-bypass-list=VALUE
- ProxyBypassList - Comma separated list of regex locations to bypass on
- proxy. Requires explicity proxy (`--proxy` or config setting). Overrides
- the default proxy bypass list of ''. Available in 0.10.4+.
-
- --proxy-bypass-on-local
- Proxy Bypass On Local - Bypass proxy for local connections. Requires
- explicity proxy (`--proxy` or config setting). Overrides the default
- proxy bypass on local setting of 'True'. Available in 0.10.4+.
-
- --log-file=VALUE
- Log File to output to in addition to regular loggers. Available in 0.1-
- 0.8+.
-
- -s, --source=VALUE
- Source - The source to find the package(s) to install. Special sources
- include: ruby, webpi, cygwin, windowsfeatures, and python. To specify
- more than one source, pass it with a semi-colon separating the values (-
- e.g. "'source1;source2'"). Defaults to default feeds.
-
- --version=VALUE
- Version - A specific version to install. Defaults to unspecified.
-
- --pre, --prerelease
- Prerelease - Include Prereleases? Defaults to false.
-
- --x86, --forcex86
- ForceX86 - Force x86 (32bit) installation on 64 bit systems. Defaults to
- false.
-
- --ia, --installargs, --installarguments, --install-arguments=VALUE
- InstallArguments - Install Arguments to pass to the native installer in
- the package. Defaults to unspecified.
-
- -o, --override, --overrideargs, --overridearguments, --override-arguments
- OverrideArguments - Should install arguments be used exclusively without
- appending to current package passed arguments? Defaults to false.
-
- --notsilent, --not-silent
- NotSilent - Do not install this silently. Defaults to false.
-
- --params, --parameters, --pkgparameters, --packageparameters, --package-parameters=VALUE
- PackageParameters - Parameters to pass to the package. Defaults to
- unspecified.
-
- --argsglobal, --args-global, --installargsglobal, --install-args-global, --applyargstodependencies, --apply-args-to-dependencies, --apply-install-arguments-to-dependencies
- Apply Install Arguments To Dependencies - Should install arguments be
- applied to dependent packages? Defaults to false.
-
- --paramsglobal, --params-global, --packageparametersglobal, --package-parameters-global, --applyparamstodependencies, --apply-params-to-dependencies, --apply-package-parameters-to-dependencies
- Apply Package Parameters To Dependencies - Should package parameters be
- applied to dependent packages? Defaults to false.
-
- --allowdowngrade, --allow-downgrade
- AllowDowngrade - Should an attempt at downgrading be allowed? Defaults
- to false.
-
- -m, --sxs, --sidebyside, --side-by-side, --allowmultiple, --allow-multiple, --allowmultipleversions, --allow-multiple-versions
- AllowMultipleVersions - Should multiple versions of a package be
- installed? Defaults to false.
-
- -i, --ignoredependencies, --ignore-dependencies
- IgnoreDependencies - Ignore dependencies when installing package(s).
- Defaults to false.
-
- -x, --forcedependencies, --force-dependencies
- ForceDependencies - Force dependencies to be reinstalled when force
- installing package(s). Must be used in conjunction with --force.
- Defaults to false.
-
- -n, --skippowershell, --skip-powershell, --skipscripts, --skip-scripts, --skip-automation-scripts
- Skip Powershell - Do not run chocolateyInstall.ps1. Defaults to false.
-
- -u, --user=VALUE
- User - used with authenticated feeds. Defaults to empty.
-
- -p, --password=VALUE
- Password - the user's password to the source. Defaults to empty.
-
- --cert=VALUE
- Client certificate - PFX pathname for an x509 authenticated feeds.
- Defaults to empty. Available in 0.9.10+.
-
- --cp, --certpassword=VALUE
- Certificate Password - the client certificate's password to the source.
- Defaults to empty. Available in 0.9.10+.
-
- --ignorechecksum, --ignore-checksum, --ignorechecksums, --ignore-checksums
- IgnoreChecksums - Ignore checksums provided by the package. Overrides
- the default feature 'checksumFiles' set to 'True'. Available in 0.9.9.9+.
-
- --allowemptychecksum, --allowemptychecksums, --allow-empty-checksums
- Allow Empty Checksums - Allow packages to have empty/missing checksums
- for downloaded resources from non-secure locations (HTTP, FTP). Use this
- switch is not recommended if using sources that download resources from
- the internet. Overrides the default feature 'allowEmptyChecksums' set to
- 'False'. Available in 0.10.0+.
-
- --allowemptychecksumsecure, --allowemptychecksumssecure, --allow-empty-checksums-secure
- Allow Empty Checksums Secure - Allow packages to have empty checksums
- for downloaded resources from secure locations (HTTPS). Overrides the
- default feature 'allowEmptyChecksumsSecure' set to 'True'. Available in
- 0.10.0+.
-
- --requirechecksum, --requirechecksums, --require-checksums
- Require Checksums - Requires packages to have checksums for downloaded
- resources (both non-secure and secure). Overrides the default feature
- 'allowEmptyChecksums' set to 'False' and 'allowEmptyChecksumsSecure' set
- to 'True'. Available in 0.10.0+.
-
- --checksum, --downloadchecksum, --download-checksum=VALUE
- Download Checksum - a user provided checksum for downloaded resources
- for the package. Overrides the package checksum (if it has one).
- Defaults to empty. Available in 0.10.0+.
-
- --checksum64, --checksumx64, --downloadchecksumx64, --download-checksum-x64=VALUE
- Download Checksum 64bit - a user provided checksum for 64bit downloaded
- resources for the package. Overrides the package 64-bit checksum (if it
- has one). Defaults to same as Download Checksum. Available in 0.10.0+.
-
- --checksumtype, --checksum-type, --downloadchecksumtype, --download-checksum-type=VALUE
- Download Checksum Type - a user provided checksum type. Overrides the
- package checksum type (if it has one). Used in conjunction with Download
- Checksum. Available values are 'md5', 'sha1', 'sha256' or 'sha512'.
- Defaults to 'md5'. Available in 0.10.0+.
-
- --checksumtype64, --checksumtypex64, --checksum-type-x64, --downloadchecksumtypex64, --download-checksum-type-x64=VALUE
- Download Checksum Type 64bit - a user provided checksum for 64bit
- downloaded resources for the package. Overrides the package 64-bit
- checksum (if it has one). Used in conjunction with Download Checksum
- 64bit. Available values are 'md5', 'sha1', 'sha256' or 'sha512'.
- Defaults to same as Download Checksum Type. Available in 0.10.0+.
-
- --ignorepackagecodes, --ignorepackageexitcodes, --ignore-package-codes, --ignore-package-exit-codes
- IgnorePackageExitCodes - Exit with a 0 for success and 1 for non-succes-
- s, no matter what package scripts provide for exit codes. Overrides the
- default feature 'usePackageExitCodes' set to 'True'. Available in 0.-
- 9.10+.
-
- --usepackagecodes, --usepackageexitcodes, --use-package-codes, --use-package-exit-codes
- UsePackageExitCodes - Package scripts can provide exit codes. Use those
- for choco's exit code when non-zero (this value can come from a
- dependency package). Chocolatey defines valid exit codes as 0, 1605,
- 1614, 1641, 3010. Overrides the default feature 'usePackageExitCodes'
- set to 'True'. Available in 0.9.10+.
-
- --stoponfirstfailure, --stop-on-first-failure, --stop-on-first-package-failure
- Stop On First Package Failure - stop running install, upgrade or
- uninstall on first package failure instead of continuing with others.
- Overrides the default feature 'stopOnFirstPackageFailure' set to 'False-
- '. Available in 0.10.4+.
-
- --exitwhenrebootdetected, --exit-when-reboot-detected
- Exit When Reboot Detected - Stop running install, upgrade, or uninstall
- when a reboot request is detected. Requires 'usePackageExitCodes'
- feature to be turned on. Will exit with either 350 or 1604. Overrides
- the default feature 'exitOnRebootDetected' set to 'False'. Available in
- 0.10.12+.
-
- --ignoredetectedreboot, --ignore-detected-reboot
- Ignore Detected Reboot - Ignore any detected reboots if found. Overrides
- the default feature 'exitOnRebootDetected' set to 'False'. Available in
- 0.10.12+.
-
- --sdc, --skipdownloadcache, --skip-download-cache
- Skip Download Cache - Use the original download even if a private CDN
- cache is available for a package. Overrides the default feature
- 'downloadCache' set to 'True'. Available in 0.9.10+. [Licensed editions](https://chocolatey.org/compare)
- only. See https://chocolatey.org/docs/features-private-cdn
-
- --dc, --downloadcache, --download-cache, --use-download-cache
- Use Download Cache - Use private CDN cache if available for a package.
- Overrides the default feature 'downloadCache' set to 'True'. Available
- in 0.9.10+. [Licensed editions](https://chocolatey.org/compare) only. See https://chocolate-
- y.org/docs/features-private-cdn
-
- --svc, --skipvirus, --skip-virus, --skipviruscheck, --skip-virus-check
- Skip Virus Check - Skip the virus check for downloaded files on this ru-
- n. Overrides the default feature 'virusCheck' set to 'True'. Available
- in 0.9.10+. [Licensed editions](https://chocolatey.org/compare) only. See https://chocolate-
- y.org/docs/features-virus-check
-
- --virus, --viruscheck, --virus-check
- Virus Check - check downloaded files for viruses. Overrides the default
- feature 'virusCheck' set to 'True'. Available in 0.9.10+. Licensed
- editions only. See https://chocolatey.org/docs/features-virus-check
-
- --viruspositivesmin, --virus-positives-minimum=VALUE
- Virus Check Minimum Scan Result Positives - the minimum number of scan
- result positives required to flag a package. Used when virusScannerType
- is VirusTotal. Overrides the default configuration value
- 'virusCheckMinimumPositives' set to '5'. Available in 0.9.10+. Licensed
- editions only. See https://chocolatey.org/docs/features-virus-check
-
- --install-arguments-sensitive=VALUE
- InstallArgumentsSensitive - Install Arguments to pass to the native
- installer in the package that are sensitive and you do not want logged.
- Defaults to unspecified. Available in 0.10.1+. [Licensed editions](https://chocolatey.org/compare) only.
-
- --package-parameters-sensitive=VALUE
- PackageParametersSensitive - Package Parameters to pass the package that
- are sensitive and you do not want logged. Defaults to unspecified.
- Available in 0.10.1+. [Licensed editions](https://chocolatey.org/compare) only.
-
- --dir, --directory, --installdir, --installdirectory, --install-dir, --install-directory=VALUE
- Install Directory Override - Override the default installation director-
- y. Chocolatey will automatically determine the type of installer and
- pass the appropriate arguments to override the install directory. The
- package must use Chocolatey install helpers and be installing an
- installer for software. Available in 0.9.10+. [Licensed editions](https://chocolatey.org/compare) only.
- See https://chocolatey.org/docs/features-install-directory-override
-
- --bps, --maxdownloadrate, --max-download-rate, --maxdownloadbitspersecond, --max-download-bits-per-second, --maximumdownloadbitspersecond, --maximum-download-bits-per-second=VALUE
- Maximum Download Rate Bits Per Second - The maximum download rate in
- bits per second. '0' or empty means no maximum. A number means that will
- be the maximum download rate in bps. Defaults to config setting of '0'.
- Available in [licensed editions](https://chocolatey.org/compare) v1.10+ only. See https://chocolate-
- y.org/docs/features-package-throttle
-
- --reduce, --reduce-package-size, --deflate, --deflate-package-size
- Reducer Installed Package Size (Package Reducer) - Reduce size of the
- nupkg file to very small and remove extracted archives and installers.
- Overrides the default feature 'reduceInstalledPackageSpaceUsage' set to
- 'True'. [Licensed editions](https://chocolatey.org/compare) only (version 1.12.0+). See https://chocolate-
- y.org/docs/features-package-reducer
-
- --no-reduce, --no-reduce-package-size, --no-deflate, --no-deflate-package-size
- Do Not Reduce Installed Package Size - Leave the nupkg and files alone
- in the package. Overrides the default feature
- 'reduceInstalledPackageSpaceUsage' set to 'True'. [Licensed editions](https://chocolatey.org/compare) only
- (version 1.12.0+). See https://chocolatey.org/docs/features-package-
- reducer
-
- --reduce-nupkg-only, --deflate-nupkg-only
- Reduce Only Nupkg File Size - reduce only the size of nupkg file when
- using Package Reducer. Overrides the default feature
- 'reduceOnlyNupkgSize' set to 'False'. [Licensed editions](https://chocolatey.org/compare) only (version -
- 1.12.0+). See https://chocolatey.org/docs/features-package-reducer
-
-~~~
-
-[[Command Reference|CommandsReference]]
-
-
-***NOTE:*** This documentation has been automatically generated from `choco install -h`.
-
diff --git a/docs/generated/CommandsList.md b/docs/generated/CommandsList.md
deleted file mode 100644
index 6a1a84cdc2..0000000000
--- a/docs/generated/CommandsList.md
+++ /dev/null
@@ -1,278 +0,0 @@
-
-
-# List/Search Command (choco list)
-
-Chocolatey will perform a search for a package local or remote. Some
- may prefer to use [[`clist`|Commandslist]] as a shortcut for [[`choco list`|Commandslist]].
-
-**NOTE:** 100% compatible with older Chocolatey client (0.9.8.x and below)
- with options and switches. In most cases you can still pass options
- and switches with one dash (`-`). For more details, see
- [[how to pass arguments|CommandsReference#how-to-pass-options--switches]] (`choco -?`).
-
-## Usage
-
- choco search []
- choco list []
- clist []
-
-## Examples
-
- choco list --local-only
- choco list -li
- choco list -lai
- choco list --page=0 --page-size=25
- choco search git
- choco search git --source="'https://somewhere/out/there'"
- choco search bob -s "'https://somewhere/protected'" -u user -p pass
-
-**NOTE:** See scripting in [[how to pass arguments|CommandsReference#how-to-pass-options--switches]] (`choco -?`) for how to
- write proper scripts and integrations.
-
-
-## Exit Codes
-
-Exit codes that normally result from running this command.
-
-Normal:
- - 0: operation was successful, no issues detected
- - -1 or 1: an error has occurred
-
-Enhanced:
- - 0: operation was successful, no issues detected
- - -1 or 1: an error has occurred
- - 2: no results (enhanced)
-
-**NOTE:** Starting in v0.10.12, if you have the feature 'useEnhancedExitCodes'
- turned on, then choco will provide enhanced exit codes that allow
- better integration and scripting.
-
-If you find other exit codes that we have not yet documented, please
- file a ticket so we can document it at
- https://github.com/chocolatey/choco/issues/new/choose.
-
-
-## See It In Action
-
-
-
-
-## Alternative Sources
-
-Available in 0.9.10+.
-
-### WebPI
-This specifies the source is Web PI (Web Platform Installer) and that
- we are searching for a WebPI product, such as IISExpress. If you do
- not have the Web PI command line installed, it will install that first
- and then perform the search requested.
- e.g. `choco list --source webpi`
-
-### Windows Features
-This specifies that the source is a Windows Feature and we should
- install via the Deployment Image Servicing and Management tool (DISM)
- on the local machine.
- e.g. `choco list --source windowsfeatures`
-
-## Options and Switches
-
-**NOTE:** Options and switches apply to all items passed, so if you are
- running a command like install that allows installing multiple
- packages, and you use `--version=1.0.0`, it is going to look for and
- try to install version 1.0.0 of every package passed. So please split
- out multiple package calls when wanting to pass specific options.
-
-Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).
-
-~~~
-
- -?, --help, -h
- Prints out the help menu.
-
- -d, --debug
- Debug - Show debug messaging.
-
- -v, --verbose
- Verbose - Show verbose messaging. Very verbose messaging, avoid using
- under normal circumstances.
-
- --trace
- Trace - Show trace messaging. Very, very verbose trace messaging. Avoid
- except when needing super low-level .NET Framework debugging. Available
- in 0.10.4+.
-
- --nocolor, --no-color
- No Color - Do not show colorization in logging output. This overrides
- the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
-
- --acceptlicense, --accept-license
- AcceptLicense - Accept license dialogs automatically. Reserved for
- future use.
-
- -y, --yes, --confirm
- Confirm all prompts - Chooses affirmative answer instead of prompting.
- Implies --accept-license
-
- -f, --force
- Force - force the behavior. Do not use force during normal operation -
- it subverts some of the smart behavior for commands.
-
- --noop, --whatif, --what-if
- NoOp / WhatIf - Don't actually do anything.
-
- -r, --limitoutput, --limit-output
- LimitOutput - Limit the output to essential information
-
- --timeout, --execution-timeout=VALUE
- CommandExecutionTimeout (in seconds) - The time to allow a command to
- finish before timing out. Overrides the default execution timeout in the
- configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
-
- -c, --cache, --cachelocation, --cache-location=VALUE
- CacheLocation - Location for download cache, defaults to %TEMP% or value
- in chocolatey.config file.
-
- --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
- AllowUnofficialBuild - When not using the official build you must set
- this flag for choco to continue.
-
- --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
- FailOnStandardError - Fail on standard error output (stderr), typically
- received when running external commands during install providers. This
- overrides the feature failOnStandardError.
-
- --use-system-powershell
- UseSystemPowerShell - Execute PowerShell using an external process
- instead of the built-in PowerShell host. Should only be used when
- internal host is failing. Available in 0.9.10+.
-
- --no-progress
- Do Not Show Progress - Do not show download progress percentages.
- Available in 0.10.4+.
-
- --proxy=VALUE
- Proxy Location - Explicit proxy location. Overrides the default proxy
- location of ''. Available for config settings in 0.9.9.9+, this CLI
- option available in 0.10.4+.
-
- --proxy-user=VALUE
- Proxy User Name - Explicit proxy user (optional). Requires explicity
- proxy (`--proxy` or config setting). Overrides the default proxy user of
- '123'. Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-password=VALUE
- Proxy Password - Explicit proxy password (optional) to be used with
- username. Requires explicity proxy (`--proxy` or config setting) and
- user name. Overrides the default proxy password (encrypted in settings
- if set). Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-bypass-list=VALUE
- ProxyBypassList - Comma separated list of regex locations to bypass on
- proxy. Requires explicity proxy (`--proxy` or config setting). Overrides
- the default proxy bypass list of ''. Available in 0.10.4+.
-
- --proxy-bypass-on-local
- Proxy Bypass On Local - Bypass proxy for local connections. Requires
- explicity proxy (`--proxy` or config setting). Overrides the default
- proxy bypass on local setting of 'True'. Available in 0.10.4+.
-
- --log-file=VALUE
- Log File to output to in addition to regular loggers. Available in 0.1-
- 0.8+.
-
- -s, --source=VALUE
- Source - Source location for install. Can use special 'webpi' or
- 'windowsfeatures' sources. Defaults to sources.
-
- -l, --lo, --localonly, --local-only
- LocalOnly - Only search against local machine items.
-
- --idonly, --id-only
- Id Only - Only return Package Ids in the list results. Available in 0.1-
- 0.6+.
-
- --pre, --prerelease
- Prerelease - Include Prereleases? Defaults to false.
-
- -i, --includeprograms, --include-programs
- IncludePrograms - Used in conjunction with LocalOnly, filters out apps
- chocolatey has listed as packages and includes those in the list.
- Defaults to false.
-
- -a, --all, --allversions, --all-versions
- AllVersions - include results from all versions.
-
- --version=VALUE
- Version - Specific version of a package to return.
-
- -u, --user=VALUE
- User - used with authenticated feeds. Defaults to empty.
-
- -p, --password=VALUE
- Password - the user's password to the source. Defaults to empty.
-
- --cert=VALUE
- Client certificate - PFX pathname for an x509 authenticated feeds.
- Defaults to empty. Available in 0.9.10+.
-
- --cp, --certpassword=VALUE
- Certificate Password - the client certificate's password to the source.
- Defaults to empty. Available in 0.9.10+.
-
- --page=VALUE
- Page - the 'page' of results to return. Defaults to return all results.
- Available in 0.9.10+.
-
- --page-size=VALUE
- Page Size - the amount of package results to return per page. Defaults
- to 25. Available in 0.9.10+.
-
- -e, --exact
- Exact - Only return packages with this exact name. Available in 0.9.10+.
-
- --by-id-only
- ByIdOnly - Only return packages where the id contains the search filter.
- Available in 0.9.10+.
-
- --by-tag-only, --by-tags-only
- ByTagOnly - Only return packages where the search filter matches on the
- tags. Available in 0.10.6+.
-
- --id-starts-with
- IdStartsWith - Only return packages where the id starts with the search
- filter. Available in 0.9.10+.
-
- --order-by-popularity
- OrderByPopularity - Sort by package results by popularity. Available in
- 0.9.10+.
-
- --approved-only
- ApprovedOnly - Only return approved packages - this option will filter
- out results not from the [community repository](https://chocolatey.org/packages). Available in 0.9.10+.
-
- --download-cache, --download-cache-only
- DownloadCacheAvailable - Only return packages that have a download cache
- available - this option will filter out results not from the community
- repository. Available in 0.9.10+.
-
- --not-broken
- NotBroken - Only return packages that are not failing testing - this
- option only filters out failing results from the [community feed](https://chocolatey.org/packages). It will
- not filter against other sources. Available in 0.9.10+.
-
- --detail, --detailed
- Detailed - Alias for verbose. Available in 0.9.10+.
-
- --audit, --showaudit, --show-audit, --show-audit-info
- Show Audit Information - Display auditing information for a package.
- Available in business editions 1.12.0+.
-
-~~~
-
-[[Command Reference|CommandsReference]]
-
-
-***NOTE:*** This documentation has been automatically generated from `choco list -h`.
-
diff --git a/docs/generated/CommandsNew.md b/docs/generated/CommandsNew.md
deleted file mode 100644
index 1c99b0cbe1..0000000000
--- a/docs/generated/CommandsNew.md
+++ /dev/null
@@ -1,278 +0,0 @@
-
-
-# Package Builder Command (choco new)
-
-Chocolatey [Licensed editions](https://chocolatey.org/compare) include some level of Package Builder.
-
- - Professional (licensed edition v1.9.0+) can take advantage of
- Package Builder UI minus the auto-detection
- - Business (licensed edition v1.4.0+) can use `--file` or Package
- Builder UI to generate a fully ready to go unattended software
- deployment in seconds. So easy a 7 year old can do it. Right Click
- 'Create Package...'
- - Business (licensed edition v1.8.0+) can use
- `--from-programs-and-features` to generate packages directly from
- Programs and Features!
-
-See https://chocolatey.org/docs/features-create-packages-from-installers
-
-
-# New Command (choco new)
-
-Chocolatey will generate package specification files for a new package.
-
-## Usage
-
- choco new [] []
-
-Possible properties to pass:
- packageversion
- maintainername
- maintainerrepo
- installertype
- url
- url64
- silentargs
-
-**NOTE:** Starting in 0.9.10, you can pass arbitrary property value pairs
- through to templates. This really unlocks your ability to create
- packages automatically!
-
-**NOTE:** [Chocolatey for Business](https://chocolatey.org/compare) can create complete packages by just
- pointing the new command to native installers!
-
-**NOTE:** [Chocolatey for Business](https://chocolatey.org/compare) can also download and internalize remote
- resources from existing packages so that existing packages can be used
- without being tied to the internet.
- This is called automatic recompile.
-
-## Examples
-
- choco new bob
- choco new bob -a --version 1.2.0 maintainername="'This guy'"
- choco new bob silentargs="'/S'" url="'https://somewhere/out/there.msi'"
- choco new bob --outputdirectory Packages
-
-**NOTE:** See scripting in [[how to pass arguments|CommandsReference#how-to-pass-options--switches]] (`choco -?`) for how to
- write proper scripts and integrations.
-
-
-## Exit Codes
-
-Exit codes that normally result from running this command.
-
-Normal:
- - 0: operation was successful, no issues detected
- - -1 or 1: an error has occurred
-
-If you find other exit codes that we have not yet documented, please
- file a ticket so we can document it at
- https://github.com/chocolatey/choco/issues/new/choose.
-
-
-## Options and Switches
-
-**NOTE:** Options and switches apply to all items passed, so if you are
- running a command like install that allows installing multiple
- packages, and you use `--version=1.0.0`, it is going to look for and
- try to install version 1.0.0 of every package passed. So please split
- out multiple package calls when wanting to pass specific options.
-
-Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).
-
-~~~
-
- -?, --help, -h
- Prints out the help menu.
-
- -d, --debug
- Debug - Show debug messaging.
-
- -v, --verbose
- Verbose - Show verbose messaging. Very verbose messaging, avoid using
- under normal circumstances.
-
- --trace
- Trace - Show trace messaging. Very, very verbose trace messaging. Avoid
- except when needing super low-level .NET Framework debugging. Available
- in 0.10.4+.
-
- --nocolor, --no-color
- No Color - Do not show colorization in logging output. This overrides
- the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
-
- --acceptlicense, --accept-license
- AcceptLicense - Accept license dialogs automatically. Reserved for
- future use.
-
- -y, --yes, --confirm
- Confirm all prompts - Chooses affirmative answer instead of prompting.
- Implies --accept-license
-
- -f, --force
- Force - force the behavior. Do not use force during normal operation -
- it subverts some of the smart behavior for commands.
-
- --noop, --whatif, --what-if
- NoOp / WhatIf - Don't actually do anything.
-
- -r, --limitoutput, --limit-output
- LimitOutput - Limit the output to essential information
-
- --timeout, --execution-timeout=VALUE
- CommandExecutionTimeout (in seconds) - The time to allow a command to
- finish before timing out. Overrides the default execution timeout in the
- configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
-
- -c, --cache, --cachelocation, --cache-location=VALUE
- CacheLocation - Location for download cache, defaults to %TEMP% or value
- in chocolatey.config file.
-
- --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
- AllowUnofficialBuild - When not using the official build you must set
- this flag for choco to continue.
-
- --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
- FailOnStandardError - Fail on standard error output (stderr), typically
- received when running external commands during install providers. This
- overrides the feature failOnStandardError.
-
- --use-system-powershell
- UseSystemPowerShell - Execute PowerShell using an external process
- instead of the built-in PowerShell host. Should only be used when
- internal host is failing. Available in 0.9.10+.
-
- --no-progress
- Do Not Show Progress - Do not show download progress percentages.
- Available in 0.10.4+.
-
- --proxy=VALUE
- Proxy Location - Explicit proxy location. Overrides the default proxy
- location of ''. Available for config settings in 0.9.9.9+, this CLI
- option available in 0.10.4+.
-
- --proxy-user=VALUE
- Proxy User Name - Explicit proxy user (optional). Requires explicity
- proxy (`--proxy` or config setting). Overrides the default proxy user of
- '123'. Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-password=VALUE
- Proxy Password - Explicit proxy password (optional) to be used with
- username. Requires explicity proxy (`--proxy` or config setting) and
- user name. Overrides the default proxy password (encrypted in settings
- if set). Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-bypass-list=VALUE
- ProxyBypassList - Comma separated list of regex locations to bypass on
- proxy. Requires explicity proxy (`--proxy` or config setting). Overrides
- the default proxy bypass list of ''. Available in 0.10.4+.
-
- --proxy-bypass-on-local
- Proxy Bypass On Local - Bypass proxy for local connections. Requires
- explicity proxy (`--proxy` or config setting). Overrides the default
- proxy bypass on local setting of 'True'. Available in 0.10.4+.
-
- --log-file=VALUE
- Log File to output to in addition to regular loggers. Available in 0.1-
- 0.8+.
-
- -a, --auto, --automaticpackage
- AutomaticPackage - Generate automatic package instead of normal.
- Defaults to false
-
- -t, --template, --template-name=VALUE
- TemplateName - Use a named template in
- C:\ProgramData\chocolatey\templates\templatename instead of built-in
- template. Available in 0.9.9.9+. Manage templates as packages in 0.9.10+.
-
- --name=VALUE
- Name [Required]- the name of the package. Can be passed as first
- parameter without "--name=".
-
- --version=VALUE
- Version - the version of the package. Can also be passed as the property
- PackageVersion=somevalue
-
- --maintainer=VALUE
- Maintainer - the name of the maintainer. Can also be passed as the
- property MaintainerName=somevalue
-
- --out, --outdir, --outputdirectory, --output-directory=VALUE
- OutputDirectory - Specifies the directory for the created Chocolatey
- package file. If not specified, uses the current directory. Available in
- 0.9.10+.
-
- --built-in, --built-in-template, --originaltemplate, --original-template, --use-original-template, --use-built-in-template
- BuiltInTemplate - Use the original built-in template instead of any
- override. Available in 0.9.10+.
-
- --file, --url=VALUE
- Location of binary. In [Chocolatey for Business](https://chocolatey.org/compare), file is used for auto-
- detection (native installer, zip, patch/upgrade file, or remote url to
- download first) to completely create a package with proper silent
- arguments! Can be 32-bit or 64-bit architecture. Available in licensed
- editions only (licensed version 1.4.0+, url/zip starting in 1.6.0). See
- https://chocolatey.org/docs/features-create-packages-from-installers
-
- --file64, --url64=VALUE
- Optional - used when specifying both a 32-bit and a 64-bit file. Can be
- an installer or a zip, or remote url to download. Available in licensed
- editions only (licensed version 1.6.0+).
-
- --keepremote, --keep-remote, --originallocation, --original-location, --useoriginallocation, --use-original-location, --useoriginalfileslocation, --use-original-files-location
- Use Original Files Location - when using file or url, use the original
- location in packaging. Available in [licensed editions](https://chocolatey.org/compare) only (licensed
- version 1.6.0+).
-
- --checksum, --downloadchecksum, --download-checksum=VALUE
- Download Checksum - checksum to verify File/Url with. Defaults to empty.
- Available in [licensed editions](https://chocolatey.org/compare) only (licensed version 1.7.0+).
-
- --checksum64, --checksumx64, --downloadchecksumx64, --download-checksum-x64=VALUE
- Download Checksum 64-bit - checksum to verify File64/Url64 with.
- Defaults to empty. Available in [licensed editions](https://chocolatey.org/compare) only (licensed version
- 1.7.0+).
-
- --checksumtype, --checksum-type, --downloadchecksumtype, --download-checksum-type=VALUE
- Download Checksum Type - checksum type for File/Url (and optional
- separate 64-bit files when specifying both). Used in conjunction with
- Download Checksum and Download Checksum 64-bit. Available values are
- 'md5', 'sha1', 'sha256' or 'sha512'. Defaults to 'sha256'. Available in
- Business editions only (licensed version 1.7.0+).
-
- --pauseonerror, --pause-on-error
- Pause on Error - Pause when there is an error with creating the package.
- Available in [licensed editions](https://chocolatey.org/compare) only (licensed version 1.7.0+).
-
- --buildpackage, --build-package, --build-packages
- Build Package - Attempt to compile the package after creating it.
- Available in [licensed editions](https://chocolatey.org/compare) only (licensed version 1.7.0+).
-
- --fromprograms, --from-programs, --fromprogramsandfeatures, --from-programs-and-features
- Generate Packages From Installed Software - Generate packages from the
- installed software on a system (does not handle dependencies). Available
- in Business editions only (licensed version 1.8.0+).
-
- --for-public, --for-community, --generate-for-community
- Generate the Package for Community - Generate the package for community
- use. Available in Business editions only (licensed version 1.9.0+).
-
- --removearchitecture, --removearchitecturefromname, --remove-architecture, --remove-architecture-from-name
- Remove Architecture From Name - Remove x86, x64, 64-bit, etc from the
- package id. Default setting is to remove architecture. Available in
- Business editions only (licensed version 1.8.0+).
-
- --includearchitecture, --includearchitectureinname, --include-architecture, --include-architecture-in-name
- Include Architecture in Package Name - Leave x86, x64, 64-bit, etc as
- part of the package id. Default setting is to remove architecture.
- Available in Business editions only (licensed version 1.8.0+).
-
-~~~
-
-[[Command Reference|CommandsReference]]
-
-
-***NOTE:*** This documentation has been automatically generated from `choco new -h`.
-
diff --git a/docs/generated/CommandsOptimize.md b/docs/generated/CommandsOptimize.md
deleted file mode 100644
index 2142e2479f..0000000000
--- a/docs/generated/CommandsOptimize.md
+++ /dev/null
@@ -1,164 +0,0 @@
-
-
-# Optimize Command (choco optimize)
-
-### Package Optimizer
-
-Chocolatey [Licensed editions](https://chocolatey.org/compare) starting at Chocolatey Licensed Extension v1.12.0.
-
-Similar to Package Reducer, but reduces for existing packages.
-With Package Optimizer/Reducer:
-
-* nupkg file is reduced to 5KB or less, no matter the size.
-* zips / installers are automatically removed from the package directory if they are found.
-* zips / installers are removed from TEMP cache if found.
-
-The following file extensions are removed automatically:
-
-* 7z / zip / rar / gz / tar / sfx
-* iso
-* msi / msu / msp
-* exe files if they are detected to be an installer
-
-
-
-## Usage
-
- choco optimize []
-
-## Examples
-
- choco optimize
- choco optimize --reduce-nupkg-only
-
-
-## See It In Action
-
-Coming soon
-
-## Options and Switches
-
-**NOTE:** Options and switches apply to all items passed, so if you are
- running a command like install that allows installing multiple
- packages, and you use `--version=1.0.0`, it is going to look for and
- try to install version 1.0.0 of every package passed. So please split
- out multiple package calls when wanting to pass specific options.
-
-Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).
-
-~~~
-
- downloading multiple packages, and you use `--version=1.0.0`, it is
- going to look for and try to download version 1.0.0 of every package
-
-
- -?, --help, -h
- Prints out the help menu.
-
- -d, --debug
- Debug - Show debug messaging.
-
- -v, --verbose
- Verbose - Show verbose messaging. Very verbose messaging, avoid using
- under normal circumstances.
-
- --trace
- Trace - Show trace messaging. Very, very verbose trace messaging. Avoid
- except when needing super low-level .NET Framework debugging. Available
- in 0.10.4+.
-
- --nocolor, --no-color
- No Color - Do not show colorization in logging output. This overrides
- the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
-
- --acceptlicense, --accept-license
- AcceptLicense - Accept license dialogs automatically. Reserved for
- future use.
-
- -y, --yes, --confirm
- Confirm all prompts - Chooses affirmative answer instead of prompting.
- Implies --accept-license
-
- -f, --force
- Force - force the behavior. Do not use force during normal operation -
- it subverts some of the smart behavior for commands.
-
- --noop, --whatif, --what-if
- NoOp / WhatIf - Don't actually do anything.
-
- -r, --limitoutput, --limit-output
- LimitOutput - Limit the output to essential information
-
- --timeout, --execution-timeout=VALUE
- CommandExecutionTimeout (in seconds) - The time to allow a command to
- finish before timing out. Overrides the default execution timeout in the
- configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
-
- -c, --cache, --cachelocation, --cache-location=VALUE
- CacheLocation - Location for download cache, defaults to %TEMP% or value
- in chocolatey.config file.
-
- --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
- AllowUnofficialBuild - When not using the official build you must set
- this flag for choco to continue.
-
- --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
- FailOnStandardError - Fail on standard error output (stderr), typically
- received when running external commands during install providers. This
- overrides the feature failOnStandardError.
-
- --use-system-powershell
- UseSystemPowerShell - Execute PowerShell using an external process
- instead of the built-in PowerShell host. Should only be used when
- internal host is failing. Available in 0.9.10+.
-
- --no-progress
- Do Not Show Progress - Do not show download progress percentages.
- Available in 0.10.4+.
-
- --proxy=VALUE
- Proxy Location - Explicit proxy location. Overrides the default proxy
- location of ''. Available for config settings in 0.9.9.9+, this CLI
- option available in 0.10.4+.
-
- --proxy-user=VALUE
- Proxy User Name - Explicit proxy user (optional). Requires explicity
- proxy (`--proxy` or config setting). Overrides the default proxy user of
- '123'. Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-password=VALUE
- Proxy Password - Explicit proxy password (optional) to be used with
- username. Requires explicity proxy (`--proxy` or config setting) and
- user name. Overrides the default proxy password (encrypted in settings
- if set). Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-bypass-list=VALUE
- ProxyBypassList - Comma separated list of regex locations to bypass on
- proxy. Requires explicity proxy (`--proxy` or config setting). Overrides
- the default proxy bypass list of ''. Available in 0.10.4+.
-
- --proxy-bypass-on-local
- Proxy Bypass On Local - Bypass proxy for local connections. Requires
- explicity proxy (`--proxy` or config setting). Overrides the default
- proxy bypass on local setting of 'True'. Available in 0.10.4+.
-
- --log-file=VALUE
- Log File to output to in addition to regular loggers. Available in 0.1-
- 0.8+.
-
- --reduce-nupkg-only, --deflate-nupkg-only
- Reduce Only Nupkg File Size - reduce only the size of nupkg file when
- using Package Optimizer. [Licensed editions](https://chocolatey.org/compare) only (version 1.12.0+).
-
- --id=VALUE
- Id - The package to optimize
-
-~~~
-
-[[Command Reference|CommandsReference]]
-
-
-***NOTE:*** This documentation has been automatically generated from `choco optimize -h`.
-
diff --git a/docs/generated/CommandsOutdated.md b/docs/generated/CommandsOutdated.md
deleted file mode 100644
index 4ef0b540a2..0000000000
--- a/docs/generated/CommandsOutdated.md
+++ /dev/null
@@ -1,199 +0,0 @@
-
-
-# Outdated Command (choco outdated)
-
-Returns a list of outdated packages.
-
-**NOTE:** Available with 0.9.9.6+.
-
-
-## Usage
-
- choco outdated []
-
-## Examples
-
- choco outdated
- choco outdated -s https://somewhere/out/there
- choco outdated -s "'https://somewhere/protected'" -u user -p pass
-
-If you use `--source=https://somewhere/out/there`, it is
- going to look for outdated packages only based on that source, so
- you may want to add `--ignore-unfound` to your options.
-
-**NOTE:** See scripting in [[how to pass arguments|CommandsReference#how-to-pass-options--switches]] (`choco -?`) for how to
- write proper scripts and integrations.
-
-
-## Exit Codes
-
-Exit codes that normally result from running this command.
-
-Normal:
- - 0: operation was successful, no issues detected
- - -1 or 1: an error has occurred
-
-Enhanced:
- - 0: no outdated packages
- - -1 or 1: an error has occurred
- - 2: outdated packages have been found
-
-**NOTE:** Starting in v0.10.12, if you have the feature 'useEnhancedExitCodes'
- turned on, then choco will provide enhanced exit codes that allow
- better integration and scripting.
-
-If you find other exit codes that we have not yet documented, please
- file a ticket so we can document it at
- https://github.com/chocolatey/choco/issues/new/choose.
-
-
-## See It In Action
-
-
-
-
-## Options and Switches
-
-**NOTE:** Options and switches apply to all items passed, so if you are
- running a command like install that allows installing multiple
- packages, and you use `--version=1.0.0`, it is going to look for and
- try to install version 1.0.0 of every package passed. So please split
- out multiple package calls when wanting to pass specific options.
-
-Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).
-
-~~~
-
- -?, --help, -h
- Prints out the help menu.
-
- -d, --debug
- Debug - Show debug messaging.
-
- -v, --verbose
- Verbose - Show verbose messaging. Very verbose messaging, avoid using
- under normal circumstances.
-
- --trace
- Trace - Show trace messaging. Very, very verbose trace messaging. Avoid
- except when needing super low-level .NET Framework debugging. Available
- in 0.10.4+.
-
- --nocolor, --no-color
- No Color - Do not show colorization in logging output. This overrides
- the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
-
- --acceptlicense, --accept-license
- AcceptLicense - Accept license dialogs automatically. Reserved for
- future use.
-
- -y, --yes, --confirm
- Confirm all prompts - Chooses affirmative answer instead of prompting.
- Implies --accept-license
-
- -f, --force
- Force - force the behavior. Do not use force during normal operation -
- it subverts some of the smart behavior for commands.
-
- --noop, --whatif, --what-if
- NoOp / WhatIf - Don't actually do anything.
-
- -r, --limitoutput, --limit-output
- LimitOutput - Limit the output to essential information
-
- --timeout, --execution-timeout=VALUE
- CommandExecutionTimeout (in seconds) - The time to allow a command to
- finish before timing out. Overrides the default execution timeout in the
- configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
-
- -c, --cache, --cachelocation, --cache-location=VALUE
- CacheLocation - Location for download cache, defaults to %TEMP% or value
- in chocolatey.config file.
-
- --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
- AllowUnofficialBuild - When not using the official build you must set
- this flag for choco to continue.
-
- --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
- FailOnStandardError - Fail on standard error output (stderr), typically
- received when running external commands during install providers. This
- overrides the feature failOnStandardError.
-
- --use-system-powershell
- UseSystemPowerShell - Execute PowerShell using an external process
- instead of the built-in PowerShell host. Should only be used when
- internal host is failing. Available in 0.9.10+.
-
- --no-progress
- Do Not Show Progress - Do not show download progress percentages.
- Available in 0.10.4+.
-
- --proxy=VALUE
- Proxy Location - Explicit proxy location. Overrides the default proxy
- location of ''. Available for config settings in 0.9.9.9+, this CLI
- option available in 0.10.4+.
-
- --proxy-user=VALUE
- Proxy User Name - Explicit proxy user (optional). Requires explicity
- proxy (`--proxy` or config setting). Overrides the default proxy user of
- '123'. Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-password=VALUE
- Proxy Password - Explicit proxy password (optional) to be used with
- username. Requires explicity proxy (`--proxy` or config setting) and
- user name. Overrides the default proxy password (encrypted in settings
- if set). Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-bypass-list=VALUE
- ProxyBypassList - Comma separated list of regex locations to bypass on
- proxy. Requires explicity proxy (`--proxy` or config setting). Overrides
- the default proxy bypass list of ''. Available in 0.10.4+.
-
- --proxy-bypass-on-local
- Proxy Bypass On Local - Bypass proxy for local connections. Requires
- explicity proxy (`--proxy` or config setting). Overrides the default
- proxy bypass on local setting of 'True'. Available in 0.10.4+.
-
- --log-file=VALUE
- Log File to output to in addition to regular loggers. Available in 0.1-
- 0.8+.
-
- -s, --source=VALUE
- Source - The source to find the package(s) to install. Special sources
- include: ruby, webpi, cygwin, windowsfeatures, and python. To specify
- more than one source, pass it with a semi-colon separating the values (-
- e.g. "'source1;source2'"). Defaults to default feeds.
-
- -u, --user=VALUE
- User - used with authenticated feeds. Defaults to empty.
-
- -p, --password=VALUE
- Password - the user's password to the source. Defaults to empty.
-
- --cert=VALUE
- Client certificate - PFX pathname for an x509 authenticated feeds.
- Defaults to empty. Available in 0.9.10+.
-
- --cp, --certpassword=VALUE
- Certificate Password - the client certificate's password to the source.
- Defaults to empty. Available in 0.9.10+.
-
- --ignore-pinned
- Ignore Pinned - Ignore pinned packages. Defaults to false. Available in
- 0.10.6+.
-
- --ignore-unfound
- Ignore Unfound Packages - Ignore packages that are not found on the
- sources used (or the defaults). Overrides the default feature
- 'ignoreUnfoundPackagesOnUpgradeOutdated' set to 'False'. Available in -
- 0.10.9+.
-
-~~~
-
-[[Command Reference|CommandsReference]]
-
-
-***NOTE:*** This documentation has been automatically generated from `choco outdated -h`.
-
diff --git a/docs/generated/CommandsPack.md b/docs/generated/CommandsPack.md
deleted file mode 100644
index 27a367ec3c..0000000000
--- a/docs/generated/CommandsPack.md
+++ /dev/null
@@ -1,170 +0,0 @@
-
-
-# Pack Command (choco pack)
-
-Chocolatey will attempt to package a nuspec into a compiled nupkg. Some
- may prefer to use `cpack` as a shortcut for `choco pack`.
-
-**NOTE:** 100% compatible with older chocolatey client (0.9.8.32 and below)
- with options and switches. In most cases you can still pass options
- and switches with one dash (`-`). For more details, see
- [[how to pass arguments|CommandsReference#how-to-pass-options--switches]] (`choco -?`).
-
-**NOTE:** You can pass arbitrary property value pairs through to nuspecs.
- These will replace variables formatted as `$property$` with the value passed.
-
-**NOTE:** `cpack` has been deprecated as it has a name collision with CMake. Please
- use `choco pack` instead. The shortcut will be removed in v1.
-
-
-## Usage
-
- choco pack [] [] []
- cpack [] [] (DEPRECATED)
-
-## Examples
-
- choco pack
- choco pack --version 1.2.3 configuration=release
- choco pack path/to/nuspec
- choco pack --outputdirectory build
-
-**NOTE:** See scripting in [[how to pass arguments|CommandsReference#how-to-pass-options--switches]] (`choco -?`) for how to
- write proper scripts and integrations.
-
-
-## Exit Codes
-
-Exit codes that normally result from running this command.
-
-Normal:
- - 0: operation was successful, no issues detected
- - -1 or 1: an error has occurred
-
-If you find other exit codes that we have not yet documented, please
- file a ticket so we can document it at
- https://github.com/chocolatey/choco/issues/new/choose.
-
-
-## Options and Switches
-
-**NOTE:** Options and switches apply to all items passed, so if you are
- running a command like install that allows installing multiple
- packages, and you use `--version=1.0.0`, it is going to look for and
- try to install version 1.0.0 of every package passed. So please split
- out multiple package calls when wanting to pass specific options.
-
-Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).
-
-~~~
-
- -?, --help, -h
- Prints out the help menu.
-
- -d, --debug
- Debug - Show debug messaging.
-
- -v, --verbose
- Verbose - Show verbose messaging. Very verbose messaging, avoid using
- under normal circumstances.
-
- --trace
- Trace - Show trace messaging. Very, very verbose trace messaging. Avoid
- except when needing super low-level .NET Framework debugging. Available
- in 0.10.4+.
-
- --nocolor, --no-color
- No Color - Do not show colorization in logging output. This overrides
- the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
-
- --acceptlicense, --accept-license
- AcceptLicense - Accept license dialogs automatically. Reserved for
- future use.
-
- -y, --yes, --confirm
- Confirm all prompts - Chooses affirmative answer instead of prompting.
- Implies --accept-license
-
- -f, --force
- Force - force the behavior. Do not use force during normal operation -
- it subverts some of the smart behavior for commands.
-
- --noop, --whatif, --what-if
- NoOp / WhatIf - Don't actually do anything.
-
- -r, --limitoutput, --limit-output
- LimitOutput - Limit the output to essential information
-
- --timeout, --execution-timeout=VALUE
- CommandExecutionTimeout (in seconds) - The time to allow a command to
- finish before timing out. Overrides the default execution timeout in the
- configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
-
- -c, --cache, --cachelocation, --cache-location=VALUE
- CacheLocation - Location for download cache, defaults to %TEMP% or value
- in chocolatey.config file.
-
- --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
- AllowUnofficialBuild - When not using the official build you must set
- this flag for choco to continue.
-
- --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
- FailOnStandardError - Fail on standard error output (stderr), typically
- received when running external commands during install providers. This
- overrides the feature failOnStandardError.
-
- --use-system-powershell
- UseSystemPowerShell - Execute PowerShell using an external process
- instead of the built-in PowerShell host. Should only be used when
- internal host is failing. Available in 0.9.10+.
-
- --no-progress
- Do Not Show Progress - Do not show download progress percentages.
- Available in 0.10.4+.
-
- --proxy=VALUE
- Proxy Location - Explicit proxy location. Overrides the default proxy
- location of ''. Available for config settings in 0.9.9.9+, this CLI
- option available in 0.10.4+.
-
- --proxy-user=VALUE
- Proxy User Name - Explicit proxy user (optional). Requires explicity
- proxy (`--proxy` or config setting). Overrides the default proxy user of
- '123'. Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-password=VALUE
- Proxy Password - Explicit proxy password (optional) to be used with
- username. Requires explicity proxy (`--proxy` or config setting) and
- user name. Overrides the default proxy password (encrypted in settings
- if set). Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-bypass-list=VALUE
- ProxyBypassList - Comma separated list of regex locations to bypass on
- proxy. Requires explicity proxy (`--proxy` or config setting). Overrides
- the default proxy bypass list of ''. Available in 0.10.4+.
-
- --proxy-bypass-on-local
- Proxy Bypass On Local - Bypass proxy for local connections. Requires
- explicity proxy (`--proxy` or config setting). Overrides the default
- proxy bypass on local setting of 'True'. Available in 0.10.4+.
-
- --log-file=VALUE
- Log File to output to in addition to regular loggers. Available in 0.1-
- 0.8+.
-
- --version=VALUE
- Version - The version you would like to insert into the package.
-
- --out, --outdir, --outputdirectory, --output-directory=VALUE
- OutputDirectory - Specifies the directory for the created Chocolatey
- package file. If not specified, uses the current directory.
-
-~~~
-
-[[Command Reference|CommandsReference]]
-
-
-***NOTE:*** This documentation has been automatically generated from `choco pack -h`.
-
diff --git a/docs/generated/CommandsPin.md b/docs/generated/CommandsPin.md
deleted file mode 100644
index d2dc4839ea..0000000000
--- a/docs/generated/CommandsPin.md
+++ /dev/null
@@ -1,166 +0,0 @@
-
-
-# Pin Command (choco pin)
-
-Pin a package to suppress upgrades.
-
-This is especially helpful when running [[`choco upgrade`|Commandsupgrade]] for all
- packages, as it will automatically skip those packages. Another
- alternative is `choco upgrade --except="pkg1,pk2"`.
-
-## Usage
-
- choco pin [list]|add|remove []
-
-## Examples
-
- choco pin
- choco pin list
- choco pin add -n=git
- choco pin add -n=git --version 1.2.3
- choco pin remove --name git
-
-**NOTE:** See scripting in [[how to pass arguments|CommandsReference#how-to-pass-options--switches]] (`choco -?`) for how to
- write proper scripts and integrations.
-
-
-## Exit Codes
-
-Exit codes that normally result from running this command.
-
-Normal:
- - 0: operation was successful, no issues detected
- - -1 or 1: an error has occurred
-
-If you find other exit codes that we have not yet documented, please
- file a ticket so we can document it at
- https://github.com/chocolatey/choco/issues/new/choose.
-
-
-## Options and Switches
-
-**NOTE:** Options and switches apply to all items passed, so if you are
- running a command like install that allows installing multiple
- packages, and you use `--version=1.0.0`, it is going to look for and
- try to install version 1.0.0 of every package passed. So please split
- out multiple package calls when wanting to pass specific options.
-
-Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).
-
-~~~
-
- -?, --help, -h
- Prints out the help menu.
-
- -d, --debug
- Debug - Show debug messaging.
-
- -v, --verbose
- Verbose - Show verbose messaging. Very verbose messaging, avoid using
- under normal circumstances.
-
- --trace
- Trace - Show trace messaging. Very, very verbose trace messaging. Avoid
- except when needing super low-level .NET Framework debugging. Available
- in 0.10.4+.
-
- --nocolor, --no-color
- No Color - Do not show colorization in logging output. This overrides
- the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
-
- --acceptlicense, --accept-license
- AcceptLicense - Accept license dialogs automatically. Reserved for
- future use.
-
- -y, --yes, --confirm
- Confirm all prompts - Chooses affirmative answer instead of prompting.
- Implies --accept-license
-
- -f, --force
- Force - force the behavior. Do not use force during normal operation -
- it subverts some of the smart behavior for commands.
-
- --noop, --whatif, --what-if
- NoOp / WhatIf - Don't actually do anything.
-
- -r, --limitoutput, --limit-output
- LimitOutput - Limit the output to essential information
-
- --timeout, --execution-timeout=VALUE
- CommandExecutionTimeout (in seconds) - The time to allow a command to
- finish before timing out. Overrides the default execution timeout in the
- configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
-
- -c, --cache, --cachelocation, --cache-location=VALUE
- CacheLocation - Location for download cache, defaults to %TEMP% or value
- in chocolatey.config file.
-
- --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
- AllowUnofficialBuild - When not using the official build you must set
- this flag for choco to continue.
-
- --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
- FailOnStandardError - Fail on standard error output (stderr), typically
- received when running external commands during install providers. This
- overrides the feature failOnStandardError.
-
- --use-system-powershell
- UseSystemPowerShell - Execute PowerShell using an external process
- instead of the built-in PowerShell host. Should only be used when
- internal host is failing. Available in 0.9.10+.
-
- --no-progress
- Do Not Show Progress - Do not show download progress percentages.
- Available in 0.10.4+.
-
- --proxy=VALUE
- Proxy Location - Explicit proxy location. Overrides the default proxy
- location of ''. Available for config settings in 0.9.9.9+, this CLI
- option available in 0.10.4+.
-
- --proxy-user=VALUE
- Proxy User Name - Explicit proxy user (optional). Requires explicity
- proxy (`--proxy` or config setting). Overrides the default proxy user of
- '123'. Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-password=VALUE
- Proxy Password - Explicit proxy password (optional) to be used with
- username. Requires explicity proxy (`--proxy` or config setting) and
- user name. Overrides the default proxy password (encrypted in settings
- if set). Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-bypass-list=VALUE
- ProxyBypassList - Comma separated list of regex locations to bypass on
- proxy. Requires explicity proxy (`--proxy` or config setting). Overrides
- the default proxy bypass list of ''. Available in 0.10.4+.
-
- --proxy-bypass-on-local
- Proxy Bypass On Local - Bypass proxy for local connections. Requires
- explicity proxy (`--proxy` or config setting). Overrides the default
- proxy bypass on local setting of 'True'. Available in 0.10.4+.
-
- --log-file=VALUE
- Log File to output to in addition to regular loggers. Available in 0.1-
- 0.8+.
-
- -n, --name=VALUE
- Name - the name of the package. Required with some actions. Defaults to
- empty.
-
- --version=VALUE
- Version - Used when multiple versions of a package are installed.
- Defaults to empty.
-
- --reason, --pin-reason, --note=VALUE
- Pin Reason - Text information about why you are setting a pin. Available
- in business editions 1.12.2+.
-
-~~~
-
-[[Command Reference|CommandsReference]]
-
-
-***NOTE:*** This documentation has been automatically generated from `choco pin -h`.
-
diff --git a/docs/generated/CommandsPush.md b/docs/generated/CommandsPush.md
deleted file mode 100644
index eec789429d..0000000000
--- a/docs/generated/CommandsPush.md
+++ /dev/null
@@ -1,194 +0,0 @@
-
-
-# Push Command (choco push)
-
-Chocolatey will attempt to push a compiled nupkg to a package feed.
- Some may prefer to use `cpush` as a shortcut for `choco push`.
-
-**NOTE:** 100% compatible with older chocolatey client (0.9.8.32 and below)
- with options and switches. Default push location is deprecated and
- will be removed by v1. In most cases you can still pass options and
- switches with one dash (`-`). For more details, see
- [[how to pass arguments|CommandsReference#how-to-pass-options--switches]] (`choco -?`).
-
-A feed can be a local folder, a file share, the [community feed](https://chocolatey.org/packages)
- (https://push.chocolatey.org/), or a custom/private feed. For web
- feeds, it has a requirement that it implements the proper OData
- endpoints required for NuGet packages.
-
-## Usage
-
- choco push [] []
- cpush [] []
-
-**NOTE:** If there is more than one nupkg file in the folder, the command
- will require specifying the path to the file.
-
-## Examples
-
- choco push --source https://chocolatey.org/
- choco push --source "'https://chocolatey.org/'" -t 500
- choco push --source "'https://chocolatey.org/'" -k="'123-123123-123'"
-
-**NOTE:** See scripting in [[how to pass arguments|CommandsReference#how-to-pass-options--switches]] (`choco -?`) for how to
- write proper scripts and integrations.
-
-
-## Troubleshooting
-
-To use this command, you must have your API key saved for the community
- feed (chocolatey.org) or the source you want to push to. Or you can
- explicitly pass the apikey to the command. See [[`apikey`|Commandsapikey]] command help
- for instructions on saving your key:
-
- choco apikey -?
-
-A common error is `Failed to process request. 'The specified API key
- does not provide the authority to push packages.' The remote server
- returned an error: (403) Forbidden..` This means the package already
- exists with a different user (API key). The package could be unlisted.
- You can verify by going to https://push.chocolatey.org/packages/packageName.
- Please contact the administrators of https://push.chocolatey.org/ if you see this
- and you don't see a good reason for it.
-
-## Exit Codes
-
-Exit codes that normally result from running this command.
-
-Normal:
- - 0: operation was successful, no issues detected
- - -1 or 1: an error has occurred
-
-If you find other exit codes that we have not yet documented, please
- file a ticket so we can document it at
- https://github.com/chocolatey/choco/issues/new/choose.
-
-
-## Options and Switches
-
-**NOTE:** Options and switches apply to all items passed, so if you are
- running a command like install that allows installing multiple
- packages, and you use `--version=1.0.0`, it is going to look for and
- try to install version 1.0.0 of every package passed. So please split
- out multiple package calls when wanting to pass specific options.
-
-Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).
-
-~~~
-
- -?, --help, -h
- Prints out the help menu.
-
- -d, --debug
- Debug - Show debug messaging.
-
- -v, --verbose
- Verbose - Show verbose messaging. Very verbose messaging, avoid using
- under normal circumstances.
-
- --trace
- Trace - Show trace messaging. Very, very verbose trace messaging. Avoid
- except when needing super low-level .NET Framework debugging. Available
- in 0.10.4+.
-
- --nocolor, --no-color
- No Color - Do not show colorization in logging output. This overrides
- the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
-
- --acceptlicense, --accept-license
- AcceptLicense - Accept license dialogs automatically. Reserved for
- future use.
-
- -y, --yes, --confirm
- Confirm all prompts - Chooses affirmative answer instead of prompting.
- Implies --accept-license
-
- -f, --force
- Force - force the behavior. Do not use force during normal operation -
- it subverts some of the smart behavior for commands.
-
- --noop, --whatif, --what-if
- NoOp / WhatIf - Don't actually do anything.
-
- -r, --limitoutput, --limit-output
- LimitOutput - Limit the output to essential information
-
- --timeout, --execution-timeout=VALUE
- CommandExecutionTimeout (in seconds) - The time to allow a command to
- finish before timing out. Overrides the default execution timeout in the
- configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
-
- -c, --cache, --cachelocation, --cache-location=VALUE
- CacheLocation - Location for download cache, defaults to %TEMP% or value
- in chocolatey.config file.
-
- --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
- AllowUnofficialBuild - When not using the official build you must set
- this flag for choco to continue.
-
- --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
- FailOnStandardError - Fail on standard error output (stderr), typically
- received when running external commands during install providers. This
- overrides the feature failOnStandardError.
-
- --use-system-powershell
- UseSystemPowerShell - Execute PowerShell using an external process
- instead of the built-in PowerShell host. Should only be used when
- internal host is failing. Available in 0.9.10+.
-
- --no-progress
- Do Not Show Progress - Do not show download progress percentages.
- Available in 0.10.4+.
-
- --proxy=VALUE
- Proxy Location - Explicit proxy location. Overrides the default proxy
- location of ''. Available for config settings in 0.9.9.9+, this CLI
- option available in 0.10.4+.
-
- --proxy-user=VALUE
- Proxy User Name - Explicit proxy user (optional). Requires explicity
- proxy (`--proxy` or config setting). Overrides the default proxy user of
- '123'. Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-password=VALUE
- Proxy Password - Explicit proxy password (optional) to be used with
- username. Requires explicity proxy (`--proxy` or config setting) and
- user name. Overrides the default proxy password (encrypted in settings
- if set). Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-bypass-list=VALUE
- ProxyBypassList - Comma separated list of regex locations to bypass on
- proxy. Requires explicity proxy (`--proxy` or config setting). Overrides
- the default proxy bypass list of ''. Available in 0.10.4+.
-
- --proxy-bypass-on-local
- Proxy Bypass On Local - Bypass proxy for local connections. Requires
- explicity proxy (`--proxy` or config setting). Overrides the default
- proxy bypass on local setting of 'True'. Available in 0.10.4+.
-
- --log-file=VALUE
- Log File to output to in addition to regular loggers. Available in 0.1-
- 0.8+.
-
- -s, --source=VALUE
- Source - The source we are pushing the package to. Use https://pus-
- h.chocolatey.org/ to push to [community feed](https://chocolatey.org/packages).
-
- -k, --key, --apikey, --api-key=VALUE
- ApiKey - The api key for the source. If not specified (and not local
- file source), does a lookup. If not specified and one is not found for
- an https source, push will fail.
-
- -t=VALUE
- Timeout (in seconds) - The time to allow a package push to occur before
- timing out. Defaults to execution timeout 2700.
-
-~~~
-
-[[Command Reference|CommandsReference]]
-
-
-***NOTE:*** This documentation has been automatically generated from `choco push -h`.
-
diff --git a/docs/generated/CommandsReference.md b/docs/generated/CommandsReference.md
deleted file mode 100644
index 5299d5b128..0000000000
--- a/docs/generated/CommandsReference.md
+++ /dev/null
@@ -1,303 +0,0 @@
-# Command Reference
-
-
-
-This is a listing of all of the different things you can pass to choco.
-
-## Commands
-
- * [[list|CommandsList]] - lists remote or local packages
- * [[search|CommandsSearch]] - searches remote or local packages (alias for list)
- * [[info|CommandsInfo]] - retrieves package information. Shorthand for choco search pkgname --exact --verbose
- * [[install|CommandsInstall]] - installs packages from various sources
- * [[pin|CommandsPin]] - suppress upgrades for a package
- * [[outdated|CommandsOutdated]] - retrieves packages that are outdated. Similar to upgrade all --noop
- * [[upgrade|CommandsUpgrade]] - upgrades packages from various sources
- * [[uninstall|CommandsUninstall]] - uninstalls a package
- * [[pack|CommandsPack]] - packages up a nuspec to a compiled nupkg
- * [[push|CommandsPush]] - pushes a compiled nupkg
- * [[new|CommandsNew]] - generates files necessary for a chocolatey package from a template
- * [[sources|CommandsSources]] - view and configure default sources (alias for source)
- * [[source|CommandsSource]] - view and configure default sources
- * [[config|CommandsConfig]] - Retrieve and configure config file settings
- * [[feature|CommandsFeature]] - view and configure choco features
- * [[features|CommandsFeatures]] - view and configure choco features (alias for feature)
- * [[setapikey|CommandsSetapikey]] - retrieves or saves an apikey for a particular source (alias for apikey)
- * [[apikey|CommandsApikey]] - retrieves or saves an apikey for a particular source
- * [[unpackself|CommandsUnpackself]] - have chocolatey set itself up
- * [[version|CommandsVersion]] - [DEPRECATED] will be removed in v1 - use [[`choco outdated`|Commandsoutdated]] or `cup -whatif` instead
- * [[update|CommandsUpdate]] - [DEPRECATED] RESERVED for future use (you are looking for upgrade, these are not the droids you are looking for)
- * [[support|CommandsSupport]] - provides support information
- * [[download|CommandsDownload]] - downloads packages - optionally internalizing all remote resources
- * [[synchronize|CommandsSynchronize]] - synchronizes against system installed software - generates missing packages
- * [[sync|CommandsSync]] - synchronizes against system installed software - generates missing packages
- * [[optimize|CommandsOptimize]] - optimizes installation, reducing space usage
-
-
-Please run chocolatey with `choco command -help` for specific help on
- each command.
-
-## How To Pass Options / Switches
-
-You can pass options and switches in the following ways:
-
- * Unless stated otherwise, an option/switch should only be passed one
- time. Otherwise you may find weird/non-supported behavior.
- * `-`, `/`, or `--` (one character switches should not use `--`)
- * **Option Bundling / Bundled Options**: One character switches can be
- bundled. e.g. `-d` (debug), `-f` (force), `-v` (verbose), and `-y`
- (confirm yes) can be bundled as `-dfvy`.
- * **NOTE:** If `debug` or `verbose` are bundled with local options
- (not the global ones above), some logging may not show up until after
- the local options are parsed.
- * **Use Equals**: You can also include or not include an equals sign
- `=` between options and values.
- * **Quote Values**: When you need to quote an entire argument, such as
- when using spaces, please use a combination of double quotes and
- apostrophes (`"'value'"`). In cmd.exe you can just use double quotes
- (`"value"`) but in powershell.exe you should use backticks
- (`` `"value`" ``) or apostrophes (`'value'`). Using the combination
- allows for both shells to work without issue, except for when the next
- section applies.
- * **Pass quotes in arguments**: When you need to pass quoted values to
- to something like a native installer, you are in for a world of fun. In
- cmd.exe you must pass it like this: `-ia "/yo=""Spaces spaces"""`. In
- PowerShell.exe, you must pass it like this: `-ia '/yo=""Spaces spaces""'`.
- No other combination will work. In PowerShell.exe if you are on version
- v3+, you can try `--%` before `-ia` to just pass the args through as is,
- which means it should not require any special workarounds.
- * **Periods in PowerShell**: If you need to pass a period as part of a
- value or a path, PowerShell doesn't always handle it well. Please
- quote those values using "Quote Values" section above.
- * Options and switches apply to all items passed, so if you are
- installing multiple packages, and you use `--version=1.0.0`, choco
- is going to look for and try to install version 1.0.0 of every
- package passed. So please split out multiple package calls when
- wanting to pass specific options.
-
-## Scripting / Integration - Best Practices / Style Guide
-
-When writing scripts, such as PowerShell scripts passing options and
-switches, there are some best practices to follow to ensure that you
-don't run into issues later. This also applies to integrations that
-are calling Chocolatey and parsing output. Chocolatey **uses**
-PowerShell, but it is an exe, so it cannot return PowerShell objects.
-
-Following these practices ensures both readability of your scripts AND
-compatibility across different versions and editions of Chocolatey.
-Following this guide will ensure your experience is not frustrating
-based on choco not receiving things you think you are passing to it.
-
- * For consistency, always use `choco`, not `choco.exe`. Never use
- shortcut commands like `cinst` or `cup`.
- * Always have the command as the first argument to `choco. e.g.
- [[`choco install`|Commandsinstall]], where [[`install`|Commandsinstall]] is the command.
- * If there is a subcommand, ensure that is the second argument. e.g.
- `choco source list`, where `source` is the command and [[`list`|Commandslist]] is the
- subcommand.
- * Typically the subject comes next. If installing packages, the
- subject would be the package names, e.g. `choco install pkg1 pkg2`.
- * Never use 'nupkg' or point directly to a nupkg file UNLESS using
- 'choco push'. Use the source folder instead, e.g. `choco install
- --source="'c:\folder\with\package'"` instead of
- `choco install DoNotDoThis.1.0.nupkg` or `choco install DoNotDoThis
- --source="'c:\folder\with\package\DoNotDoThis.1.0.nupkg'"`.
- * Switches and parameters are called simply options. Options come
- after the subject. e.g. `choco install pkg1 --debug --verbose`.
- * Never use the force option (`--force`/`-f`) in scripts (or really
- otherwise as a default mode of use). Force is an override on
- Chocolatey behavior. If you are wondering why Chocolatey isn't doing
- something like the documentation says it should, it's likely because
- you are using force. Stop.
- * Always use full option name. If the short option is `-n`, and the
- full option is `--name`, use `--name`. The only acceptable short
- option for use in scripts is `-y`. Find option names in help docs
- online or through `choco -?` /`choco [Command Name] -?`.
- * For scripts that are running automated, always use `-y`. Do note
- that even with `-y` passed, some things / state issues detected will
- temporarily stop for input - the key here is temporarily. They will
- continue without requiring any action after the temporary timeout
- (typically 30 seconds).
- * Full option names are prepended with two dashes, e.g. `--` or
- `--debug --verbose --ignore-proxy`.
- * When setting a value to an option, always put an equals (`=`)
- between the name and the setting, e.g. `--source="'local'"`.
- * When setting a value to an option, always surround the value
- properly with double quotes bookending apostrophes, e.g.
- `--source="'internal_server'"`.
- * If you are building PowerShell scripts, you can most likely just
- simply use apostrophes surrounding option values, e.g.
- `--source='internal_server'`.
- * Prefer upgrade to install in scripts. You can't [[`install`|Commandsinstall]] to a newer
- version of something, but you can [[`choco upgrade`|Commandsupgrade]] which will do both
- upgrade or install (unless switched off explicitly).
- * If you are sharing the script with others, pass `--source` to be
- explicit about where the package is coming from. Use full link and
- not source name ('https://chocolatey.org/api/v2' versus
- 'chocolatey').
- * If parsing output, you might want to use `--limit-output`/`-r` to
- get output in a more machine parseable format. **NOTE:** Not all
- commands handle return of information in an easily digestible
- output.
- * Use exit codes to determine status. Chocolatey exits with 0 when
- everything worked appropriately and other exits codes like 1 when
- things error. There are package specific exit codes that are
- recommended to be used and reboot indicating exit codes as well. To
- check exit code when using PowerShell, immediately call
- `$exitCode = $LASTEXITCODE` to get the value choco exited with.
-
-Here's an example following bad practices (line breaks added for
- readability):
-
- `choco install pkg1 -y -params '/Option:Value /Option2:value with
- spaces' --c4b-option 'Yaass' --option-that-is-new 'dude upgrade'`
-
-Now here is that example written with best practices (again line
- breaks added for readability - there are not line continuations
- for choco):
-
- `choco upgrade pkg1 -y --source="'https://chocolatey.org/api/v2'"
- --package-parameters="'/Option:Value /Option2:value with spaces'"
- --c4b-option="'Yaass'" --option-that-is-new="'dude upgrade'"`
-
-Note the differences between the two:
- * Which is more self-documenting?
- * Which will allow for the newest version of something installed or
- upgraded to (which allows for more environmental consistency on
- packages and versions)?
- * Which may throw an error on a badly passed option?
- * Which will throw errors on unknown option values? See explanation
- below.
-
-Chocolatey ignores options it doesn't understand, but it can only
- ignore option values if they are tied to the option with an
- equals sign ('='). Note those last two options in the examples above?
- If you roll off of a commercial edition or someone with older version
- attempts to run the badly crafted script `--c4b-option 'Yaass'
- --option-that-is-new 'dude upgrade'`, they are likely to see errors on
- 'Yaass' and 'dude upgrade' because they are not explicitly tied to the
- option they are written after. Now compare that to the other script.
- Choco will ignore `--c4b-option="'Yaass'"` and
- `--option-that-is-new="'dude upgrade'"` as a whole when it doesn't
- register the options. This means that your script doesn't error.
-
-Following these scripting best practices will ensure your scripts work
- everywhere they are used and with newer versions of Chocolatey.
-
-
-## See Help Menu In Action
-
-
-
-## Default Options and Switches
-
-**NOTE:** Options and switches apply to all items passed, so if you are
- running a command like install that allows installing multiple
- packages, and you use `--version=1.0.0`, it is going to look for and
- try to install version 1.0.0 of every package passed. So please split
- out multiple package calls when wanting to pass specific options.
-
-~~~
-
- -?, --help, -h
- Prints out the help menu.
-
- -d, --debug
- Debug - Show debug messaging.
-
- -v, --verbose
- Verbose - Show verbose messaging. Very verbose messaging, avoid using
- under normal circumstances.
-
- --trace
- Trace - Show trace messaging. Very, very verbose trace messaging. Avoid
- except when needing super low-level .NET Framework debugging. Available
- in 0.10.4+.
-
- --nocolor, --no-color
- No Color - Do not show colorization in logging output. This overrides
- the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
-
- --acceptlicense, --accept-license
- AcceptLicense - Accept license dialogs automatically. Reserved for
- future use.
-
- -y, --yes, --confirm
- Confirm all prompts - Chooses affirmative answer instead of prompting.
- Implies --accept-license
-
- -f, --force
- Force - force the behavior. Do not use force during normal operation -
- it subverts some of the smart behavior for commands.
-
- --noop, --whatif, --what-if
- NoOp / WhatIf - Don't actually do anything.
-
- -r, --limitoutput, --limit-output
- LimitOutput - Limit the output to essential information
-
- --timeout, --execution-timeout=VALUE
- CommandExecutionTimeout (in seconds) - The time to allow a command to
- finish before timing out. Overrides the default execution timeout in the
- configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
-
- -c, --cache, --cachelocation, --cache-location=VALUE
- CacheLocation - Location for download cache, defaults to %TEMP% or value
- in chocolatey.config file.
-
- --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
- AllowUnofficialBuild - When not using the official build you must set
- this flag for choco to continue.
-
- --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
- FailOnStandardError - Fail on standard error output (stderr), typically
- received when running external commands during install providers. This
- overrides the feature failOnStandardError.
-
- --use-system-powershell
- UseSystemPowerShell - Execute PowerShell using an external process
- instead of the built-in PowerShell host. Should only be used when
- internal host is failing. Available in 0.9.10+.
-
- --no-progress
- Do Not Show Progress - Do not show download progress percentages.
- Available in 0.10.4+.
-
- --proxy=VALUE
- Proxy Location - Explicit proxy location. Overrides the default proxy
- location of ''. Available for config settings in 0.9.9.9+, this CLI
- option available in 0.10.4+.
-
- --proxy-user=VALUE
- Proxy User Name - Explicit proxy user (optional). Requires explicity
- proxy (`--proxy` or config setting). Overrides the default proxy user of
- '123'. Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-password=VALUE
- Proxy Password - Explicit proxy password (optional) to be used with
- username. Requires explicity proxy (`--proxy` or config setting) and
- user name. Overrides the default proxy password (encrypted in settings
- if set). Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-bypass-list=VALUE
- ProxyBypassList - Comma separated list of regex locations to bypass on
- proxy. Requires explicity proxy (`--proxy` or config setting). Overrides
- the default proxy bypass list of ''. Available in 0.10.4+.
-
- --proxy-bypass-on-local
- Proxy Bypass On Local - Bypass proxy for local connections. Requires
- explicity proxy (`--proxy` or config setting). Overrides the default
- proxy bypass on local setting of 'True'. Available in 0.10.4+.
-
- --log-file=VALUE
- Log File to output to in addition to regular loggers. Available in 0.1-
- 0.8+.
-
-~~~
-
-
-
-***NOTE:*** This documentation has been automatically generated from `choco -h`.
-
diff --git a/docs/generated/CommandsSearch.md b/docs/generated/CommandsSearch.md
deleted file mode 100644
index 2b3f1120a8..0000000000
--- a/docs/generated/CommandsSearch.md
+++ /dev/null
@@ -1,278 +0,0 @@
-
-
-# List/Search Command (choco search)
-
-Chocolatey will perform a search for a package local or remote. Some
- may prefer to use [[`clist`|Commandslist]] as a shortcut for [[`choco list`|Commandslist]].
-
-**NOTE:** 100% compatible with older Chocolatey client (0.9.8.x and below)
- with options and switches. In most cases you can still pass options
- and switches with one dash (`-`). For more details, see
- [[how to pass arguments|CommandsReference#how-to-pass-options--switches]] (`choco -?`).
-
-## Usage
-
- choco search []
- choco list []
- clist []
-
-## Examples
-
- choco list --local-only
- choco list -li
- choco list -lai
- choco list --page=0 --page-size=25
- choco search git
- choco search git --source="'https://somewhere/out/there'"
- choco search bob -s "'https://somewhere/protected'" -u user -p pass
-
-**NOTE:** See scripting in [[how to pass arguments|CommandsReference#how-to-pass-options--switches]] (`choco -?`) for how to
- write proper scripts and integrations.
-
-
-## Exit Codes
-
-Exit codes that normally result from running this command.
-
-Normal:
- - 0: operation was successful, no issues detected
- - -1 or 1: an error has occurred
-
-Enhanced:
- - 0: operation was successful, no issues detected
- - -1 or 1: an error has occurred
- - 2: no results (enhanced)
-
-**NOTE:** Starting in v0.10.12, if you have the feature 'useEnhancedExitCodes'
- turned on, then choco will provide enhanced exit codes that allow
- better integration and scripting.
-
-If you find other exit codes that we have not yet documented, please
- file a ticket so we can document it at
- https://github.com/chocolatey/choco/issues/new/choose.
-
-
-## See It In Action
-
-
-
-
-## Alternative Sources
-
-Available in 0.9.10+.
-
-### WebPI
-This specifies the source is Web PI (Web Platform Installer) and that
- we are searching for a WebPI product, such as IISExpress. If you do
- not have the Web PI command line installed, it will install that first
- and then perform the search requested.
- e.g. `choco list --source webpi`
-
-### Windows Features
-This specifies that the source is a Windows Feature and we should
- install via the Deployment Image Servicing and Management tool (DISM)
- on the local machine.
- e.g. `choco list --source windowsfeatures`
-
-## Options and Switches
-
-**NOTE:** Options and switches apply to all items passed, so if you are
- running a command like install that allows installing multiple
- packages, and you use `--version=1.0.0`, it is going to look for and
- try to install version 1.0.0 of every package passed. So please split
- out multiple package calls when wanting to pass specific options.
-
-Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).
-
-~~~
-
- -?, --help, -h
- Prints out the help menu.
-
- -d, --debug
- Debug - Show debug messaging.
-
- -v, --verbose
- Verbose - Show verbose messaging. Very verbose messaging, avoid using
- under normal circumstances.
-
- --trace
- Trace - Show trace messaging. Very, very verbose trace messaging. Avoid
- except when needing super low-level .NET Framework debugging. Available
- in 0.10.4+.
-
- --nocolor, --no-color
- No Color - Do not show colorization in logging output. This overrides
- the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
-
- --acceptlicense, --accept-license
- AcceptLicense - Accept license dialogs automatically. Reserved for
- future use.
-
- -y, --yes, --confirm
- Confirm all prompts - Chooses affirmative answer instead of prompting.
- Implies --accept-license
-
- -f, --force
- Force - force the behavior. Do not use force during normal operation -
- it subverts some of the smart behavior for commands.
-
- --noop, --whatif, --what-if
- NoOp / WhatIf - Don't actually do anything.
-
- -r, --limitoutput, --limit-output
- LimitOutput - Limit the output to essential information
-
- --timeout, --execution-timeout=VALUE
- CommandExecutionTimeout (in seconds) - The time to allow a command to
- finish before timing out. Overrides the default execution timeout in the
- configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
-
- -c, --cache, --cachelocation, --cache-location=VALUE
- CacheLocation - Location for download cache, defaults to %TEMP% or value
- in chocolatey.config file.
-
- --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
- AllowUnofficialBuild - When not using the official build you must set
- this flag for choco to continue.
-
- --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
- FailOnStandardError - Fail on standard error output (stderr), typically
- received when running external commands during install providers. This
- overrides the feature failOnStandardError.
-
- --use-system-powershell
- UseSystemPowerShell - Execute PowerShell using an external process
- instead of the built-in PowerShell host. Should only be used when
- internal host is failing. Available in 0.9.10+.
-
- --no-progress
- Do Not Show Progress - Do not show download progress percentages.
- Available in 0.10.4+.
-
- --proxy=VALUE
- Proxy Location - Explicit proxy location. Overrides the default proxy
- location of ''. Available for config settings in 0.9.9.9+, this CLI
- option available in 0.10.4+.
-
- --proxy-user=VALUE
- Proxy User Name - Explicit proxy user (optional). Requires explicity
- proxy (`--proxy` or config setting). Overrides the default proxy user of
- '123'. Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-password=VALUE
- Proxy Password - Explicit proxy password (optional) to be used with
- username. Requires explicity proxy (`--proxy` or config setting) and
- user name. Overrides the default proxy password (encrypted in settings
- if set). Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-bypass-list=VALUE
- ProxyBypassList - Comma separated list of regex locations to bypass on
- proxy. Requires explicity proxy (`--proxy` or config setting). Overrides
- the default proxy bypass list of ''. Available in 0.10.4+.
-
- --proxy-bypass-on-local
- Proxy Bypass On Local - Bypass proxy for local connections. Requires
- explicity proxy (`--proxy` or config setting). Overrides the default
- proxy bypass on local setting of 'True'. Available in 0.10.4+.
-
- --log-file=VALUE
- Log File to output to in addition to regular loggers. Available in 0.1-
- 0.8+.
-
- -s, --source=VALUE
- Source - Source location for install. Can use special 'webpi' or
- 'windowsfeatures' sources. Defaults to sources.
-
- -l, --lo, --localonly, --local-only
- LocalOnly - Only search against local machine items.
-
- --idonly, --id-only
- Id Only - Only return Package Ids in the list results. Available in 0.1-
- 0.6+.
-
- --pre, --prerelease
- Prerelease - Include Prereleases? Defaults to false.
-
- -i, --includeprograms, --include-programs
- IncludePrograms - Used in conjunction with LocalOnly, filters out apps
- chocolatey has listed as packages and includes those in the list.
- Defaults to false.
-
- -a, --all, --allversions, --all-versions
- AllVersions - include results from all versions.
-
- --version=VALUE
- Version - Specific version of a package to return.
-
- -u, --user=VALUE
- User - used with authenticated feeds. Defaults to empty.
-
- -p, --password=VALUE
- Password - the user's password to the source. Defaults to empty.
-
- --cert=VALUE
- Client certificate - PFX pathname for an x509 authenticated feeds.
- Defaults to empty. Available in 0.9.10+.
-
- --cp, --certpassword=VALUE
- Certificate Password - the client certificate's password to the source.
- Defaults to empty. Available in 0.9.10+.
-
- --page=VALUE
- Page - the 'page' of results to return. Defaults to return all results.
- Available in 0.9.10+.
-
- --page-size=VALUE
- Page Size - the amount of package results to return per page. Defaults
- to 25. Available in 0.9.10+.
-
- -e, --exact
- Exact - Only return packages with this exact name. Available in 0.9.10+.
-
- --by-id-only
- ByIdOnly - Only return packages where the id contains the search filter.
- Available in 0.9.10+.
-
- --by-tag-only, --by-tags-only
- ByTagOnly - Only return packages where the search filter matches on the
- tags. Available in 0.10.6+.
-
- --id-starts-with
- IdStartsWith - Only return packages where the id starts with the search
- filter. Available in 0.9.10+.
-
- --order-by-popularity
- OrderByPopularity - Sort by package results by popularity. Available in
- 0.9.10+.
-
- --approved-only
- ApprovedOnly - Only return approved packages - this option will filter
- out results not from the [community repository](https://chocolatey.org/packages). Available in 0.9.10+.
-
- --download-cache, --download-cache-only
- DownloadCacheAvailable - Only return packages that have a download cache
- available - this option will filter out results not from the community
- repository. Available in 0.9.10+.
-
- --not-broken
- NotBroken - Only return packages that are not failing testing - this
- option only filters out failing results from the [community feed](https://chocolatey.org/packages). It will
- not filter against other sources. Available in 0.9.10+.
-
- --detail, --detailed
- Detailed - Alias for verbose. Available in 0.9.10+.
-
- --audit, --showaudit, --show-audit, --show-audit-info
- Show Audit Information - Display auditing information for a package.
- Available in business editions 1.12.0+.
-
-~~~
-
-[[Command Reference|CommandsReference]]
-
-
-***NOTE:*** This documentation has been automatically generated from `choco search -h`.
-
diff --git a/docs/generated/CommandsSetapiKey.md b/docs/generated/CommandsSetapiKey.md
deleted file mode 100644
index 6fa0ff52f0..0000000000
--- a/docs/generated/CommandsSetapiKey.md
+++ /dev/null
@@ -1,190 +0,0 @@
-
-
-# ApiKey Command (choco setapikey)
-
-This lists api keys that are set or sets an api key for a particular
- source so it doesn't need to be specified every time.
-
-Anything that doesn't contain source and key will list api keys.
-
-## Usage
-
- choco apikey []
- choco setapikey []
-
-## Examples
-
- choco apikey
- choco apikey -s https://somewhere/out/there
- choco apikey -s="https://somewhere/out/there/" -k="value"
- choco apikey -s "https://push.chocolatey.org/" -k="123-123123-123"
- choco apikey -s "http://internal_nexus" -k="user:password"
-
-For source location, this can be a folder/file share or an
-http location. When it comes to urls, they can be different from the packages
-url (where packages are searched and installed from). As an example, for
-Chocolatey's community package package repository, the package url is
-https://chocolatey.org/api/v2, but the push url is https://push.chocolatey.org
-(and the deprecated https://chocolatey.org/ as a push url). Check the
-documentation for your choice of repository to learn what the push url is.
-
-For the key, this can be an apikey that is provided by your source repository.
-With some sources, like Nexus, this can be a NuGet API key or it could be a
-user name and password specified as 'user:password' for the API key. Please see
-your repository's documentation (for Nexus, please see
-https://bit.ly/nexus2apikey).
-
-**NOTE:** See scripting in [[how to pass arguments|CommandsReference#how-to-pass-options--switches]] (`choco -?`) for how to
- write proper scripts and integrations.
-
-
-## Connecting to Chocolatey.org (Community Package Repository)
-
-In order to save your API key for https://push.chocolatey.org/,
- log in (or register, confirm and then log in) to
- https://push.chocolatey.org/, go to https://push.chocolatey.org/account,
- copy the API Key, and then use it in the following command:
-
- choco apikey -k -s https://push.chocolatey.org/
-
-
-## Exit Codes
-
-Exit codes that normally result from running this command.
-
-Normal:
- - 0: operation was successful, no issues detected
- - -1 or 1: an error has occurred
-
-If you find other exit codes that we have not yet documented, please
- file a ticket so we can document it at
- https://github.com/chocolatey/choco/issues/new/choose.
-
-
-## Options and Switches
-
-**NOTE:** Options and switches apply to all items passed, so if you are
- running a command like install that allows installing multiple
- packages, and you use `--version=1.0.0`, it is going to look for and
- try to install version 1.0.0 of every package passed. So please split
- out multiple package calls when wanting to pass specific options.
-
-Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).
-
-~~~
-
- -?, --help, -h
- Prints out the help menu.
-
- -d, --debug
- Debug - Show debug messaging.
-
- -v, --verbose
- Verbose - Show verbose messaging. Very verbose messaging, avoid using
- under normal circumstances.
-
- --trace
- Trace - Show trace messaging. Very, very verbose trace messaging. Avoid
- except when needing super low-level .NET Framework debugging. Available
- in 0.10.4+.
-
- --nocolor, --no-color
- No Color - Do not show colorization in logging output. This overrides
- the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
-
- --acceptlicense, --accept-license
- AcceptLicense - Accept license dialogs automatically. Reserved for
- future use.
-
- -y, --yes, --confirm
- Confirm all prompts - Chooses affirmative answer instead of prompting.
- Implies --accept-license
-
- -f, --force
- Force - force the behavior. Do not use force during normal operation -
- it subverts some of the smart behavior for commands.
-
- --noop, --whatif, --what-if
- NoOp / WhatIf - Don't actually do anything.
-
- -r, --limitoutput, --limit-output
- LimitOutput - Limit the output to essential information
-
- --timeout, --execution-timeout=VALUE
- CommandExecutionTimeout (in seconds) - The time to allow a command to
- finish before timing out. Overrides the default execution timeout in the
- configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
-
- -c, --cache, --cachelocation, --cache-location=VALUE
- CacheLocation - Location for download cache, defaults to %TEMP% or value
- in chocolatey.config file.
-
- --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
- AllowUnofficialBuild - When not using the official build you must set
- this flag for choco to continue.
-
- --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
- FailOnStandardError - Fail on standard error output (stderr), typically
- received when running external commands during install providers. This
- overrides the feature failOnStandardError.
-
- --use-system-powershell
- UseSystemPowerShell - Execute PowerShell using an external process
- instead of the built-in PowerShell host. Should only be used when
- internal host is failing. Available in 0.9.10+.
-
- --no-progress
- Do Not Show Progress - Do not show download progress percentages.
- Available in 0.10.4+.
-
- --proxy=VALUE
- Proxy Location - Explicit proxy location. Overrides the default proxy
- location of ''. Available for config settings in 0.9.9.9+, this CLI
- option available in 0.10.4+.
-
- --proxy-user=VALUE
- Proxy User Name - Explicit proxy user (optional). Requires explicity
- proxy (`--proxy` or config setting). Overrides the default proxy user of
- '123'. Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-password=VALUE
- Proxy Password - Explicit proxy password (optional) to be used with
- username. Requires explicity proxy (`--proxy` or config setting) and
- user name. Overrides the default proxy password (encrypted in settings
- if set). Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-bypass-list=VALUE
- ProxyBypassList - Comma separated list of regex locations to bypass on
- proxy. Requires explicity proxy (`--proxy` or config setting). Overrides
- the default proxy bypass list of ''. Available in 0.10.4+.
-
- --proxy-bypass-on-local
- Proxy Bypass On Local - Bypass proxy for local connections. Requires
- explicity proxy (`--proxy` or config setting). Overrides the default
- proxy bypass on local setting of 'True'. Available in 0.10.4+.
-
- --log-file=VALUE
- Log File to output to in addition to regular loggers. Available in 0.1-
- 0.8+.
-
- -s, --source=VALUE
- Source [REQUIRED] - The source location for the key
-
- -k, --key, --apikey, --api-key=VALUE
- ApiKey - The API key for the source. This is the authentication that
- identifies you and allows you to push to a source. With some sources
- this is either a key or it could be a user name and password specified
- as 'user:password'.
-
- --rem, --remove
- Removes an API key from Chocolatey
-
-~~~
-
-[[Command Reference|CommandsReference]]
-
-
-***NOTE:*** This documentation has been automatically generated from `choco setapikey -h`.
-
diff --git a/docs/generated/CommandsSource.md b/docs/generated/CommandsSource.md
deleted file mode 100644
index c81fa15ac4..0000000000
--- a/docs/generated/CommandsSource.md
+++ /dev/null
@@ -1,212 +0,0 @@
-
-
-# Source Command (choco source)
-
-Chocolatey will allow you to interact with sources.
-
-**NOTE:** Mostly compatible with older chocolatey client (0.9.8.x and
- below) with options and switches. When enabling, disabling or removing
- a source, use `-name` in front of the option now. In most cases you
- can still pass options and switches with one dash (`-`). For more
- details, see [[how to pass arguments|CommandsReference#how-to-pass-options--switches]] (`choco -?`).
-
-## Usage
-
- choco source [list]|add|remove|disable|enable []
- choco sources [list]|add|remove|disable|enable []
-
-## Examples
-
- choco source
- choco source list
- choco source add -n=bob -s="https://somewhere/out/there/api/v2/"
- choco source add -n=bob -s "'https://somewhere/out/there/api/v2/'" -cert=\Users\bob\bob.pfx
- choco source add -n=bob -s "'https://somewhere/out/there/api/v2/'" -u=bob -p=12345
- choco source disable -n=bob
- choco source enable -n=bob
- choco source remove -n=bob
-
-When it comes to the source location, this can be a folder/file share or an http
-location. If it is a url, it will be a location you can go to in a browser and
-it returns OData with something that says Packages in the browser, similar to
-what you see when you go to https://chocolatey.org/api/v2/.
-
-**NOTE:** See scripting in [[how to pass arguments|CommandsReference#how-to-pass-options--switches]] (`choco -?`) for how to
- write proper scripts and integrations.
-
-
-## Exit Codes
-
-Exit codes that normally result from running this command.
-
-Normal:
- - 0: operation was successful, no issues detected
- - -1 or 1: an error has occurred
-
-If you find other exit codes that we have not yet documented, please
- file a ticket so we can document it at
- https://github.com/chocolatey/choco/issues/new/choose.
-
-
-## Options and Switches
-
-**NOTE:** Options and switches apply to all items passed, so if you are
- running a command like install that allows installing multiple
- packages, and you use `--version=1.0.0`, it is going to look for and
- try to install version 1.0.0 of every package passed. So please split
- out multiple package calls when wanting to pass specific options.
-
-Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).
-
-~~~
-
- -?, --help, -h
- Prints out the help menu.
-
- -d, --debug
- Debug - Show debug messaging.
-
- -v, --verbose
- Verbose - Show verbose messaging. Very verbose messaging, avoid using
- under normal circumstances.
-
- --trace
- Trace - Show trace messaging. Very, very verbose trace messaging. Avoid
- except when needing super low-level .NET Framework debugging. Available
- in 0.10.4+.
-
- --nocolor, --no-color
- No Color - Do not show colorization in logging output. This overrides
- the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
-
- --acceptlicense, --accept-license
- AcceptLicense - Accept license dialogs automatically. Reserved for
- future use.
-
- -y, --yes, --confirm
- Confirm all prompts - Chooses affirmative answer instead of prompting.
- Implies --accept-license
-
- -f, --force
- Force - force the behavior. Do not use force during normal operation -
- it subverts some of the smart behavior for commands.
-
- --noop, --whatif, --what-if
- NoOp / WhatIf - Don't actually do anything.
-
- -r, --limitoutput, --limit-output
- LimitOutput - Limit the output to essential information
-
- --timeout, --execution-timeout=VALUE
- CommandExecutionTimeout (in seconds) - The time to allow a command to
- finish before timing out. Overrides the default execution timeout in the
- configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
-
- -c, --cache, --cachelocation, --cache-location=VALUE
- CacheLocation - Location for download cache, defaults to %TEMP% or value
- in chocolatey.config file.
-
- --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
- AllowUnofficialBuild - When not using the official build you must set
- this flag for choco to continue.
-
- --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
- FailOnStandardError - Fail on standard error output (stderr), typically
- received when running external commands during install providers. This
- overrides the feature failOnStandardError.
-
- --use-system-powershell
- UseSystemPowerShell - Execute PowerShell using an external process
- instead of the built-in PowerShell host. Should only be used when
- internal host is failing. Available in 0.9.10+.
-
- --no-progress
- Do Not Show Progress - Do not show download progress percentages.
- Available in 0.10.4+.
-
- --proxy=VALUE
- Proxy Location - Explicit proxy location. Overrides the default proxy
- location of ''. Available for config settings in 0.9.9.9+, this CLI
- option available in 0.10.4+.
-
- --proxy-user=VALUE
- Proxy User Name - Explicit proxy user (optional). Requires explicity
- proxy (`--proxy` or config setting). Overrides the default proxy user of
- '123'. Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-password=VALUE
- Proxy Password - Explicit proxy password (optional) to be used with
- username. Requires explicity proxy (`--proxy` or config setting) and
- user name. Overrides the default proxy password (encrypted in settings
- if set). Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-bypass-list=VALUE
- ProxyBypassList - Comma separated list of regex locations to bypass on
- proxy. Requires explicity proxy (`--proxy` or config setting). Overrides
- the default proxy bypass list of ''. Available in 0.10.4+.
-
- --proxy-bypass-on-local
- Proxy Bypass On Local - Bypass proxy for local connections. Requires
- explicity proxy (`--proxy` or config setting). Overrides the default
- proxy bypass on local setting of 'True'. Available in 0.10.4+.
-
- --log-file=VALUE
- Log File to output to in addition to regular loggers. Available in 0.1-
- 0.8+.
-
- -n, --name=VALUE
- Name - the name of the source. Required with actions other than list.
- Defaults to empty.
-
- -s, --source=VALUE
- Source - The source. This can be a folder/file share or an http locatio-
- n. If it is a url, it will be a location you can go to in a browser and
- it returns OData with something that says Packages in the browser,
- similar to what you see when you go to https://chocolatey.org/api/v2/.
- Required with add action. Defaults to empty.
-
- -u, --user=VALUE
- User - used with authenticated feeds. Defaults to empty.
-
- -p, --password=VALUE
- Password - the user's password to the source. Encrypted in chocolate-
- y.config file.
-
- --cert=VALUE
- Client certificate - PFX pathname for an x509 authenticated feeds.
- Defaults to empty. Available in 0.9.10+.
-
- --cp, --certpassword=VALUE
- Certificate Password - the client certificate's password to the source.
- Defaults to empty. Available in 0.9.10+.
-
- --priority=VALUE
- Priority - The priority order of this source as compared to other
- sources, lower is better. Defaults to 0 (no priority). All priorities
- above 0 will be evaluated first, then zero-based values will be
- evaluated in config file order. Available in 0.9.9.9+.
-
- --bypassproxy, --bypass-proxy
- Bypass Proxy - Should this source explicitly bypass any explicitly or
- system configured proxies? Defaults to false. Available in 0.10.4+.
-
- --allowselfservice, --allow-self-service
- Allow Self-Service - Should this source be allowed to be used with self-
- service? Requires business edition (v1.10.0+) with feature
- 'useBackgroundServiceWithSelfServiceSourcesOnly' turned on. Defaults to
- false. Available in 0.10.4+.
-
- --adminonly, --admin-only
- Visible to Administrators Only - Should this source be visible to non-
- administrators? Requires business edition (v1.12.2+). Defaults to false.
- Available in 0.10.8+.
-
-~~~
-
-[[Command Reference|CommandsReference]]
-
-
-***NOTE:*** This documentation has been automatically generated from `choco source -h`.
-
diff --git a/docs/generated/CommandsSources.md b/docs/generated/CommandsSources.md
deleted file mode 100644
index 5fc3630fd2..0000000000
--- a/docs/generated/CommandsSources.md
+++ /dev/null
@@ -1,212 +0,0 @@
-
-
-# Source Command (choco sources)
-
-Chocolatey will allow you to interact with sources.
-
-**NOTE:** Mostly compatible with older chocolatey client (0.9.8.x and
- below) with options and switches. When enabling, disabling or removing
- a source, use `-name` in front of the option now. In most cases you
- can still pass options and switches with one dash (`-`). For more
- details, see [[how to pass arguments|CommandsReference#how-to-pass-options--switches]] (`choco -?`).
-
-## Usage
-
- choco source [list]|add|remove|disable|enable []
- choco sources [list]|add|remove|disable|enable []
-
-## Examples
-
- choco source
- choco source list
- choco source add -n=bob -s="https://somewhere/out/there/api/v2/"
- choco source add -n=bob -s "'https://somewhere/out/there/api/v2/'" -cert=\Users\bob\bob.pfx
- choco source add -n=bob -s "'https://somewhere/out/there/api/v2/'" -u=bob -p=12345
- choco source disable -n=bob
- choco source enable -n=bob
- choco source remove -n=bob
-
-When it comes to the source location, this can be a folder/file share or an http
-location. If it is a url, it will be a location you can go to in a browser and
-it returns OData with something that says Packages in the browser, similar to
-what you see when you go to https://chocolatey.org/api/v2/.
-
-**NOTE:** See scripting in [[how to pass arguments|CommandsReference#how-to-pass-options--switches]] (`choco -?`) for how to
- write proper scripts and integrations.
-
-
-## Exit Codes
-
-Exit codes that normally result from running this command.
-
-Normal:
- - 0: operation was successful, no issues detected
- - -1 or 1: an error has occurred
-
-If you find other exit codes that we have not yet documented, please
- file a ticket so we can document it at
- https://github.com/chocolatey/choco/issues/new/choose.
-
-
-## Options and Switches
-
-**NOTE:** Options and switches apply to all items passed, so if you are
- running a command like install that allows installing multiple
- packages, and you use `--version=1.0.0`, it is going to look for and
- try to install version 1.0.0 of every package passed. So please split
- out multiple package calls when wanting to pass specific options.
-
-Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).
-
-~~~
-
- -?, --help, -h
- Prints out the help menu.
-
- -d, --debug
- Debug - Show debug messaging.
-
- -v, --verbose
- Verbose - Show verbose messaging. Very verbose messaging, avoid using
- under normal circumstances.
-
- --trace
- Trace - Show trace messaging. Very, very verbose trace messaging. Avoid
- except when needing super low-level .NET Framework debugging. Available
- in 0.10.4+.
-
- --nocolor, --no-color
- No Color - Do not show colorization in logging output. This overrides
- the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
-
- --acceptlicense, --accept-license
- AcceptLicense - Accept license dialogs automatically. Reserved for
- future use.
-
- -y, --yes, --confirm
- Confirm all prompts - Chooses affirmative answer instead of prompting.
- Implies --accept-license
-
- -f, --force
- Force - force the behavior. Do not use force during normal operation -
- it subverts some of the smart behavior for commands.
-
- --noop, --whatif, --what-if
- NoOp / WhatIf - Don't actually do anything.
-
- -r, --limitoutput, --limit-output
- LimitOutput - Limit the output to essential information
-
- --timeout, --execution-timeout=VALUE
- CommandExecutionTimeout (in seconds) - The time to allow a command to
- finish before timing out. Overrides the default execution timeout in the
- configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
-
- -c, --cache, --cachelocation, --cache-location=VALUE
- CacheLocation - Location for download cache, defaults to %TEMP% or value
- in chocolatey.config file.
-
- --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
- AllowUnofficialBuild - When not using the official build you must set
- this flag for choco to continue.
-
- --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
- FailOnStandardError - Fail on standard error output (stderr), typically
- received when running external commands during install providers. This
- overrides the feature failOnStandardError.
-
- --use-system-powershell
- UseSystemPowerShell - Execute PowerShell using an external process
- instead of the built-in PowerShell host. Should only be used when
- internal host is failing. Available in 0.9.10+.
-
- --no-progress
- Do Not Show Progress - Do not show download progress percentages.
- Available in 0.10.4+.
-
- --proxy=VALUE
- Proxy Location - Explicit proxy location. Overrides the default proxy
- location of ''. Available for config settings in 0.9.9.9+, this CLI
- option available in 0.10.4+.
-
- --proxy-user=VALUE
- Proxy User Name - Explicit proxy user (optional). Requires explicity
- proxy (`--proxy` or config setting). Overrides the default proxy user of
- '123'. Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-password=VALUE
- Proxy Password - Explicit proxy password (optional) to be used with
- username. Requires explicity proxy (`--proxy` or config setting) and
- user name. Overrides the default proxy password (encrypted in settings
- if set). Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-bypass-list=VALUE
- ProxyBypassList - Comma separated list of regex locations to bypass on
- proxy. Requires explicity proxy (`--proxy` or config setting). Overrides
- the default proxy bypass list of ''. Available in 0.10.4+.
-
- --proxy-bypass-on-local
- Proxy Bypass On Local - Bypass proxy for local connections. Requires
- explicity proxy (`--proxy` or config setting). Overrides the default
- proxy bypass on local setting of 'True'. Available in 0.10.4+.
-
- --log-file=VALUE
- Log File to output to in addition to regular loggers. Available in 0.1-
- 0.8+.
-
- -n, --name=VALUE
- Name - the name of the source. Required with actions other than list.
- Defaults to empty.
-
- -s, --source=VALUE
- Source - The source. This can be a folder/file share or an http locatio-
- n. If it is a url, it will be a location you can go to in a browser and
- it returns OData with something that says Packages in the browser,
- similar to what you see when you go to https://chocolatey.org/api/v2/.
- Required with add action. Defaults to empty.
-
- -u, --user=VALUE
- User - used with authenticated feeds. Defaults to empty.
-
- -p, --password=VALUE
- Password - the user's password to the source. Encrypted in chocolate-
- y.config file.
-
- --cert=VALUE
- Client certificate - PFX pathname for an x509 authenticated feeds.
- Defaults to empty. Available in 0.9.10+.
-
- --cp, --certpassword=VALUE
- Certificate Password - the client certificate's password to the source.
- Defaults to empty. Available in 0.9.10+.
-
- --priority=VALUE
- Priority - The priority order of this source as compared to other
- sources, lower is better. Defaults to 0 (no priority). All priorities
- above 0 will be evaluated first, then zero-based values will be
- evaluated in config file order. Available in 0.9.9.9+.
-
- --bypassproxy, --bypass-proxy
- Bypass Proxy - Should this source explicitly bypass any explicitly or
- system configured proxies? Defaults to false. Available in 0.10.4+.
-
- --allowselfservice, --allow-self-service
- Allow Self-Service - Should this source be allowed to be used with self-
- service? Requires business edition (v1.10.0+) with feature
- 'useBackgroundServiceWithSelfServiceSourcesOnly' turned on. Defaults to
- false. Available in 0.10.4+.
-
- --adminonly, --admin-only
- Visible to Administrators Only - Should this source be visible to non-
- administrators? Requires business edition (v1.12.2+). Defaults to false.
- Available in 0.10.8+.
-
-~~~
-
-[[Command Reference|CommandsReference]]
-
-
-***NOTE:*** This documentation has been automatically generated from `choco sources -h`.
-
diff --git a/docs/generated/CommandsSupport.md b/docs/generated/CommandsSupport.md
deleted file mode 100644
index 9fef4c7f02..0000000000
--- a/docs/generated/CommandsSupport.md
+++ /dev/null
@@ -1,113 +0,0 @@
-
-
-# Support Command (choco support)
-
-As a licensed customer, you can reach out to
- our email for support. If you have phone support, you
- may reach out during the hours that are listed in your support
- contract. See https://chocolatey.org/support for details.
-
-
- -?, --help, -h
- Prints out the help menu.
-
- -d, --debug
- Debug - Show debug messaging.
-
- -v, --verbose
- Verbose - Show verbose messaging. Very verbose messaging, avoid using
- under normal circumstances.
-
- --trace
- Trace - Show trace messaging. Very, very verbose trace messaging. Avoid
- except when needing super low-level .NET Framework debugging. Available
- in 0.10.4+.
-
- --nocolor, --no-color
- No Color - Do not show colorization in logging output. This overrides
- the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
-
- --acceptlicense, --accept-license
- AcceptLicense - Accept license dialogs automatically. Reserved for
- future use.
-
- -y, --yes, --confirm
- Confirm all prompts - Chooses affirmative answer instead of prompting.
- Implies --accept-license
-
- -f, --force
- Force - force the behavior. Do not use force during normal operation -
- it subverts some of the smart behavior for commands.
-
- --noop, --whatif, --what-if
- NoOp / WhatIf - Don't actually do anything.
-
- -r, --limitoutput, --limit-output
- LimitOutput - Limit the output to essential information
-
- --timeout, --execution-timeout=VALUE
- CommandExecutionTimeout (in seconds) - The time to allow a command to
- finish before timing out. Overrides the default execution timeout in the
- configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
-
- -c, --cache, --cachelocation, --cache-location=VALUE
- CacheLocation - Location for download cache, defaults to %TEMP% or value
- in chocolatey.config file.
-
- --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
- AllowUnofficialBuild - When not using the official build you must set
- this flag for choco to continue.
-
- --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
- FailOnStandardError - Fail on standard error output (stderr), typically
- received when running external commands during install providers. This
- overrides the feature failOnStandardError.
-
- --use-system-powershell
- UseSystemPowerShell - Execute PowerShell using an external process
- instead of the built-in PowerShell host. Should only be used when
- internal host is failing. Available in 0.9.10+.
-
- --no-progress
- Do Not Show Progress - Do not show download progress percentages.
- Available in 0.10.4+.
-
- --proxy=VALUE
- Proxy Location - Explicit proxy location. Overrides the default proxy
- location of ''. Available for config settings in 0.9.9.9+, this CLI
- option available in 0.10.4+.
-
- --proxy-user=VALUE
- Proxy User Name - Explicit proxy user (optional). Requires explicity
- proxy (`--proxy` or config setting). Overrides the default proxy user of
- '123'. Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-password=VALUE
- Proxy Password - Explicit proxy password (optional) to be used with
- username. Requires explicity proxy (`--proxy` or config setting) and
- user name. Overrides the default proxy password (encrypted in settings
- if set). Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-bypass-list=VALUE
- ProxyBypassList - Comma separated list of regex locations to bypass on
- proxy. Requires explicity proxy (`--proxy` or config setting). Overrides
- the default proxy bypass list of ''. Available in 0.10.4+.
-
- --proxy-bypass-on-local
- Proxy Bypass On Local - Bypass proxy for local connections. Requires
- explicity proxy (`--proxy` or config setting). Overrides the default
- proxy bypass on local setting of 'True'. Available in 0.10.4+.
-
- --log-file=VALUE
- Log File to output to in addition to regular loggers. Available in 0.1-
- 0.8+.
-
-~~~
-
-[[Command Reference|CommandsReference]]
-
-
-***NOTE:*** This documentation has been automatically generated from `choco support -h`.
-
diff --git a/docs/generated/CommandsSync.md b/docs/generated/CommandsSync.md
deleted file mode 100644
index cd727dd8b7..0000000000
--- a/docs/generated/CommandsSync.md
+++ /dev/null
@@ -1,160 +0,0 @@
-
-
-# Synchronize Command (choco sync)
-
-Business editions of Chocolatey starting at licensed version 1.9.0.
-
-Synchronizes against the system installed software that are not
- installed as packages on Chocolatey. Searches through the system to
- see software that has been installed and generates packages from that
- software, baselines the packages against Chocolatey and makes the
- packages available to upload to source.
-
-See https://chocolatey.org/docs/features-synchronize
-
-
-## Usage
-
- choco sync []
-
-## Examples
-
- choco sync
- choco sync --id=putty
- choco sync --id=putty --package-id=putty
-
-## See It In Action
-
-Coming soon
-
-## Options and Switches
-
-**NOTE:** Options and switches apply to all items passed, so if you are
- running a command like install that allows installing multiple
- packages, and you use `--version=1.0.0`, it is going to look for and
- try to install version 1.0.0 of every package passed. So please split
- out multiple package calls when wanting to pass specific options.
-
-Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).
-
-~~~
-
- downloading multiple packages, and you use `--version=1.0.0`, it is
- going to look for and try to download version 1.0.0 of every package
-
-
- -?, --help, -h
- Prints out the help menu.
-
- -d, --debug
- Debug - Show debug messaging.
-
- -v, --verbose
- Verbose - Show verbose messaging. Very verbose messaging, avoid using
- under normal circumstances.
-
- --trace
- Trace - Show trace messaging. Very, very verbose trace messaging. Avoid
- except when needing super low-level .NET Framework debugging. Available
- in 0.10.4+.
-
- --nocolor, --no-color
- No Color - Do not show colorization in logging output. This overrides
- the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
-
- --acceptlicense, --accept-license
- AcceptLicense - Accept license dialogs automatically. Reserved for
- future use.
-
- -y, --yes, --confirm
- Confirm all prompts - Chooses affirmative answer instead of prompting.
- Implies --accept-license
-
- -f, --force
- Force - force the behavior. Do not use force during normal operation -
- it subverts some of the smart behavior for commands.
-
- --noop, --whatif, --what-if
- NoOp / WhatIf - Don't actually do anything.
-
- -r, --limitoutput, --limit-output
- LimitOutput - Limit the output to essential information
-
- --timeout, --execution-timeout=VALUE
- CommandExecutionTimeout (in seconds) - The time to allow a command to
- finish before timing out. Overrides the default execution timeout in the
- configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
-
- -c, --cache, --cachelocation, --cache-location=VALUE
- CacheLocation - Location for download cache, defaults to %TEMP% or value
- in chocolatey.config file.
-
- --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
- AllowUnofficialBuild - When not using the official build you must set
- this flag for choco to continue.
-
- --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
- FailOnStandardError - Fail on standard error output (stderr), typically
- received when running external commands during install providers. This
- overrides the feature failOnStandardError.
-
- --use-system-powershell
- UseSystemPowerShell - Execute PowerShell using an external process
- instead of the built-in PowerShell host. Should only be used when
- internal host is failing. Available in 0.9.10+.
-
- --no-progress
- Do Not Show Progress - Do not show download progress percentages.
- Available in 0.10.4+.
-
- --proxy=VALUE
- Proxy Location - Explicit proxy location. Overrides the default proxy
- location of ''. Available for config settings in 0.9.9.9+, this CLI
- option available in 0.10.4+.
-
- --proxy-user=VALUE
- Proxy User Name - Explicit proxy user (optional). Requires explicity
- proxy (`--proxy` or config setting). Overrides the default proxy user of
- '123'. Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-password=VALUE
- Proxy Password - Explicit proxy password (optional) to be used with
- username. Requires explicity proxy (`--proxy` or config setting) and
- user name. Overrides the default proxy password (encrypted in settings
- if set). Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-bypass-list=VALUE
- ProxyBypassList - Comma separated list of regex locations to bypass on
- proxy. Requires explicity proxy (`--proxy` or config setting). Overrides
- the default proxy bypass list of ''. Available in 0.10.4+.
-
- --proxy-bypass-on-local
- Proxy Bypass On Local - Bypass proxy for local connections. Requires
- explicity proxy (`--proxy` or config setting). Overrides the default
- proxy bypass on local setting of 'True'. Available in 0.10.4+.
-
- --log-file=VALUE
- Log File to output to in addition to regular loggers. Available in 0.1-
- 0.8+.
-
- --id=VALUE
- Id - The Display Name from Programs and Features
-
- --packageid, --package-id=VALUE
- PackageId - When used with Id, this will be the custom name for the
- package. Business editions only (version 1.12.2+)
-
- --out, --outdir, --outputdirectory, --output-directory=VALUE
- OutputDirectory - Specifies the directory for the generated Chocolatey
- package file(s). If not specified, uses a subdirectory of the current
- directory.
-
-~~~
-
-[[Command Reference|CommandsReference]]
-
-
-***NOTE:*** This documentation has been automatically generated from `choco sync -h`.
-
diff --git a/docs/generated/CommandsSynchronize.md b/docs/generated/CommandsSynchronize.md
deleted file mode 100644
index b7b5146212..0000000000
--- a/docs/generated/CommandsSynchronize.md
+++ /dev/null
@@ -1,160 +0,0 @@
-
-
-# Synchronize Command (choco synchronize)
-
-Business editions of Chocolatey starting at licensed version 1.9.0.
-
-Synchronizes against the system installed software that are not
- installed as packages on Chocolatey. Searches through the system to
- see software that has been installed and generates packages from that
- software, baselines the packages against Chocolatey and makes the
- packages available to upload to source.
-
-See https://chocolatey.org/docs/features-synchronize
-
-
-## Usage
-
- choco sync []
-
-## Examples
-
- choco sync
- choco sync --id=putty
- choco sync --id=putty --package-id=putty
-
-## See It In Action
-
-Coming soon
-
-## Options and Switches
-
-**NOTE:** Options and switches apply to all items passed, so if you are
- running a command like install that allows installing multiple
- packages, and you use `--version=1.0.0`, it is going to look for and
- try to install version 1.0.0 of every package passed. So please split
- out multiple package calls when wanting to pass specific options.
-
-Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).
-
-~~~
-
- downloading multiple packages, and you use `--version=1.0.0`, it is
- going to look for and try to download version 1.0.0 of every package
-
-
- -?, --help, -h
- Prints out the help menu.
-
- -d, --debug
- Debug - Show debug messaging.
-
- -v, --verbose
- Verbose - Show verbose messaging. Very verbose messaging, avoid using
- under normal circumstances.
-
- --trace
- Trace - Show trace messaging. Very, very verbose trace messaging. Avoid
- except when needing super low-level .NET Framework debugging. Available
- in 0.10.4+.
-
- --nocolor, --no-color
- No Color - Do not show colorization in logging output. This overrides
- the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
-
- --acceptlicense, --accept-license
- AcceptLicense - Accept license dialogs automatically. Reserved for
- future use.
-
- -y, --yes, --confirm
- Confirm all prompts - Chooses affirmative answer instead of prompting.
- Implies --accept-license
-
- -f, --force
- Force - force the behavior. Do not use force during normal operation -
- it subverts some of the smart behavior for commands.
-
- --noop, --whatif, --what-if
- NoOp / WhatIf - Don't actually do anything.
-
- -r, --limitoutput, --limit-output
- LimitOutput - Limit the output to essential information
-
- --timeout, --execution-timeout=VALUE
- CommandExecutionTimeout (in seconds) - The time to allow a command to
- finish before timing out. Overrides the default execution timeout in the
- configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
-
- -c, --cache, --cachelocation, --cache-location=VALUE
- CacheLocation - Location for download cache, defaults to %TEMP% or value
- in chocolatey.config file.
-
- --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
- AllowUnofficialBuild - When not using the official build you must set
- this flag for choco to continue.
-
- --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
- FailOnStandardError - Fail on standard error output (stderr), typically
- received when running external commands during install providers. This
- overrides the feature failOnStandardError.
-
- --use-system-powershell
- UseSystemPowerShell - Execute PowerShell using an external process
- instead of the built-in PowerShell host. Should only be used when
- internal host is failing. Available in 0.9.10+.
-
- --no-progress
- Do Not Show Progress - Do not show download progress percentages.
- Available in 0.10.4+.
-
- --proxy=VALUE
- Proxy Location - Explicit proxy location. Overrides the default proxy
- location of ''. Available for config settings in 0.9.9.9+, this CLI
- option available in 0.10.4+.
-
- --proxy-user=VALUE
- Proxy User Name - Explicit proxy user (optional). Requires explicity
- proxy (`--proxy` or config setting). Overrides the default proxy user of
- '123'. Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-password=VALUE
- Proxy Password - Explicit proxy password (optional) to be used with
- username. Requires explicity proxy (`--proxy` or config setting) and
- user name. Overrides the default proxy password (encrypted in settings
- if set). Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-bypass-list=VALUE
- ProxyBypassList - Comma separated list of regex locations to bypass on
- proxy. Requires explicity proxy (`--proxy` or config setting). Overrides
- the default proxy bypass list of ''. Available in 0.10.4+.
-
- --proxy-bypass-on-local
- Proxy Bypass On Local - Bypass proxy for local connections. Requires
- explicity proxy (`--proxy` or config setting). Overrides the default
- proxy bypass on local setting of 'True'. Available in 0.10.4+.
-
- --log-file=VALUE
- Log File to output to in addition to regular loggers. Available in 0.1-
- 0.8+.
-
- --id=VALUE
- Id - The Display Name from Programs and Features
-
- --packageid, --package-id=VALUE
- PackageId - When used with Id, this will be the custom name for the
- package. Business editions only (version 1.12.2+)
-
- --out, --outdir, --outputdirectory, --output-directory=VALUE
- OutputDirectory - Specifies the directory for the generated Chocolatey
- package file(s). If not specified, uses a subdirectory of the current
- directory.
-
-~~~
-
-[[Command Reference|CommandsReference]]
-
-
-***NOTE:*** This documentation has been automatically generated from `choco synchronize -h`.
-
diff --git a/docs/generated/CommandsUninstall.md b/docs/generated/CommandsUninstall.md
deleted file mode 100644
index 60b1764208..0000000000
--- a/docs/generated/CommandsUninstall.md
+++ /dev/null
@@ -1,326 +0,0 @@
-
-
-# Uninstall Command (choco uninstall)
-
-Uninstalls a package or a list of packages. Some may prefer to use
- `cuninst` as a shortcut for [[`choco uninstall`|Commandsuninstall]].
-
-**NOTE:** 100% compatible with older chocolatey client (0.9.8.32 and below)
- with options and switches. Add `-y` for previous behavior with no
- prompt. In most cases you can still pass options and switches with one
- dash (`-`). For more details, see [[how to pass arguments|CommandsReference#how-to-pass-options--switches]] (`choco -?`).
-
-Choco 0.9.9+ automatically tracks registry changes for "Programs and
- Features" of the underlying software's native installers when
- installing packages. The "Automatic Uninstaller" (auto uninstaller)
- service is a feature that can use that information to automatically
- determine how to uninstall these natively installed applications. This
- means that a package may not need an explicit chocolateyUninstall.ps1
- to reverse the installation done in the install script.
-
-Chocolatey tracks packages, which are the files in
- `$env:ChocolateyInstall\lib\packagename`. These packages may or may not
- contain the software (applications/tools) that each package represents.
- The software may actually be installed in Program Files (most native
- installers will install the software there) or elsewhere on the
- machine.
-
-With auto uninstaller turned off, a chocolateyUninstall.ps1 is required
- to perform uninstall from the system. In the absence of
- chocolateyUninstall.ps1, choco uninstall only removes the package from
- Chocolatey but does not remove the software from your system (unless
- in the package directory).
-
-**NOTE:** A package with a failing uninstall can be removed with the
-`-n --skipautouninstaller` flags. This will remove the package from
-chocolatey without attempting to uninstall the program.
-
-**NOTE:** Starting in 0.9.10+, the Automatic Uninstaller (AutoUninstaller)
- is turned on by default. To turn it off, run the following command:
-
- choco feature disable -n autoUninstaller
-
-**NOTE:** [Chocolatey Pro](https://chocolatey.org/compare) / Business automatically synchronizes with
- Programs and Features, ensuring manually removed apps are
- automatically removed from Chocolatey's repository.
-
-**NOTE:** Synchronizer and AutoUninstaller enhancements in licensed
- versions of Chocolatey ensure that Autouninstaller is up to 95%
- effective at removing software without an uninstall script. This is
- because synchronizer ensures the registry snapshot stays up to date
- and licensed enhancements have the ability to inspect more locations
- to determine how to automatically uninstall software.
-
-## Usage
-
- choco uninstall [pkg2 pkgN] [options/switches]
- cuninst [pkg2 pkgN] [options/switches]
-
-**NOTE:** `all` is a special package keyword that will allow you to
- uninstall all packages.
-
-
-## See It In Action
-
-
-
-
-## Examples
-
- choco uninstall git
- choco uninstall notepadplusplus googlechrome atom 7zip
- choco uninstall notepadplusplus googlechrome atom 7zip -dv
- choco uninstall ruby --version 1.8.7.37402
- choco uninstall nodejs.install --all-versions
-
-**NOTE:** See scripting in [[how to pass arguments|CommandsReference#how-to-pass-options--switches]] (`choco -?`) for how to
- write proper scripts and integrations.
-
-
-## Exit Codes
-
-Exit codes that normally result from running this command.
-
-Normal:
- - 0: operation was successful, no issues detected
- - -1 or 1: an error has occurred
-
-Package Exit Codes:
- - 1605: software is not installed
- - 1614: product is uninstalled
- - 1641: success, reboot initiated
- - 3010: success, reboot required
- - other (not listed): likely an error has occurred
-
-In addition to normal exit codes, packages are allowed to exit
- with their own codes when the feature 'usePackageExitCodes' is
- turned on. Available in v0.9.10+.
-
-Reboot Exit Codes:
- - 350: pending reboot detected, no action has occurred
- - 1604: install suspended, incomplete
-
-In addition to the above exit codes, you may also see reboot exit codes
- when the feature 'exitOnRebootDetected' is turned on. It typically requires
- the feature 'usePackageExitCodes' to also be turned on to work properly.
- Available in v0.10.12+.
-
-## Options and Switches
-
-**NOTE:** Options and switches apply to all items passed, so if you are
- running a command like install that allows installing multiple
- packages, and you use `--version=1.0.0`, it is going to look for and
- try to install version 1.0.0 of every package passed. So please split
- out multiple package calls when wanting to pass specific options.
-
-Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).
-
-~~~
-
-
-
- -?, --help, -h
- Prints out the help menu.
-
- -d, --debug
- Debug - Show debug messaging.
-
- -v, --verbose
- Verbose - Show verbose messaging. Very verbose messaging, avoid using
- under normal circumstances.
-
- --trace
- Trace - Show trace messaging. Very, very verbose trace messaging. Avoid
- except when needing super low-level .NET Framework debugging. Available
- in 0.10.4+.
-
- --nocolor, --no-color
- No Color - Do not show colorization in logging output. This overrides
- the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
-
- --acceptlicense, --accept-license
- AcceptLicense - Accept license dialogs automatically. Reserved for
- future use.
-
- -y, --yes, --confirm
- Confirm all prompts - Chooses affirmative answer instead of prompting.
- Implies --accept-license
-
- -f, --force
- Force - force the behavior. Do not use force during normal operation -
- it subverts some of the smart behavior for commands.
-
- --noop, --whatif, --what-if
- NoOp / WhatIf - Don't actually do anything.
-
- -r, --limitoutput, --limit-output
- LimitOutput - Limit the output to essential information
-
- --timeout, --execution-timeout=VALUE
- CommandExecutionTimeout (in seconds) - The time to allow a command to
- finish before timing out. Overrides the default execution timeout in the
- configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
-
- -c, --cache, --cachelocation, --cache-location=VALUE
- CacheLocation - Location for download cache, defaults to %TEMP% or value
- in chocolatey.config file.
-
- --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
- AllowUnofficialBuild - When not using the official build you must set
- this flag for choco to continue.
-
- --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
- FailOnStandardError - Fail on standard error output (stderr), typically
- received when running external commands during install providers. This
- overrides the feature failOnStandardError.
-
- --use-system-powershell
- UseSystemPowerShell - Execute PowerShell using an external process
- instead of the built-in PowerShell host. Should only be used when
- internal host is failing. Available in 0.9.10+.
-
- --no-progress
- Do Not Show Progress - Do not show download progress percentages.
- Available in 0.10.4+.
-
- --proxy=VALUE
- Proxy Location - Explicit proxy location. Overrides the default proxy
- location of ''. Available for config settings in 0.9.9.9+, this CLI
- option available in 0.10.4+.
-
- --proxy-user=VALUE
- Proxy User Name - Explicit proxy user (optional). Requires explicity
- proxy (`--proxy` or config setting). Overrides the default proxy user of
- '123'. Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-password=VALUE
- Proxy Password - Explicit proxy password (optional) to be used with
- username. Requires explicity proxy (`--proxy` or config setting) and
- user name. Overrides the default proxy password (encrypted in settings
- if set). Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-bypass-list=VALUE
- ProxyBypassList - Comma separated list of regex locations to bypass on
- proxy. Requires explicity proxy (`--proxy` or config setting). Overrides
- the default proxy bypass list of ''. Available in 0.10.4+.
-
- --proxy-bypass-on-local
- Proxy Bypass On Local - Bypass proxy for local connections. Requires
- explicity proxy (`--proxy` or config setting). Overrides the default
- proxy bypass on local setting of 'True'. Available in 0.10.4+.
-
- --log-file=VALUE
- Log File to output to in addition to regular loggers. Available in 0.1-
- 0.8+.
-
- -s, --source=VALUE
- Source - The source to find the package(s) to install. Special sources
- include: ruby, webpi, cygwin, windowsfeatures, and python. Defaults to
- default feeds.
-
- --version=VALUE
- Version - A specific version to uninstall. Defaults to unspecified.
-
- -a, --allversions, --all-versions
- AllVersions - Uninstall all versions? Defaults to false.
-
- --ua, --uninstallargs, --uninstallarguments, --uninstall-arguments=VALUE
- UninstallArguments - Uninstall Arguments to pass to the native installer
- in the package. Defaults to unspecified.
-
- -o, --override, --overrideargs, --overridearguments, --override-arguments
- OverrideArguments - Should uninstall arguments be used exclusively
- without appending to current package passed arguments? Defaults to false.
-
- --notsilent, --not-silent
- NotSilent - Do not uninstall this silently. Defaults to false.
-
- --params, --parameters, --pkgparameters, --packageparameters, --package-parameters=VALUE
- PackageParameters - Parameters to pass to the package. Defaults to
- unspecified.
-
- --argsglobal, --args-global, --installargsglobal, --install-args-global, --applyargstodependencies, --apply-args-to-dependencies, --apply-install-arguments-to-dependencies
- Apply Install Arguments To Dependencies - Should install arguments be
- applied to dependent packages? Defaults to false.
-
- --paramsglobal, --params-global, --packageparametersglobal, --package-parameters-global, --applyparamstodependencies, --apply-params-to-dependencies, --apply-package-parameters-to-dependencies
- Apply Package Parameters To Dependencies - Should package parameters be
- applied to dependent packages? Defaults to false.
-
- -m, --sxs, --sidebyside, --side-by-side, --allowmultiple, --allow-multiple, --allowmultipleversions, --allow-multiple-versions
- AllowMultipleVersions - Should multiple versions of a package be
- installed? Defaults to false.
-
- -x, --forcedependencies, --force-dependencies, --removedependencies, --remove-dependencies
- RemoveDependencies - Uninstall dependencies when uninstalling package(s-
- ). Defaults to false.
-
- -n, --skippowershell, --skip-powershell, --skipscripts, --skip-scripts, --skip-automation-scripts
- Skip Powershell - Do not run chocolateyUninstall.ps1. Defaults to false.
-
- --ignorepackagecodes, --ignorepackageexitcodes, --ignore-package-codes, --ignore-package-exit-codes
- IgnorePackageExitCodes - Exit with a 0 for success and 1 for non-succes-
- s, no matter what package scripts provide for exit codes. Overrides the
- default feature 'usePackageExitCodes' set to 'True'. Available in 0.-
- 9.10+.
-
- --usepackagecodes, --usepackageexitcodes, --use-package-codes, --use-package-exit-codes
- UsePackageExitCodes - Package scripts can provide exit codes. Use those
- for choco's exit code when non-zero (this value can come from a
- dependency package). Chocolatey defines valid exit codes as 0, 1605,
- 1614, 1641, 3010. Overrides the default feature 'usePackageExitCodes'
- set to 'True'. Available in 0.9.10+.
-
- --autouninstaller, --use-autouninstaller
- UseAutoUninstaller - Use auto uninstaller service when uninstalling.
- Overrides the default feature 'autoUninstaller' set to 'True'. Available
- in 0.9.10+.
-
- --skipautouninstaller, --skip-autouninstaller
- SkipAutoUninstaller - Skip auto uninstaller service when uninstalling.
- Overrides the default feature 'autoUninstaller' set to 'True'. Available
- in 0.9.10+.
-
- --failonautouninstaller, --fail-on-autouninstaller
- FailOnAutoUninstaller - Fail the package uninstall if the auto
- uninstaller reports and error. Overrides the default feature
- 'failOnAutoUninstaller' set to 'False'. Available in 0.9.10+.
-
- --ignoreautouninstallerfailure, --ignore-autouninstaller-failure
- Ignore Auto Uninstaller Failure - Do not fail the package if auto
- uninstaller reports an error. Overrides the default feature
- 'failOnAutoUninstaller' set to 'False'. Available in 0.9.10+.
-
- --stoponfirstfailure, --stop-on-first-failure, --stop-on-first-package-failure
- Stop On First Package Failure - stop running install, upgrade or
- uninstall on first package failure instead of continuing with others.
- Overrides the default feature 'stopOnFirstPackageFailure' set to 'False-
- '. Available in 0.10.4+.
-
- --exitwhenrebootdetected, --exit-when-reboot-detected
- Exit When Reboot Detected - Stop running install, upgrade, or uninstall
- when a reboot request is detected. Requires 'usePackageExitCodes'
- feature to be turned on. Will exit with either 350 or 1604. Overrides
- the default feature 'exitOnRebootDetected' set to 'False'. Available in
- 0.10.12+.
-
- --ignoredetectedreboot, --ignore-detected-reboot
- Ignore Detected Reboot - Ignore any detected reboots if found. Overrides
- the default feature 'exitOnRebootDetected' set to 'False'. Available in
- 0.10.12+.
-
- --fromprograms, --from-programs, --fromprogramsandfeatures, --from-programs-and-features
- From Programs and Features - Uninstalls a program from programs and
- features. Name used for id must be a match or a wildcard (*) to Display
- Name in Programs and Features. Available in [licensed editions](https://chocolatey.org/compare) only
- (licensed version 1.8.0+) and requires v0.10.4+.
-
-~~~
-
-[[Command Reference|CommandsReference]]
-
-
-***NOTE:*** This documentation has been automatically generated from `choco uninstall -h`.
-
diff --git a/docs/generated/CommandsUnpackself.md b/docs/generated/CommandsUnpackself.md
deleted file mode 100644
index 20b2d6cef6..0000000000
--- a/docs/generated/CommandsUnpackself.md
+++ /dev/null
@@ -1,126 +0,0 @@
-
-
-# UnpackSelf Command (choco unpackself)
-
-This will unpack files needed by choco. It will overwrite existing
- files only if --force is specified.
-
-**NOTE:** This command should only be used when installing Chocolatey, not
- during normal operation.
-
-
-## Options and Switches
-
-**NOTE:** Options and switches apply to all items passed, so if you are
- running a command like install that allows installing multiple
- packages, and you use `--version=1.0.0`, it is going to look for and
- try to install version 1.0.0 of every package passed. So please split
- out multiple package calls when wanting to pass specific options.
-
-Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).
-
-~~~
-
- -?, --help, -h
- Prints out the help menu.
-
- -d, --debug
- Debug - Show debug messaging.
-
- -v, --verbose
- Verbose - Show verbose messaging. Very verbose messaging, avoid using
- under normal circumstances.
-
- --trace
- Trace - Show trace messaging. Very, very verbose trace messaging. Avoid
- except when needing super low-level .NET Framework debugging. Available
- in 0.10.4+.
-
- --nocolor, --no-color
- No Color - Do not show colorization in logging output. This overrides
- the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
-
- --acceptlicense, --accept-license
- AcceptLicense - Accept license dialogs automatically. Reserved for
- future use.
-
- -y, --yes, --confirm
- Confirm all prompts - Chooses affirmative answer instead of prompting.
- Implies --accept-license
-
- -f, --force
- Force - force the behavior. Do not use force during normal operation -
- it subverts some of the smart behavior for commands.
-
- --noop, --whatif, --what-if
- NoOp / WhatIf - Don't actually do anything.
-
- -r, --limitoutput, --limit-output
- LimitOutput - Limit the output to essential information
-
- --timeout, --execution-timeout=VALUE
- CommandExecutionTimeout (in seconds) - The time to allow a command to
- finish before timing out. Overrides the default execution timeout in the
- configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
-
- -c, --cache, --cachelocation, --cache-location=VALUE
- CacheLocation - Location for download cache, defaults to %TEMP% or value
- in chocolatey.config file.
-
- --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
- AllowUnofficialBuild - When not using the official build you must set
- this flag for choco to continue.
-
- --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
- FailOnStandardError - Fail on standard error output (stderr), typically
- received when running external commands during install providers. This
- overrides the feature failOnStandardError.
-
- --use-system-powershell
- UseSystemPowerShell - Execute PowerShell using an external process
- instead of the built-in PowerShell host. Should only be used when
- internal host is failing. Available in 0.9.10+.
-
- --no-progress
- Do Not Show Progress - Do not show download progress percentages.
- Available in 0.10.4+.
-
- --proxy=VALUE
- Proxy Location - Explicit proxy location. Overrides the default proxy
- location of ''. Available for config settings in 0.9.9.9+, this CLI
- option available in 0.10.4+.
-
- --proxy-user=VALUE
- Proxy User Name - Explicit proxy user (optional). Requires explicity
- proxy (`--proxy` or config setting). Overrides the default proxy user of
- '123'. Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-password=VALUE
- Proxy Password - Explicit proxy password (optional) to be used with
- username. Requires explicity proxy (`--proxy` or config setting) and
- user name. Overrides the default proxy password (encrypted in settings
- if set). Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-bypass-list=VALUE
- ProxyBypassList - Comma separated list of regex locations to bypass on
- proxy. Requires explicity proxy (`--proxy` or config setting). Overrides
- the default proxy bypass list of ''. Available in 0.10.4+.
-
- --proxy-bypass-on-local
- Proxy Bypass On Local - Bypass proxy for local connections. Requires
- explicity proxy (`--proxy` or config setting). Overrides the default
- proxy bypass on local setting of 'True'. Available in 0.10.4+.
-
- --log-file=VALUE
- Log File to output to in addition to regular loggers. Available in 0.1-
- 0.8+.
-
-~~~
-
-[[Command Reference|CommandsReference]]
-
-
-***NOTE:*** This documentation has been automatically generated from `choco unpackself -h`.
-
diff --git a/docs/generated/CommandsUpdate.md b/docs/generated/CommandsUpdate.md
deleted file mode 100644
index db11443d18..0000000000
--- a/docs/generated/CommandsUpdate.md
+++ /dev/null
@@ -1,134 +0,0 @@
-
-
-# [DEPRECATED] Update Command (choco update)
-
-**NOTE:** Update has been deprecated and will be removed/replaced in version
- 1.0.0 with something that performs the functions of updating package
- indexes. Please use [[`choco upgrade`|Commandsupgrade]] instead.
-
-## Options and Switches
-
-**NOTE:** Options and switches apply to all items passed, so if you are
- running a command like install that allows installing multiple
- packages, and you use `--version=1.0.0`, it is going to look for and
- try to install version 1.0.0 of every package passed. So please split
- out multiple package calls when wanting to pass specific options.
-
-Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).
-
-~~~
-
- -?, --help, -h
- Prints out the help menu.
-
- -d, --debug
- Debug - Show debug messaging.
-
- -v, --verbose
- Verbose - Show verbose messaging. Very verbose messaging, avoid using
- under normal circumstances.
-
- --trace
- Trace - Show trace messaging. Very, very verbose trace messaging. Avoid
- except when needing super low-level .NET Framework debugging. Available
- in 0.10.4+.
-
- --nocolor, --no-color
- No Color - Do not show colorization in logging output. This overrides
- the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
-
- --acceptlicense, --accept-license
- AcceptLicense - Accept license dialogs automatically. Reserved for
- future use.
-
- -y, --yes, --confirm
- Confirm all prompts - Chooses affirmative answer instead of prompting.
- Implies --accept-license
-
- -f, --force
- Force - force the behavior. Do not use force during normal operation -
- it subverts some of the smart behavior for commands.
-
- --noop, --whatif, --what-if
- NoOp / WhatIf - Don't actually do anything.
-
- -r, --limitoutput, --limit-output
- LimitOutput - Limit the output to essential information
-
- --timeout, --execution-timeout=VALUE
- CommandExecutionTimeout (in seconds) - The time to allow a command to
- finish before timing out. Overrides the default execution timeout in the
- configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
-
- -c, --cache, --cachelocation, --cache-location=VALUE
- CacheLocation - Location for download cache, defaults to %TEMP% or value
- in chocolatey.config file.
-
- --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
- AllowUnofficialBuild - When not using the official build you must set
- this flag for choco to continue.
-
- --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
- FailOnStandardError - Fail on standard error output (stderr), typically
- received when running external commands during install providers. This
- overrides the feature failOnStandardError.
-
- --use-system-powershell
- UseSystemPowerShell - Execute PowerShell using an external process
- instead of the built-in PowerShell host. Should only be used when
- internal host is failing. Available in 0.9.10+.
-
- --no-progress
- Do Not Show Progress - Do not show download progress percentages.
- Available in 0.10.4+.
-
- --proxy=VALUE
- Proxy Location - Explicit proxy location. Overrides the default proxy
- location of ''. Available for config settings in 0.9.9.9+, this CLI
- option available in 0.10.4+.
-
- --proxy-user=VALUE
- Proxy User Name - Explicit proxy user (optional). Requires explicity
- proxy (`--proxy` or config setting). Overrides the default proxy user of
- '123'. Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-password=VALUE
- Proxy Password - Explicit proxy password (optional) to be used with
- username. Requires explicity proxy (`--proxy` or config setting) and
- user name. Overrides the default proxy password (encrypted in settings
- if set). Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-bypass-list=VALUE
- ProxyBypassList - Comma separated list of regex locations to bypass on
- proxy. Requires explicity proxy (`--proxy` or config setting). Overrides
- the default proxy bypass list of ''. Available in 0.10.4+.
-
- --proxy-bypass-on-local
- Proxy Bypass On Local - Bypass proxy for local connections. Requires
- explicity proxy (`--proxy` or config setting). Overrides the default
- proxy bypass on local setting of 'True'. Available in 0.10.4+.
-
- --log-file=VALUE
- Log File to output to in addition to regular loggers. Available in 0.1-
- 0.8+.
-
- -s, --source=VALUE
- Source - The source to find the package(s) to install. Special sources
- include: ruby, webpi, cygwin, windowsfeatures, and python. Defaults to
- default feeds.
-
- --version=VALUE
- Version - A specific version to install. Defaults to unspecified.
-
- --pre, --prerelease
- Prerelease - Include Prereleases? Defaults to false.
-
-~~~
-
-[[Command Reference|CommandsReference]]
-
-
-***NOTE:*** This documentation has been automatically generated from `choco update -h`.
-
diff --git a/docs/generated/CommandsUpgrade.md b/docs/generated/CommandsUpgrade.md
deleted file mode 100644
index ef5fd2e66c..0000000000
--- a/docs/generated/CommandsUpgrade.md
+++ /dev/null
@@ -1,463 +0,0 @@
-
-
-# Upgrade Command (choco upgrade)
-
-Upgrades a package or a list of packages. Some may prefer to use `cup`
- as a shortcut for [[`choco upgrade`|Commandsupgrade]]. If you do not have a package
- installed, upgrade will install it.
-
-**NOTE:** 100% compatible with older Chocolatey client (0.9.8.x and below)
- with options and switches. Add `-y` for previous behavior with no
- prompt. In most cases you can still pass options and switches with one
- dash (`-`). For more details, see [[how to pass arguments|CommandsReference#how-to-pass-options--switches]] (`choco -?`).
-
-## Usage
-
- choco upgrade [] []
- cup [] []
-
-**NOTE:** `all` is a special package keyword that will allow you to upgrade
- all currently installed packages.
-
-Skip upgrading certain packages with [[`choco pin`|Commandspin]] or with the option
- `--except`.
-
-**NOTE:** [Chocolatey Pro](https://chocolatey.org/compare) / Business automatically synchronizes with
- Programs and Features, ensuring automatically updating apps' versions
- (like Chrome) are up to date in Chocolatey's repository.
-
-## Examples
-
- choco upgrade chocolatey
- choco upgrade notepadplusplus googlechrome atom 7zip
- choco upgrade notepadplusplus googlechrome atom 7zip -dvfy
- choco upgrade git -y --params="'/GitAndUnixToolsOnPath /NoAutoCrlf'"
- choco upgrade git -y --params="'/GitAndUnixToolsOnPath /NoAutoCrlf'" --install-args="'/DIR=C:\git'"
- # Params are package parameters, passed to the package
- # Install args are installer arguments, appended to the silentArgs
- # in the package for the installer itself
- choco upgrade nodejs.install --version 0.10.35
- choco upgrade git -s "'https://somewhere/out/there'"
- choco upgrade git -s "'https://somewhere/protected'" -u user -p pass
- choco upgrade all
- choco upgrade all --except="'skype,conemu'"
-
-**NOTE:** See scripting in [[how to pass arguments|CommandsReference#how-to-pass-options--switches]] (`choco -?`) for how to
- write proper scripts and integrations.
-
-
-## Exit Codes
-
-Exit codes that normally result from running this command.
-
-Normal:
- - 0: operation was successful, no issues detected
- - -1 or 1: an error has occurred
-
-Package Exit Codes:
- - 1641: success, reboot initiated
- - 3010: success, reboot required
- - other (not listed): likely an error has occurred
-
-In addition to normal exit codes, packages are allowed to exit
- with their own codes when the feature 'usePackageExitCodes' is
- turned on. Uninstall command has additional valid exit codes.
- Available in v0.9.10+.
-
-Reboot Exit Codes:
- - 350: pending reboot detected, no action has occurred
- - 1604: install suspended, incomplete
-
-In addition to the above exit codes, you may also see reboot exit codes
- when the feature 'exitOnRebootDetected' is turned on. It typically requires
- the feature 'usePackageExitCodes' to also be turned on to work properly.
- Available in v0.10.12+.
-
-## See It In Action
-
-
-
-
-## Options and Switches
-
-**NOTE:** Options and switches apply to all items passed, so if you are
- running a command like install that allows installing multiple
- packages, and you use `--version=1.0.0`, it is going to look for and
- try to install version 1.0.0 of every package passed. So please split
- out multiple package calls when wanting to pass specific options.
-
-Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).
-
-~~~
-
-
-
- -?, --help, -h
- Prints out the help menu.
-
- -d, --debug
- Debug - Show debug messaging.
-
- -v, --verbose
- Verbose - Show verbose messaging. Very verbose messaging, avoid using
- under normal circumstances.
-
- --trace
- Trace - Show trace messaging. Very, very verbose trace messaging. Avoid
- except when needing super low-level .NET Framework debugging. Available
- in 0.10.4+.
-
- --nocolor, --no-color
- No Color - Do not show colorization in logging output. This overrides
- the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
-
- --acceptlicense, --accept-license
- AcceptLicense - Accept license dialogs automatically. Reserved for
- future use.
-
- -y, --yes, --confirm
- Confirm all prompts - Chooses affirmative answer instead of prompting.
- Implies --accept-license
-
- -f, --force
- Force - force the behavior. Do not use force during normal operation -
- it subverts some of the smart behavior for commands.
-
- --noop, --whatif, --what-if
- NoOp / WhatIf - Don't actually do anything.
-
- -r, --limitoutput, --limit-output
- LimitOutput - Limit the output to essential information
-
- --timeout, --execution-timeout=VALUE
- CommandExecutionTimeout (in seconds) - The time to allow a command to
- finish before timing out. Overrides the default execution timeout in the
- configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
-
- -c, --cache, --cachelocation, --cache-location=VALUE
- CacheLocation - Location for download cache, defaults to %TEMP% or value
- in chocolatey.config file.
-
- --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
- AllowUnofficialBuild - When not using the official build you must set
- this flag for choco to continue.
-
- --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
- FailOnStandardError - Fail on standard error output (stderr), typically
- received when running external commands during install providers. This
- overrides the feature failOnStandardError.
-
- --use-system-powershell
- UseSystemPowerShell - Execute PowerShell using an external process
- instead of the built-in PowerShell host. Should only be used when
- internal host is failing. Available in 0.9.10+.
-
- --no-progress
- Do Not Show Progress - Do not show download progress percentages.
- Available in 0.10.4+.
-
- --proxy=VALUE
- Proxy Location - Explicit proxy location. Overrides the default proxy
- location of ''. Available for config settings in 0.9.9.9+, this CLI
- option available in 0.10.4+.
-
- --proxy-user=VALUE
- Proxy User Name - Explicit proxy user (optional). Requires explicity
- proxy (`--proxy` or config setting). Overrides the default proxy user of
- '123'. Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-password=VALUE
- Proxy Password - Explicit proxy password (optional) to be used with
- username. Requires explicity proxy (`--proxy` or config setting) and
- user name. Overrides the default proxy password (encrypted in settings
- if set). Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-bypass-list=VALUE
- ProxyBypassList - Comma separated list of regex locations to bypass on
- proxy. Requires explicity proxy (`--proxy` or config setting). Overrides
- the default proxy bypass list of ''. Available in 0.10.4+.
-
- --proxy-bypass-on-local
- Proxy Bypass On Local - Bypass proxy for local connections. Requires
- explicity proxy (`--proxy` or config setting). Overrides the default
- proxy bypass on local setting of 'True'. Available in 0.10.4+.
-
- --log-file=VALUE
- Log File to output to in addition to regular loggers. Available in 0.1-
- 0.8+.
-
- -s, --source=VALUE
- Source - The source to find the package(s) to install. Special sources
- include: ruby, webpi, cygwin, windowsfeatures, and python. To specify
- more than one source, pass it with a semi-colon separating the values (-
- e.g. "'source1;source2'"). Defaults to default feeds.
-
- --version=VALUE
- Version - A specific version to install. Defaults to unspecified.
-
- --pre, --prerelease
- Prerelease - Include Prereleases? Defaults to false.
-
- --x86, --forcex86
- ForceX86 - Force x86 (32bit) installation on 64 bit systems. Defaults to
- false.
-
- --ia, --installargs, --installarguments, --install-arguments=VALUE
- InstallArguments - Install Arguments to pass to the native installer in
- the package. Defaults to unspecified.
-
- -o, --override, --overrideargs, --overridearguments, --override-arguments
- OverrideArguments - Should install arguments be used exclusively without
- appending to current package passed arguments? Defaults to false.
-
- --notsilent, --not-silent
- NotSilent - Do not install this silently. Defaults to false.
-
- --params, --parameters, --pkgparameters, --packageparameters, --package-parameters=VALUE
- PackageParameters - Parameters to pass to the package. Defaults to
- unspecified.
-
- --argsglobal, --args-global, --installargsglobal, --install-args-global, --applyargstodependencies, --apply-args-to-dependencies, --apply-install-arguments-to-dependencies
- Apply Install Arguments To Dependencies - Should install arguments be
- applied to dependent packages? Defaults to false.
-
- --paramsglobal, --params-global, --packageparametersglobal, --package-parameters-global, --applyparamstodependencies, --apply-params-to-dependencies, --apply-package-parameters-to-dependencies
- Apply Package Parameters To Dependencies - Should package parameters be
- applied to dependent packages? Defaults to false.
-
- --allowdowngrade, --allow-downgrade
- AllowDowngrade - Should an attempt at downgrading be allowed? Defaults
- to false.
-
- -m, --sxs, --sidebyside, --side-by-side, --allowmultiple, --allow-multiple, --allowmultipleversions, --allow-multiple-versions
- AllowMultipleVersions - Should multiple versions of a package be
- installed? Defaults to false.
-
- -i, --ignoredependencies, --ignore-dependencies
- IgnoreDependencies - Ignore dependencies when upgrading package(s).
- Defaults to false.
-
- -n, --skippowershell, --skip-powershell, --skipscripts, --skip-scripts, --skip-automation-scripts
- Skip Powershell - Do not run chocolateyInstall.ps1. Defaults to false.
-
- --failonunfound, --fail-on-unfound
- Fail On Unfound Packages - If a package is not found in sources
- specified, fail instead of warn.
-
- --ignore-unfound
- Ignore Unfound Packages - Ignore packages that are not found on the
- sources used (or the defaults). Overrides the default feature
- 'ignoreUnfoundPackagesOnUpgradeOutdated' set to 'False'. Available in -
- 0.10.9+.
-
- --failonnotinstalled, --fail-on-not-installed
- Fail On Non-installed Packages - If a package is not already installed,
- fail instead of installing.
-
- -u, --user=VALUE
- User - used with authenticated feeds. Defaults to empty.
-
- -p, --password=VALUE
- Password - the user's password to the source. Defaults to empty.
-
- --cert=VALUE
- Client certificate - PFX pathname for an x509 authenticated feeds.
- Defaults to empty. Available in 0.9.10+.
-
- --cp, --certpassword=VALUE
- Certificate Password - the client certificate's password to the source.
- Defaults to empty. Available in 0.9.10+.
-
- --ignorechecksum, --ignore-checksum, --ignorechecksums, --ignore-checksums
- IgnoreChecksums - Ignore checksums provided by the package. Overrides
- the default feature 'checksumFiles' set to 'True'. Available in 0.9.9.9+.
-
- --allowemptychecksum, --allowemptychecksums, --allow-empty-checksums
- Allow Empty Checksums - Allow packages to have empty/missing checksums
- for downloaded resources from non-secure locations (HTTP, FTP). Use this
- switch is not recommended if using sources that download resources from
- the internet. Overrides the default feature 'allowEmptyChecksums' set to
- 'False'. Available in 0.10.0+.
-
- --allowemptychecksumsecure, --allowemptychecksumssecure, --allow-empty-checksums-secure
- Allow Empty Checksums Secure - Allow packages to have empty checksums
- for downloaded resources from secure locations (HTTPS). Overrides the
- default feature 'allowEmptyChecksumsSecure' set to 'True'. Available in
- 0.10.0+.
-
- --requirechecksum, --requirechecksums, --require-checksums
- Require Checksums - Requires packages to have checksums for downloaded
- resources (both non-secure and secure). Overrides the default feature
- 'allowEmptyChecksums' set to 'False' and 'allowEmptyChecksumsSecure' set
- to 'True'. Available in 0.10.0+.
-
- --checksum, --downloadchecksum, --download-checksum=VALUE
- Download Checksum - a user provided checksum for downloaded resources
- for the package. Overrides the package checksum (if it has one).
- Defaults to empty. Available in 0.10.0+.
-
- --checksum64, --checksumx64, --downloadchecksumx64, --download-checksum-x64=VALUE
- Download Checksum 64bit - a user provided checksum for 64bit downloaded
- resources for the package. Overrides the package 64-bit checksum (if it
- has one). Defaults to same as Download Checksum. Available in 0.10.0+.
-
- --checksumtype, --checksum-type, --downloadchecksumtype, --download-checksum-type=VALUE
- Download Checksum Type - a user provided checksum type. Overrides the
- package checksum type (if it has one). Used in conjunction with Download
- Checksum. Available values are 'md5', 'sha1', 'sha256' or 'sha512'.
- Defaults to 'md5'. Available in 0.10.0+.
-
- --checksumtype64, --checksumtypex64, --checksum-type-x64, --downloadchecksumtypex64, --download-checksum-type-x64=VALUE
- Download Checksum Type 64bit - a user provided checksum for 64bit
- downloaded resources for the package. Overrides the package 64-bit
- checksum (if it has one). Used in conjunction with Download Checksum
- 64bit. Available values are 'md5', 'sha1', 'sha256' or 'sha512'.
- Defaults to same as Download Checksum Type. Available in 0.10.0+.
-
- --ignorepackagecodes, --ignorepackageexitcodes, --ignore-package-codes, --ignore-package-exit-codes
- IgnorePackageExitCodes - Exit with a 0 for success and 1 for non-succes-
- s, no matter what package scripts provide for exit codes. Overrides the
- default feature 'usePackageExitCodes' set to 'True'. Available in 0.-
- 9.10+.
-
- --usepackagecodes, --usepackageexitcodes, --use-package-codes, --use-package-exit-codes
- UsePackageExitCodes - Package scripts can provide exit codes. Use those
- for choco's exit code when non-zero (this value can come from a
- dependency package). Chocolatey defines valid exit codes as 0, 1605,
- 1614, 1641, 3010. Overrides the default feature 'usePackageExitCodes'
- set to 'True'. Available in 0.9.10+.
-
- --except=VALUE
- Except - a comma-separated list of package names that should not be
- upgraded when upgrading 'all'. Defaults to empty. Available in 0.9.10+.
-
- --stoponfirstfailure, --stop-on-first-failure, --stop-on-first-package-failure
- Stop On First Package Failure - stop running install, upgrade or
- uninstall on first package failure instead of continuing with others.
- Overrides the default feature 'stopOnFirstPackageFailure' set to 'False-
- '. Available in 0.10.4+.
-
- --skip-if-not-installed, --only-upgrade-installed, --skip-when-not-installed
- Skip Packages Not Installed - if a package is not installed, do not
- install it during the upgrade process. Overrides the default feature
- 'skipPackageUpgradesWhenNotInstalled' set to 'False'. Available in 0.1-
- 0.12+.
-
- --install-if-not-installed
- Install Missing Packages When Not Installed - if a package is not
- installed, install it as part of running upgrade (typically default
- behavior). Overrides the default feature
- 'skipPackageUpgradesWhenNotInstalled' set to 'False'. Available in 0.1-
- 0.12+.
-
- --exclude-pre, --exclude-prerelease, --exclude-prereleases
- Exclude Prerelease - Should prerelease be ignored for upgrades? Will be
- ignored if you pass `--pre`. Available in 0.10.4+.
-
- --userememberedargs, --userememberedarguments, --userememberedoptions, --use-remembered-args, --use-remembered-arguments, --use-remembered-options
- Use Remembered Options for Upgrade - use the arguments and options used
- during install for upgrade. Does not override arguments being passed at
- runtime. Overrides the default feature
- 'useRememberedArgumentsForUpgrades' set to 'False'. Available in 0.10.4+.
-
- --ignorerememberedargs, --ignorerememberedarguments, --ignorerememberedoptions, --ignore-remembered-args, --ignore-remembered-arguments, --ignore-remembered-options
- Ignore Remembered Options for Upgrade - ignore the arguments and options
- used during install for upgrade. Overrides the default feature
- 'useRememberedArgumentsForUpgrades' set to 'False'. Available in 0.10.4+.
-
- --exitwhenrebootdetected, --exit-when-reboot-detected
- Exit When Reboot Detected - Stop running install, upgrade, or uninstall
- when a reboot request is detected. Requires 'usePackageExitCodes'
- feature to be turned on. Will exit with either 350 or 1604. Overrides
- the default feature 'exitOnRebootDetected' set to 'False'. Available in
- 0.10.12+.
-
- --ignoredetectedreboot, --ignore-detected-reboot
- Ignore Detected Reboot - Ignore any detected reboots if found. Overrides
- the default feature 'exitOnRebootDetected' set to 'False'. Available in
- 0.10.12+.
-
- --sdc, --skipdownloadcache, --skip-download-cache
- Skip Download Cache - Use the original download even if a private CDN
- cache is available for a package. Overrides the default feature
- 'downloadCache' set to 'True'. Available in 0.9.10+. [Licensed editions](https://chocolatey.org/compare)
- only. See https://chocolatey.org/docs/features-private-cdn
-
- --dc, --downloadcache, --download-cache, --use-download-cache
- Use Download Cache - Use private CDN cache if available for a package.
- Overrides the default feature 'downloadCache' set to 'True'. Available
- in 0.9.10+. [Licensed editions](https://chocolatey.org/compare) only. See https://chocolate-
- y.org/docs/features-private-cdn
-
- --svc, --skipvirus, --skip-virus, --skipviruscheck, --skip-virus-check
- Skip Virus Check - Skip the virus check for downloaded files on this ru-
- n. Overrides the default feature 'virusCheck' set to 'True'. Available
- in 0.9.10+. [Licensed editions](https://chocolatey.org/compare) only. See https://chocolate-
- y.org/docs/features-virus-check
-
- --virus, --viruscheck, --virus-check
- Virus Check - check downloaded files for viruses. Overrides the default
- feature 'virusCheck' set to 'True'. Available in 0.9.10+. Licensed
- editions only. See https://chocolatey.org/docs/features-virus-check
-
- --viruspositivesmin, --virus-positives-minimum=VALUE
- Virus Check Minimum Scan Result Positives - the minimum number of scan
- result positives required to flag a package. Used when virusScannerType
- is VirusTotal. Overrides the default configuration value
- 'virusCheckMinimumPositives' set to '5'. Available in 0.9.10+. Licensed
- editions only. See https://chocolatey.org/docs/features-virus-check
-
- --install-arguments-sensitive=VALUE
- InstallArgumentsSensitive - Install Arguments to pass to the native
- installer in the package that are sensitive and you do not want logged.
- Defaults to unspecified. Available in 0.10.1+. [Licensed editions](https://chocolatey.org/compare) only.
-
- --package-parameters-sensitive=VALUE
- PackageParametersSensitive - Package Parameters to pass the package that
- are sensitive and you do not want logged. Defaults to unspecified.
- Available in 0.10.1+. [Licensed editions](https://chocolatey.org/compare) only.
-
- --dir, --directory, --installdir, --installdirectory, --install-dir, --install-directory=VALUE
- Install Directory Override - Override the default installation director-
- y. Chocolatey will automatically determine the type of installer and
- pass the appropriate arguments to override the install directory. The
- package must use Chocolatey install helpers and be installing an
- installer for software. Available in 0.9.10+. [Licensed editions](https://chocolatey.org/compare) only.
- See https://chocolatey.org/docs/features-install-directory-override
-
- --bps, --maxdownloadrate, --max-download-rate, --maxdownloadbitspersecond, --max-download-bits-per-second, --maximumdownloadbitspersecond, --maximum-download-bits-per-second=VALUE
- Maximum Download Rate Bits Per Second - The maximum download rate in
- bits per second. '0' or empty means no maximum. A number means that will
- be the maximum download rate in bps. Defaults to config setting of '0'.
- Available in [licensed editions](https://chocolatey.org/compare) v1.10+ only. See https://chocolate-
- y.org/docs/features-package-throttle
-
- --reduce, --reduce-package-size, --deflate, --deflate-package-size
- Reducer Installed Package Size (Package Reducer) - Reduce size of the
- nupkg file to very small and remove extracted archives and installers.
- Overrides the default feature 'reduceInstalledPackageSpaceUsage' set to
- 'True'. [Licensed editions](https://chocolatey.org/compare) only (version 1.12.0+). See https://chocolate-
- y.org/docs/features-package-reducer
-
- --no-reduce, --no-reduce-package-size, --no-deflate, --no-deflate-package-size
- Do Not Reduce Installed Package Size - Leave the nupkg and files alone
- in the package. Overrides the default feature
- 'reduceInstalledPackageSpaceUsage' set to 'True'. [Licensed editions](https://chocolatey.org/compare) only
- (version 1.12.0+). See https://chocolatey.org/docs/features-package-
- reducer
-
- --reduce-nupkg-only, --deflate-nupkg-only
- Reduce Only Nupkg File Size - reduce only the size of nupkg file when
- using Package Reducer. Overrides the default feature
- 'reduceOnlyNupkgSize' set to 'False'. [Licensed editions](https://chocolatey.org/compare) only (version -
- 1.12.0+). See https://chocolatey.org/docs/features-package-reducer
-
-~~~
-
-[[Command Reference|CommandsReference]]
-
-
-***NOTE:*** This documentation has been automatically generated from `choco upgrade -h`.
-
diff --git a/docs/generated/CommandsVersion.md b/docs/generated/CommandsVersion.md
deleted file mode 100644
index 3ec5dc94f9..0000000000
--- a/docs/generated/CommandsVersion.md
+++ /dev/null
@@ -1,138 +0,0 @@
-
-
-# [DEPRECATED] Version Command (choco version)
-
-**NOTE:** Version has been deprecated and will be removed in version 1.0.0.
-
- If you are attempting to get local installed items, use
- `choco list -lo`.
-
- If you want to know what has available upgrades, use
- `choco upgrade -whatif` or [[`choco outdated`|Commandsoutdated]].
-
-## Options and Switches
-
-**NOTE:** Options and switches apply to all items passed, so if you are
- running a command like install that allows installing multiple
- packages, and you use `--version=1.0.0`, it is going to look for and
- try to install version 1.0.0 of every package passed. So please split
- out multiple package calls when wanting to pass specific options.
-
-Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).
-
-~~~
-
- -?, --help, -h
- Prints out the help menu.
-
- -d, --debug
- Debug - Show debug messaging.
-
- -v, --verbose
- Verbose - Show verbose messaging. Very verbose messaging, avoid using
- under normal circumstances.
-
- --trace
- Trace - Show trace messaging. Very, very verbose trace messaging. Avoid
- except when needing super low-level .NET Framework debugging. Available
- in 0.10.4+.
-
- --nocolor, --no-color
- No Color - Do not show colorization in logging output. This overrides
- the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
-
- --acceptlicense, --accept-license
- AcceptLicense - Accept license dialogs automatically. Reserved for
- future use.
-
- -y, --yes, --confirm
- Confirm all prompts - Chooses affirmative answer instead of prompting.
- Implies --accept-license
-
- -f, --force
- Force - force the behavior. Do not use force during normal operation -
- it subverts some of the smart behavior for commands.
-
- --noop, --whatif, --what-if
- NoOp / WhatIf - Don't actually do anything.
-
- -r, --limitoutput, --limit-output
- LimitOutput - Limit the output to essential information
-
- --timeout, --execution-timeout=VALUE
- CommandExecutionTimeout (in seconds) - The time to allow a command to
- finish before timing out. Overrides the default execution timeout in the
- configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
-
- -c, --cache, --cachelocation, --cache-location=VALUE
- CacheLocation - Location for download cache, defaults to %TEMP% or value
- in chocolatey.config file.
-
- --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
- AllowUnofficialBuild - When not using the official build you must set
- this flag for choco to continue.
-
- --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
- FailOnStandardError - Fail on standard error output (stderr), typically
- received when running external commands during install providers. This
- overrides the feature failOnStandardError.
-
- --use-system-powershell
- UseSystemPowerShell - Execute PowerShell using an external process
- instead of the built-in PowerShell host. Should only be used when
- internal host is failing. Available in 0.9.10+.
-
- --no-progress
- Do Not Show Progress - Do not show download progress percentages.
- Available in 0.10.4+.
-
- --proxy=VALUE
- Proxy Location - Explicit proxy location. Overrides the default proxy
- location of ''. Available for config settings in 0.9.9.9+, this CLI
- option available in 0.10.4+.
-
- --proxy-user=VALUE
- Proxy User Name - Explicit proxy user (optional). Requires explicity
- proxy (`--proxy` or config setting). Overrides the default proxy user of
- '123'. Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-password=VALUE
- Proxy Password - Explicit proxy password (optional) to be used with
- username. Requires explicity proxy (`--proxy` or config setting) and
- user name. Overrides the default proxy password (encrypted in settings
- if set). Available for config settings in 0.9.9.9+, this CLI option
- available in 0.10.4+.
-
- --proxy-bypass-list=VALUE
- ProxyBypassList - Comma separated list of regex locations to bypass on
- proxy. Requires explicity proxy (`--proxy` or config setting). Overrides
- the default proxy bypass list of ''. Available in 0.10.4+.
-
- --proxy-bypass-on-local
- Proxy Bypass On Local - Bypass proxy for local connections. Requires
- explicity proxy (`--proxy` or config setting). Overrides the default
- proxy bypass on local setting of 'True'. Available in 0.10.4+.
-
- --log-file=VALUE
- Log File to output to in addition to regular loggers. Available in 0.1-
- 0.8+.
-
- -s, --source=VALUE
- Source - The source to find the package(s) to install. Special sources
- include: ruby, webpi, cygwin, windowsfeatures, and python. Defaults to
- default feeds.
-
- --lo, --localonly
- LocalOnly - Only search against local machine items.
-
- --pre, --prerelease
- Prerelease - Include Prereleases? Defaults to false.
-
-~~~
-
-[[Command Reference|CommandsReference]]
-
-
-***NOTE:*** This documentation has been automatically generated from `choco version -h`.
-
diff --git a/docs/generated/HelpersFormatFileSize.md b/docs/generated/HelpersFormatFileSize.md
deleted file mode 100644
index 6a2756eeb5..0000000000
--- a/docs/generated/HelpersFormatFileSize.md
+++ /dev/null
@@ -1,84 +0,0 @@
-# Format-FileSize
-
-
-
-DO NOT USE. Not part of the public API.
-
-## Syntax
-
-~~~powershell
-Format-FileSize `
- -Size `
- [-IgnoredArguments ] []
-~~~
-
-## Description
-
-Formats file size into a human readable format.
-
-## Notes
-
-Available in 0.9.10+.
-
-This function is not part of the API.
-
-## Aliases
-
-None
-
-## Examples
-
- **EXAMPLE 1**
-
-~~~powershell
-Format-FileSize -Size $fileSizeBytes
-
-~~~
-
-## Inputs
-
-None
-
-## Outputs
-
-None
-
-## Parameters
-
-### -Size <Double>
-The size of a file in bytes.
-
-Property | Value
----------------------- | -----
-Aliases |
-Required? | true
-Position? | 1
-Default Value | 0
-Accept Pipeline Input? | false
-
-### -IgnoredArguments [<Object[]>]
-Allows splatting with arguments that do not apply. Do not use directly.
-
-Property | Value
----------------------- | -----
-Aliases |
-Required? | false
-Position? | named
-Default Value |
-Accept Pipeline Input? | false
-
-### <CommonParameters>
-
-This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see `about_CommonParameters` http://go.microsoft.com/fwlink/p/?LinkID=113216 .
-
-
-## Links
-
- * [[Get-WebFile|HelpersGetWebFile]]
-
-
-[[Function Reference|HelpersReference]]
-
-***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Format-FileSize -Full`.
-
-View the source for [Format-FileSize](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Format-FileSize.ps1)
diff --git a/docs/generated/HelpersGetChecksumValid.md b/docs/generated/HelpersGetChecksumValid.md
deleted file mode 100644
index d716f40de2..0000000000
--- a/docs/generated/HelpersGetChecksumValid.md
+++ /dev/null
@@ -1,181 +0,0 @@
-# Get-ChecksumValid
-
-
-
-Checks a file's checksum versus a passed checksum and checksum type.
-
-## Syntax
-
-~~~powershell
-Get-ChecksumValid `
- -File `
- [-Checksum ] `
- [-ChecksumType ] `
- [-OriginalUrl ] `
- [-IgnoredArguments ] []
-~~~
-
-## Description
-
-Makes a determination if a file meets an expected checksum signature.
-This function is usually used when comparing a file that is downloaded
-from an official distribution point. If the checksum fails to match the
-expected output, this function throws an error.
-
-Checksums have been used for years as a means of verification. A
-checksum hash is a unique value or signature that corresponds to the
-contents of a file. File names and extensions can be altered without
-changing the checksum signature. However if you changed the contents of
-the file, even one character, the checksum will be different.
-
-Checksums are used to provide as a means of cryptographically ensuring
-the contents of a file have not been changed. While some cryptographic
-algorithms, including MD5 and SHA1, are no longer considered secure
-against attack, the goal of a checksum algorithm is to make it
-extremely difficult (near impossible with better algorithms) to alter
-the contents of a file (whether by accident or for malicious reasons)
-and still result in the same checksum signature.
-
-When verifying a checksum using a secure algorithm, if the checksum
-matches the expected signature, the contents of the file are identical
-to what is expected.
-
-## Notes
-
-This uses the checksum.exe tool available separately at
-https://chocolatey.org/packages/checksum.
-
-Options that affect checksum verification:
-
-* `--ignore-checksums` - skips checksumming
-* `--allow-empty-checksums` - skips checksumming when the package is missing a checksum
-* `--allow-empty-checksums-secure` - skips checksumming when the package is missing a checksum for secure (HTTPS) locations
-* `--require-checksums` - requires checksums for both non-secure and secure locations
-* `--download-checksum`, `--download-checksum-type` - allows user to pass their own checksums
-* `--download-checksum-x64`, `--download-checksum-type-x64` - allows user to pass their own checksums
-
-Features that affect checksum verification:
-
-* `checksumFiles` - when turned off, skips checksumming
-* `allowEmptyChecksums` - when turned on, skips checksumming when the package is missing a checksum
-* `allowEmptyChecksumsSecure` - when turned on, skips checksumming when the package is missing a checksum for secure (HTTPS) locations
-
-## Aliases
-
-None
-
-## Examples
-
- **EXAMPLE 1**
-
-~~~powershell
-Get-ChecksumValid -File $fileFullPath -CheckSum $checksum -ChecksumType $checksumType
-
-~~~
-
-## Inputs
-
-None
-
-## Outputs
-
-None
-
-## Parameters
-
-### -File <String>
-The full path to a binary file that is checksummed and compared to the
-passed Checksum parameter value.
-
-Property | Value
----------------------- | -----
-Aliases |
-Required? | true
-Position? | 1
-Default Value |
-Accept Pipeline Input? | false
-
-### -Checksum [<String>]
-The expected checksum hash value of the File resource. The checksum
-type is covered by ChecksumType.
-
-**NOTE:** Checksums in packages are meant as a measure to validate the
-originally intended file that was used in the creation of a package is
-the same file that is received at a future date. Since this is used for
-other steps in the process related to the [community repository](https://chocolatey.org/packages), it
-ensures that the file a user receives is the same file a maintainer
-and a moderator (if applicable), plus any moderation review has
-intended for you to receive with this package. If you are looking at a
-remote source that uses the same url for updates, you will need to
-ensure the package also stays updated in line with those remote
-resource updates. You should look into [automatic packaging](https://chocolatey.org/docs/automatic-packages)
-to help provide that functionality.
-
-**NOTE:** To determine checksums, you can get that from the original
-site if provided. You can also use the [checksum tool available on
-the [community feed](https://chocolatey.org/packages)](https://chocolatey.org/packages/checksum) (`choco install checksum`)
-and use it e.g. `checksum -t sha256 -f path\to\file`. Ensure you
-provide checksums for all remote resources used.
-
-Property | Value
----------------------- | -----
-Aliases |
-Required? | false
-Position? | 2
-Default Value |
-Accept Pipeline Input? | false
-
-### -ChecksumType [<String>]
-The type of checkum that the file is validated with - 'md5', 'sha1',
-'sha256' or 'sha512' - defaults to 'md5'.
-
-MD5 is not recommended as certain organizations need to use FIPS
-compliant algorithms for hashing - see
-https://support.microsoft.com/en-us/kb/811833 for more details.
-
-The recommendation is to use at least SHA256.
-
-Property | Value
----------------------- | -----
-Aliases |
-Required? | false
-Position? | 3
-Default Value | md5
-Accept Pipeline Input? | false
-
-### -OriginalUrl [<String>]
-Property | Value
----------------------- | -----
-Aliases |
-Required? | false
-Position? | 4
-Default Value |
-Accept Pipeline Input? | false
-
-### -IgnoredArguments [<Object[]>]
-Allows splatting with arguments that do not apply. Do not use directly.
-
-Property | Value
----------------------- | -----
-Aliases |
-Required? | false
-Position? | named
-Default Value |
-Accept Pipeline Input? | false
-
-### <CommonParameters>
-
-This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see `about_CommonParameters` http://go.microsoft.com/fwlink/p/?LinkID=113216 .
-
-
-## Links
-
- * [[Get-ChocolateyWebFile|HelpersGetChocolateyWebFile]]
- * [[Install-ChocolateyPackage|HelpersInstallChocolateyPackage]]
-
-
-[[Function Reference|HelpersReference]]
-
-***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Get-ChecksumValid -Full`.
-
-View the source for [Get-ChecksumValid](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Get-ChecksumValid.ps1)
diff --git a/docs/generated/HelpersGetChocolateyUnzip.md b/docs/generated/HelpersGetChocolateyUnzip.md
deleted file mode 100644
index 6e5d093816..0000000000
--- a/docs/generated/HelpersGetChocolateyUnzip.md
+++ /dev/null
@@ -1,160 +0,0 @@
-# Get-ChocolateyUnzip
-
-
-
-Unzips an archive file and returns the location for further processing.
-
-## Syntax
-
-~~~powershell
-Get-ChocolateyUnzip `
- [-FileFullPath ] `
- -Destination `
- [-SpecificFolder ] `
- [-PackageName ] `
- [-FileFullPath64 ] `
- [-IgnoredArguments ] []
-~~~
-
-## Description
-
-This unzips files using the 7-zip command line tool 7z.exe.
-Supported archive formats are listed at:
-https://sevenzip.osdn.jp/chm/general/formats.htm
-Prior to 0.9.10.1, 7za.exe was used. Supported archive formats for
-7za.exe are: 7z, lzma, cab, zip, gzip, bzip2, and tar.
-
-## Notes
-
-If extraction fails, an exception is thrown.
-
-If you are embedding files into a package, ensure that you have the
-rights to redistribute those files if you are sharing this package
-publicly (like on the [community feed](https://chocolatey.org/packages)). Otherwise, please use
-Install-ChocolateyZipPackage to download those resources from their
-official distribution points.
-
-Starting in 0.9.10, will automatically call Set-PowerShellExitCode to
-set the package exit code based on 7-zip's exit code.
-
-## Aliases
-
-None
-
-## Examples
-
- **EXAMPLE 1**
-
-~~~powershell
-
-# Path to the folder where the script is executing
-$toolsDir = (Split-Path -parent $MyInvocation.MyCommand.Definition)
-Get-ChocolateyUnzip -FileFullPath "c:\someFile.zip" -Destination $toolsDir
-~~~
-
-## Inputs
-
-None
-
-## Outputs
-
-None
-
-## Parameters
-
-### -FileFullPath [<String>]
-This is the full path to the zip file. If embedding it in the package
-next to the install script, the path will be like
-`"$(Split-Path -Parent $MyInvocation.MyCommand.Definition)\\file.zip"`
-
-In 0.10.1+, `File` is an alias for FileFullPath.
-
-This can be a 32-bit or 64-bit file. This is mandatory in earlier versions
-of Chocolatey, but optional if FileFullPath64 has been provided.
-
-Property | Value
----------------------- | -----
-Aliases | file
-Required? | false
-Position? | 1
-Default Value |
-Accept Pipeline Input? | false
-
-### -Destination <String>
-This is a directory where you would like the unzipped files to end up.
-If it does not exist, it will be created.
-
-Property | Value
----------------------- | -----
-Aliases |
-Required? | true
-Position? | 2
-Default Value |
-Accept Pipeline Input? | false
-
-### -SpecificFolder [<String>]
-OPTIONAL - This is a specific directory within zip file to extract.
-
-Property | Value
----------------------- | -----
-Aliases |
-Required? | false
-Position? | 3
-Default Value |
-Accept Pipeline Input? | false
-
-### -PackageName [<String>]
-OPTIONAL - This will faciliate logging unzip activity for subsequent
-uninstalls
-
-Property | Value
----------------------- | -----
-Aliases |
-Required? | false
-Position? | 4
-Default Value |
-Accept Pipeline Input? | false
-
-### -FileFullPath64 [<String>]
-Full file path to a 64-bit native installer to run. Available in 0.10.4+.
-If embedding in the package, you can get it to the path with
-`"$(Split-Path -parent $MyInvocation.MyCommand.Definition)\\INSTALLER_FILE"`
-
-Provide this when you want to provide both 32-bit and 64-bit
-installers or explicitly only a 64-bit installer (which will cause a package
-install failure on 32-bit systems).
-
-Property | Value
----------------------- | ------
-Aliases | file64
-Required? | false
-Position? | named
-Default Value |
-Accept Pipeline Input? | false
-
-### -IgnoredArguments [<Object[]>]
-Allows splatting with arguments that do not apply. Do not use directly.
-
-Property | Value
----------------------- | -----
-Aliases |
-Required? | false
-Position? | named
-Default Value |
-Accept Pipeline Input? | false
-
-### <CommonParameters>
-
-This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see `about_CommonParameters` http://go.microsoft.com/fwlink/p/?LinkID=113216 .
-
-
-## Links
-
- * [[Install-ChocolateyZipPackage|HelpersInstallChocolateyZipPackage]]
-
-
-[[Function Reference|HelpersReference]]
-
-***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Get-ChocolateyUnzip -Full`.
-
-View the source for [Get-ChocolateyUnzip](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Get-ChocolateyUnzip.ps1)
diff --git a/docs/generated/HelpersGetChocolateyWebFile.md b/docs/generated/HelpersGetChocolateyWebFile.md
deleted file mode 100644
index 46ec206a78..0000000000
--- a/docs/generated/HelpersGetChocolateyWebFile.md
+++ /dev/null
@@ -1,328 +0,0 @@
-# Get-ChocolateyWebFile
-
-
-
-Downloads a file from the internets.
-
-## Syntax
-
-~~~powershell
-Get-ChocolateyWebFile `
- -PackageName `
- -FileFullPath `
- [-Url ] `
- [-Url64bit ] `
- [-Checksum ] `
- [-ChecksumType ] `
- [-Checksum64 ] `
- [-ChecksumType64 ] `
- [-Options ] `
- [-GetOriginalFileName] `
- [-ForceDownload] `
- [-IgnoredArguments ] []
-~~~
-
-## Description
-
-This will download a file from a url, tracking with a progress bar.
-It returns the filepath to the downloaded file when it is complete.
-
-## Notes
-
-Chocolatey works best when the packages contain the software it is
-managing and doesn't require downloads. However most software in the
-Windows world requires redistribution rights and when sharing packages
-publicly (like on the [community feed](https://chocolatey.org/packages)), maintainers may not have those
-aforementioned rights. Chocolatey understands how to work with that,
-hence this function. You are not subject to this limitation with
-internal packages.
-
-## Aliases
-
-None
-
-## Examples
-
- **EXAMPLE 1**
-
-~~~powershell
-Get-ChocolateyWebFile '__NAME__' 'C:\somepath\somename.exe' 'URL' '64BIT_URL_DELETE_IF_NO_64BIT'
-
-~~~
-
-**EXAMPLE 2**
-
-~~~powershell
-
-# Download from an HTTPS location
-$toolsDir = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"
-Get-ChocolateyWebFile -PackageName 'bob' -FileFullPath "$toolsDir\bob.exe" -Url 'https://somewhere/bob.exe'
-~~~
-
-**EXAMPLE 3**
-
-~~~powershell
-
-# Download from FTP
-$toolsDir = "$(Split-Path -Parent $MyInvocation.MyCommand.Definition)"
-Get-ChocolateyWebFile -PackageName 'bob' -FileFullPath "$toolsDir\bob.exe" -Url 'ftp://somewhere/bob.exe'
-~~~
-
-**EXAMPLE 4**
-
-~~~powershell
-
-# Download from a file share
-$toolsDir = "$(Split-Path -Parent $MyInvocation.MyCommand.Definition)"
-Get-ChocolateyWebFile -PackageName 'bob' -FileFullPath "$toolsDir\bob.exe" -Url 'file:///\\fileshare\location\bob.exe'
-~~~
-
-**EXAMPLE 5**
-
-~~~powershell
-
-$options =
-@{
- Headers = @{
- Accept = 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8';
- 'Accept-Charset' = 'ISO-8859-1,utf-8;q=0.7,*;q=0.3';
- 'Accept-Language' = 'en-GB,en-US;q=0.8,en;q=0.6';
- Cookie = 'requiredinfo=info';
- Referer = 'https://somelocation.com/';
- }
-}
-
-Get-ChocolateyWebFile -PackageName 'package' -FileFullPath "$(Split-Path -Parent $MyInvocation.MyCommand.Definition)\thefile.exe" -Url 'https://somelocation.com/thefile.exe' -Options $options
-~~~
-
-## Inputs
-
-None
-
-## Outputs
-
-None
-
-## Parameters
-
-### -PackageName <String>
-The name of the package - while this is an arbitrary value, it's
-recommended that it matches the package id.
-
-Property | Value
----------------------- | -----
-Aliases |
-Required? | true
-Position? | 1
-Default Value |
-Accept Pipeline Input? | false
-
-### -FileFullPath <String>
-This is the full path of the resulting file name.
-
-Property | Value
----------------------- | -----
-Aliases |
-Required? | true
-Position? | 2
-Default Value |
-Accept Pipeline Input? | false
-
-### -Url [<String>]
-This is the 32 bit url to download the resource from. This resource can
-be used on 64 bit systems when a package has both a Url and Url64bit
-specified if a user passes `--forceX86`. If there is only a 64 bit url
-available, please remove do not use the paramter (only use Url64bit).
-Will fail on 32bit systems if missing or if a user attempts to force
-a 32 bit installation on a 64 bit system.
-
-Prefer HTTPS when available. Can be HTTP, FTP, or File URIs.
-
-Property | Value
----------------------- | -----
-Aliases |
-Required? | false
-Position? | 3
-Default Value |
-Accept Pipeline Input? | false
-
-### -Url64bit [<String>]
-OPTIONAL - If there is a 64 bit resource available, use this
-parameter. Chocolatey will automatically determine if the user is
-running a 64 bit OS or not and adjust accordingly. Please note that
-the 32 bit url will be used in the absence of this. This parameter
-should only be used for 64 bit native software. If the original Url
-contains both (which is quite rare), set this to '$url' Otherwise
-remove this parameter.
-
-Prefer HTTPS when available. Can be HTTP, FTP, or File URIs.
-
-In 0.10.1+, `Url64` is an alias for Url64bit.
-
-Property | Value
----------------------- | -----
-Aliases | url64
-Required? | false
-Position? | 4
-Default Value |
-Accept Pipeline Input? | false
-
-### -Checksum [<String>]
-The checksum hash value of the Url resource. This allows a checksum to
-be validated for files that are not local. The checksum type is covered
-by ChecksumType.
-
-**NOTE:** Checksums in packages are meant as a measure to validate the
-originally intended file that was used in the creation of a package is
-the same file that is received at a future date. Since this is used for
-other steps in the process related to the [community repository](https://chocolatey.org/packages), it
-ensures that the file a user receives is the same file a maintainer
-and a moderator (if applicable), plus any moderation review has
-intended for you to receive with this package. If you are looking at a
-remote source that uses the same url for updates, you will need to
-ensure the package also stays updated in line with those remote
-resource updates. You should look into [automatic packaging](https://chocolatey.org/docs/automatic-packages)
-to help provide that functionality.
-
-Property | Value
----------------------- | -----
-Aliases |
-Required? | false
-Position? | named
-Default Value |
-Accept Pipeline Input? | false
-
-### -ChecksumType [<String>]
-The type of checkum that the file is validated with - valid
-values are 'md5', 'sha1', 'sha256' or 'sha512' - defaults to 'md5'.
-
-MD5 is not recommended as certain organizations need to use FIPS
-compliant algorithms for hashing - see
-https://support.microsoft.com/en-us/kb/811833 for more details.
-
-The recommendation is to use at least SHA256.
-
-Property | Value
----------------------- | -----
-Aliases |
-Required? | false
-Position? | named
-Default Value |
-Accept Pipeline Input? | false
-
-### -Checksum64 [<String>]
-OPTIONAL if no Url64bit - The checksum hash value of the Url64bit
-resource. This allows a checksum to be validated for files that are not
-local. The checksum type is covered by ChecksumType64.
-
-**NOTE:** Checksums in packages are meant as a measure to validate the
-originally intended file that was used in the creation of a package is
-the same file that is received at a future date. Since this is used for
-other steps in the process related to the [community repository](https://chocolatey.org/packages), it
-ensures that the file a user receives is the same file a maintainer
-and a moderator (if applicable), plus any moderation review has
-intended for you to receive with this package. If you are looking at a
-remote source that uses the same url for updates, you will need to
-ensure the package also stays updated in line with those remote
-resource updates. You should look into [automatic packaging](https://chocolatey.org/docs/automatic-packages)
-to help provide that functionality.
-
-**NOTE:** To determine checksums, you can get that from the original
-site if provided. You can also use the [checksum tool available on
-the [community feed](https://chocolatey.org/packages)](https://chocolatey.org/packages/checksum) (`choco install checksum`)
-and use it e.g. `checksum -t sha256 -f path\to\file`. Ensure you
-provide checksums for all remote resources used.
-
-Property | Value
----------------------- | -----
-Aliases |
-Required? | false
-Position? | named
-Default Value |
-Accept Pipeline Input? | false
-
-### -ChecksumType64 [<String>]
-OPTIONAL - The type of checkum that the file is validated with - valid
-values are 'md5', 'sha1', 'sha256' or 'sha512' - defaults to
-ChecksumType parameter value.
-
-MD5 is not recommended as certain organizations need to use FIPS
-compliant algorithms for hashing - see
-https://support.microsoft.com/en-us/kb/811833 for more details.
-
-The recommendation is to use at least SHA256.
-
-Property | Value
----------------------- | -------------
-Aliases |
-Required? | false
-Position? | named
-Default Value | $checksumType
-Accept Pipeline Input? | false
-
-### -Options [<Hashtable>]
-OPTIONAL - Specify custom headers. Available in 0.9.10+.
-
-Property | Value
----------------------- | --------------
-Aliases |
-Required? | false
-Position? | named
-Default Value | @{Headers=@{}}
-Accept Pipeline Input? | false
-
-### -GetOriginalFileName
-OPTIONAL switch to allow Chocolatey to determine the original file name
-from the url resource. Available in 0.9.10+.
-
-Property | Value
----------------------- | -----
-Aliases |
-Required? | false
-Position? | named
-Default Value | False
-Accept Pipeline Input? | false
-
-### -ForceDownload
-OPTIONAL switch to force download of file every time, even if the file
-already exists.
-
-Available in 0.10.1+.
-
-Property | Value
----------------------- | -----
-Aliases |
-Required? | false
-Position? | named
-Default Value | False
-Accept Pipeline Input? | false
-
-### -IgnoredArguments [<Object[]>]
-Allows splatting with arguments that do not apply. Do not use directly.
-
-Property | Value
----------------------- | -----
-Aliases |
-Required? | false
-Position? | named
-Default Value |
-Accept Pipeline Input? | false
-
-### <CommonParameters>
-
-This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see `about_CommonParameters` http://go.microsoft.com/fwlink/p/?LinkID=113216 .
-
-
-## Links
-
- * [[Install-ChocolateyPackage|HelpersInstallChocolateyPackage]]
- * [[Get-WebFile|HelpersGetWebFile]]
- * [[Get-WebFileName|HelpersGetWebFileName]]
- * [[Get-FtpFile|HelpersGetFtpFile]]
-
-
-[[Function Reference|HelpersReference]]
-
-***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Get-ChocolateyWebFile -Full`.
-
-View the source for [Get-ChocolateyWebFile](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Get-ChocolateyWebFile.ps1)
diff --git a/docs/generated/HelpersGetEnvironmentVariable.md b/docs/generated/HelpersGetEnvironmentVariable.md
deleted file mode 100644
index 37b7fb68de..0000000000
--- a/docs/generated/HelpersGetEnvironmentVariable.md
+++ /dev/null
@@ -1,123 +0,0 @@
-# Get-EnvironmentVariable
-
-
-
-Gets an Environment Variable.
-
-## Syntax
-
-~~~powershell
-Get-EnvironmentVariable `
- -Name `
- -Scope {Process | User | Machine} `
- [-PreserveVariables] `
- [-IgnoredArguments ] []
-~~~
-
-## Description
-
-This will will get an environment variable based on the variable name
-and scope while accounting whether to expand the variable or not
-(e.g.: `%TEMP%`-> `C:\User\Username\AppData\Local\Temp`).
-
-## Notes
-
-This helper reduces the number of lines one would have to write to get
-environment variables, mainly when not expanding the variables is a
-must.
-
-## Aliases
-
-None
-
-## Examples
-
- **EXAMPLE 1**
-
-~~~powershell
-Get-EnvironmentVariable -Name 'TEMP' -Scope User -PreserveVariables
-
-~~~
-
-**EXAMPLE 2**
-
-~~~powershell
-Get-EnvironmentVariable -Name 'PATH' -Scope Machine
-
-~~~
-
-## Inputs
-
-None
-
-## Outputs
-
-None
-
-## Parameters
-
-### -Name <String>
-The environemnt variable you want to get the value from.
-
-Property | Value
----------------------- | -----
-Aliases |
-Required? | true
-Position? | 1
-Default Value |
-Accept Pipeline Input? | false
-
-### -Scope
-The environemnt variable target scope. This is `Process`, `User`, or
-`Machine`.
-
-
-Valid options: Process, User, Machine
-
-Property | Value
----------------------- | -----
-Aliases |
-Required? | true
-Position? | 2
-Default Value |
-Accept Pipeline Input? | false
-
-### -PreserveVariables
-A switch parameter stating whether you want to expand the variables or
-not. Defaults to false. Available in 0.9.10+.
-
-Property | Value
----------------------- | -----
-Aliases |
-Required? | false
-Position? | named
-Default Value | False
-Accept Pipeline Input? | false
-
-### -IgnoredArguments [<Object[]>]
-Allows splatting with arguments that do not apply. Do not use directly.
-
-Property | Value
----------------------- | -----
-Aliases |
-Required? | false
-Position? | 3
-Default Value |
-Accept Pipeline Input? | false
-
-### <CommonParameters>
-
-This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see `about_CommonParameters` http://go.microsoft.com/fwlink/p/?LinkID=113216 .
-
-
-## Links
-
- * [[Get-EnvironmentVariableNames|HelpersGetEnvironmentVariableNames]]
- * [[Set-EnvironmentVariable|HelpersSetEnvironmentVariable]]
-
-
-[[Function Reference|HelpersReference]]
-
-***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Get-EnvironmentVariable -Full`.
-
-View the source for [Get-EnvironmentVariable](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Get-EnvironmentVariable.ps1)
diff --git a/docs/generated/HelpersGetEnvironmentVariableNames.md b/docs/generated/HelpersGetEnvironmentVariableNames.md
deleted file mode 100644
index a783223db2..0000000000
--- a/docs/generated/HelpersGetEnvironmentVariableNames.md
+++ /dev/null
@@ -1,59 +0,0 @@
-# Get-EnvironmentVariableNames
-
-
-
-Gets all environment variable names.
-
-## Syntax
-
-~~~powershell
-Get-EnvironmentVariableNames `
- [-Scope {Process | User | Machine}]
-~~~
-
-## Description
-
-Provides a list of environment variable names based on the scope. This
-can be used to loop through the list and generate names.
-
-## Notes
-
-Process dumps the current environment variable names in memory /
-session. The other scopes refer to the registry values.
-
-## Aliases
-
-None
-
-## Examples
-
- **EXAMPLE 1**
-
-~~~powershell
-Get-EnvironmentVariableNames -Scope Machine
-
-~~~
-
-## Inputs
-
-None
-
-## Outputs
-
-None
-
-## Parameters
-
-
-
-## Links
-
- * [[Get-EnvironmentVariable|HelpersGetEnvironmentVariable]]
- * [[Set-EnvironmentVariable|HelpersSetEnvironmentVariable]]
-
-
-[[Function Reference|HelpersReference]]
-
-***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Get-EnvironmentVariableNames -Full`.
-
-View the source for [Get-EnvironmentVariableNames](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Get-EnvironmentVariableNames.ps1)
diff --git a/docs/generated/HelpersGetFtpFile.md b/docs/generated/HelpersGetFtpFile.md
deleted file mode 100644
index b1842fe9f0..0000000000
--- a/docs/generated/HelpersGetFtpFile.md
+++ /dev/null
@@ -1,129 +0,0 @@
-# Get-FtpFile
-
-
-
-Downloads a file from a File Transfter Protocol (FTP) location.
-
-## Syntax
-
-~~~powershell
-Get-FtpFile `
- [-Url ] `
- -FileName `
- [-Username ] `
- [-Password ] `
- [-Quiet] `
- [-IgnoredArguments ] []
-~~~
-
-## Description
-
-This will download a file from an FTP location, saving the file to the
-FileName location specified.
-
-## Notes
-
-This is a low-level function and not recommended for use in package
-scripts. It is recommended you call `Get-ChocolateyWebFile` instead.
-
-Starting in 0.9.10, will automatically call Set-PowerShellExitCode to
-set the package exit code to 404 if the resource is not found.
-
-## Aliases
-
-None
-
-## Inputs
-
-None
-
-## Outputs
-
-None
-
-## Parameters
-
-### -Url [<String>]
-This is the url to download the file from.
-
-Property | Value
----------------------- | -----
-Aliases |
-Required? | false
-Position? | 1
-Default Value |
-Accept Pipeline Input? | false
-
-### -FileName <String>
-This is the full path to the file to create. If FTPing to the
-package folder next to the install script, the path will be like
-`"$(Split-Path -Parent $MyInvocation.MyCommand.Definition)\\file.exe"`
-
-Property | Value
----------------------- | -----
-Aliases |
-Required? | true
-Position? | 2
-Default Value |
-Accept Pipeline Input? | false
-
-### -Username [<String>]
-The user account to connect to FTP with.
-
-Property | Value
----------------------- | -----
-Aliases |
-Required? | false
-Position? | 3
-Default Value |
-Accept Pipeline Input? | false
-
-### -Password [<String>]
-The password for the user account on the FTP server.
-
-Property | Value
----------------------- | -----
-Aliases |
-Required? | false
-Position? | 4
-Default Value |
-Accept Pipeline Input? | false
-
-### -Quiet
-Silences the progress output.
-
-Property | Value
----------------------- | -----
-Aliases |
-Required? | false
-Position? | named
-Default Value | False
-Accept Pipeline Input? | false
-
-### -IgnoredArguments [<Object[]>]
-Allows splatting with arguments that do not apply. Do not use directly.
-
-Property | Value
----------------------- | -----
-Aliases |
-Required? | false
-Position? | named
-Default Value |
-Accept Pipeline Input? | false
-
-### <CommonParameters>
-
-This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see `about_CommonParameters` http://go.microsoft.com/fwlink/p/?LinkID=113216 .
-
-
-## Links
-
- * [[Get-ChocolateyWebFile|HelpersGetChocolateyWebFile]]
- * [[Get-WebFile|HelpersGetWebFile]]
-
-
-[[Function Reference|HelpersReference]]
-
-***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Get-FtpFile -Full`.
-
-View the source for [Get-FtpFile](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Get-FtpFile.ps1)
diff --git a/docs/generated/HelpersGetOSArchitectureWidth.md b/docs/generated/HelpersGetOSArchitectureWidth.md
deleted file mode 100644
index 79d72f2ad4..0000000000
--- a/docs/generated/HelpersGetOSArchitectureWidth.md
+++ /dev/null
@@ -1,51 +0,0 @@
-# Get-OSArchitectureWidth
-
-
-
-Get the operating system architecture address width.
-
-## Syntax
-
-~~~powershell
-Get-OSArchitectureWidth `
- [-Compare