### Explicitly providing installer architecture Source: https://github.com/microsoft/winget-create/blob/main/doc/update.md Example of how to explicitly provide the installer architecture when updating a manifest. ```bash wingetcreate update --urls "|x64" "|x86" ``` -------------------------------- ### Explicitly providing installer architecture and scope Source: https://github.com/microsoft/winget-create/blob/main/doc/update.md Example of how to explicitly provide both installer architecture and scope when updating a manifest with multiple installers of the same architecture. ```bash wingetcreate update --urls '|x64|user' '|x64|machine' '|x86|user' '|x86|machine' ``` -------------------------------- ### Update Installer URLs Source: https://github.com/microsoft/winget-create/blob/main/doc/update.md Search for an existing manifest and update the installer URLs. ```bash wingetcreate.exe update --urls ``` -------------------------------- ### Provide multiple URLs via prompt Source: https://github.com/microsoft/winget-create/blob/main/doc/new.md When prompted interactively, use commas to separate multiple installer URLs. ```text [InstallerUrl] The installer URL(s): https://microsoft.com/foo.exe, https://microsoft.com/bar.msix ``` -------------------------------- ### Show installer and default locale manifests Source: https://github.com/microsoft/winget-create/blob/main/doc/show.md Display only the installer and default locale manifest details for a package. This command is useful for quickly reviewing specific manifest components without retrieving the entire manifest set. A GitHub Personal Access Token is recommended. ```bash wingetcreate.exe show --installer-manifest --defaultlocale-manifest --token ``` -------------------------------- ### Execute new command with multiple URLs Source: https://github.com/microsoft/winget-create/blob/main/doc/new.md Provide multiple installer URLs directly in the command line using space separation. ```bash wingetcreate.exe new https://microsoft.com/foo.exe https://microsoft.com/bar.msix ``` -------------------------------- ### GET /settings Source: https://github.com/microsoft/winget-create/blob/main/doc/dsc/settings.md Retrieves the current settings for Winget-Create. ```APIDOC ## GET /settings ### Description Retrieves the current settings for Winget-Create. ### Method GET ### Endpoint /settings ### Request Example ```shell PS C:\> wingetcreate dsc settings --get ``` ### Response #### Success Response (200) - **settings** (object) - The current settings configuration. #### Response Example ```json { "settings": { "$schema": "https://aka.ms/wingetcreate-settings.schema.0.1.json", "Telemetry": { "disable": true }, "CleanUp": { "intervalInDays": 7, "disable": false }, "WindowsPackageManagerRepository": { "owner": "microsoft", "name": "winget-pkgs" }, "Manifest": { "format": "yaml" }, "Visual": { "anonymizePaths": true } } } ``` ``` -------------------------------- ### Display Winget-Create Client Information Source: https://github.com/microsoft/winget-create/blob/main/doc/info.md Use this command to view details about the Winget-Create client, such as the location of configuration files and directories for installers and logs. It also provides links to the GitHub repository and privacy statement. ```bash wingetcreate.exe info ``` -------------------------------- ### Export Winget-Create Settings Source: https://github.com/microsoft/winget-create/blob/main/doc/dsc/settings.md Exports the current Winget-Create settings. The output is identical to the get operation. ```shell PS C:\> wingetcreate dsc settings --export {"settings":{"$schema":"https://aka.ms/wingetcreate-settings.schema.0.1.json","Telemetry":{"disable":true},"CleanUp":{"intervalInDays":7,"disable":false},"WindowsPackageManagerRepository":{"owner":"microsoft","name":"winget-pkgs"},"Manifest":{"format":"yaml"},"Visual":{"anonymizePaths":true}}} ``` -------------------------------- ### Override Installer Architecture Source: https://github.com/microsoft/winget-create/blob/main/doc/update.md Override the architecture of an installer using the '|' format. ```bash wingetcreate.exe update --urls '|' --version ``` -------------------------------- ### Get Winget-Create Settings Source: https://github.com/microsoft/winget-create/blob/main/doc/dsc/settings.md Retrieves the current Winget-Create settings. The output is identical to the export operation. ```shell PS C:\> wingetcreate dsc settings --get {"settings":{"$schema":"https://aka.ms/wingetcreate-settings.schema.0.1.json","Telemetry":{"disable":true},"CleanUp":{"intervalInDays":7,"disable":false},"WindowsPackageManagerRepository":{"owner":"microsoft","name":"winget-pkgs"},"Manifest":{"format":"yaml"},"Visual":{"anonymizePaths":true}}} ``` -------------------------------- ### EXPORT /settings Source: https://github.com/microsoft/winget-create/blob/main/doc/dsc/settings.md Exports the current settings for Winget-Create. The output is identical to the GET operation. ```APIDOC ## EXPORT /settings ### Description Exports the current settings for Winget-Create. The output is identical to the GET operation. ### Method EXPORT ### Endpoint /settings ### Request Example ```shell PS C:\> wingetcreate dsc settings --export ``` ### Response #### Success Response (200) - **settings** (object) - The current settings configuration. #### Response Example ```json { "settings": { "$schema": "https://aka.ms/wingetcreate-settings.schema.0.1.json", "Telemetry": { "disable": true }, "CleanUp": { "intervalInDays": 7, "disable": false }, "WindowsPackageManagerRepository": { "owner": "microsoft", "name": "winget-pkgs" }, "Manifest": { "format": "yaml" }, "Visual": { "anonymizePaths": true } } } ``` ``` -------------------------------- ### Install .NET Runtime using PowerShell script Source: https://github.com/microsoft/winget-create/blob/main/README.md This PowerShell script downloads and installs the .NET Runtime 6.0. ```PowerShell Invoke-WebRequest https://dot.net/v1/dotnet-install.ps1 -OutFile dotnet-install.ps1 .\dotnet-install.ps1 -Runtime dotnet -Architecture x64 -Version 6.0.13 -InstallDir $env:ProgramFiles\dotnet ``` -------------------------------- ### Override Installer Scope Source: https://github.com/microsoft/winget-create/blob/main/doc/update.md Explicitly provide the installer scope in the update command when multiple installers share the same architecture. ```bash wingetcreate.exe update --urls '|' ``` -------------------------------- ### Install with Scoop Source: https://github.com/microsoft/winget-create/blob/main/README.md Command to install the Windows Package Manager Manifest Creator using Scoop. ```powershell scoop install wingetcreate ``` -------------------------------- ### Install C++ Runtime and Winget-Create msixbundle Source: https://github.com/microsoft/winget-create/blob/main/README.md This PowerShell script installs the C++ Runtime Desktop framework package and the Winget-Create msixbundle, then updates a manifest. ```PowerShell - powershell: | # Download and install C++ Runtime framework package. iwr https://aka.ms/Microsoft.VCLibs.x64.14.00.Desktop.appx -OutFile $(vcLibsBundleFile) Add-AppxPackage $(vcLibsBundleFile) # Download Winget-Create msixbundle, install, and execute update. iwr https://aka.ms/wingetcreate/latest/msixbundle -OutFile $(appxBundleFile) Add-AppxPackage $(appxBundleFile) wingetcreate update Microsoft.WingetCreate -u $(packageUrl) -v $(manifestVersion) -t $(GITHUB_PAT) --submit ``` -------------------------------- ### Override Display Version Source: https://github.com/microsoft/winget-create/blob/main/doc/update.md Use the '--display-version' CLI argument if the publisher uses a different marketing version than the actual version. If display versions differ per installer, use the '|' format. ```bash wingetcreate.exe update --display-version ``` ```bash wingetcreate.exe update --urls '|' ``` -------------------------------- ### Install with Chocolatey Source: https://github.com/microsoft/winget-create/blob/main/README.md Command to install the Windows Package Manager Manifest Creator using Chocolatey. ```powershell choco install wingetcreate ``` -------------------------------- ### Override Architecture Format Source: https://github.com/microsoft/winget-create/blob/main/doc/update.md Format for overriding the detected architecture of an installer package. ```bash '|' ``` -------------------------------- ### Install with Windows Package Manager Source: https://github.com/microsoft/winget-create/blob/main/README.md Command to install the Windows Package Manager Manifest Creator using Windows Package Manager. ```powershell winget install wingetcreate ``` -------------------------------- ### Install .NET Runtime using Azure DevOps task Source: https://github.com/microsoft/winget-create/blob/main/README.md This YAML snippet shows how to install the .NET Runtime 6.0 in an Azure DevOps pipeline. ```yaml - task: UseDotNet@2 displayName: 'Install .NET Runtime' inputs: packageType: sdk version: '6.x' installationPath: '$(ProgramFiles)\dotnet' ``` -------------------------------- ### Execute new command Source: https://github.com/microsoft/winget-create/blob/main/doc/new.md Basic syntax for initiating the manifest creation process. ```bash wingetcreate.exe new [] [] ``` -------------------------------- ### Test Winget-Create Settings (Full Action) Source: https://github.com/microsoft/winget-create/blob/main/doc/dsc/settings.md Tests specified settings against their current values and other settings against their default values. Use this for a comprehensive state validation. ```shell PS C:\> wingetcreate dsc settings --test '{"settings": { "Telemetry": { "disable": false }}, "action": "Full"}' {"settings":{"$schema":"https://aka.ms/wingetcreate-settings.schema.0.1.json","Telemetry":{"disable":true},"CleanUp":{"intervalInDays":7,"disable":false},"WindowsPackageManagerRepository":{"owner":"microsoft","name":"winget-pkgs"},"Manifest":{"format":"yaml"},"Visual":{"anonymizePaths":true}},"action":"Full","_inDesiredState":false} ["settings"] ``` -------------------------------- ### Set Winget-Create Settings (Full Action) Source: https://github.com/microsoft/winget-create/blob/main/doc/dsc/settings.md Updates specified settings to new values and resets all other settings to their defaults. Use this for a complete configuration reset. ```shell PS C:\> wingetcreate dsc settings --set '{"settings": { "Telemetry": { "disable": false }}, "action": "Full"}' {"settings":{"$schema":"https://aka.ms/wingetcreate-settings.schema.0.1.json","Telemetry":{"disable":false},"CleanUp":{"intervalInDays":7,"disable":false},"WindowsPackageManagerRepository":{"owner":"microsoft","name":"winget-pkgs"},"Manifest":{"format":"yaml"},"Visual":{"anonymizePaths":true}},"action":"Full"} ["settings"] ``` -------------------------------- ### Set Winget-Create Settings (Partial Action) Source: https://github.com/microsoft/winget-create/blob/main/doc/dsc/settings.md Updates only the specified settings, leaving all other settings unchanged. Use this for targeted configuration adjustments. ```shell PS C:\> wingetcreate dsc settings --set '{"settings": { "Telemetry": { "disable": true }}, "action": "Partial"}' {"settings":{"$schema":"https://aka.ms/wingetcreate-settings.schema.0.1.json","Telemetry":{"disable":true},"CleanUp":{"intervalInDays":7,"disable":false},"WindowsPackageManagerRepository":{"owner":"microsoft","name":"winget-pkgs"},"Manifest":{"format":"yaml"},"Visual":{"anonymizePaths":true}},"action":"Partial"} ["settings"] ``` -------------------------------- ### Test Winget-Create Settings (Partial Action) Source: https://github.com/microsoft/winget-create/blob/main/doc/dsc/settings.md Tests only the specified settings, omitting others from the validation. Use this for targeted state checks. ```shell PS C:\> wingetcreate dsc settings --test '{"settings": { "Telemetry": { "disable": false }}, "action": "Partial"}' {"settings":{"$schema":"https://aka.ms/wingetcreate-settings.schema.0.1.json","Telemetry":{"disable":true},"CleanUp":{"intervalInDays":7,"disable":false},"WindowsPackageManagerRepository":{"owner":"microsoft","name":"winget-pkgs"},"Manifest":{"format":"yaml"},"Visual":{"anonymizePaths":true}},"action":"Partial","_inDesiredState":false} ["settings"] ``` -------------------------------- ### Configure system using configuration file Source: https://github.com/microsoft/winget-create/blob/main/README.md Command to run the winget configure tool with a specified configuration file. ```bash winget configure .config/configuration.winget ``` -------------------------------- ### TEST /settings Source: https://github.com/microsoft/winget-create/blob/main/doc/dsc/settings.md Tests Winget-Create settings against desired state. Supports 'Full' or 'Partial' test actions. ```APIDOC ## TEST /settings ### Description Tests Winget-Create settings against desired state. Supports 'Full' or 'Partial' test actions. ### Method TEST ### Endpoint /settings ### Parameters #### Request Body - **settings** (object) - Required - The settings object to test. - **action** (string) - Required - The test action. Can be 'Full' or 'Partial'. - `Full`: Tests specified settings and compares others against defaults. - `Partial`: Tests only specified settings, omitting others. ### Request Example ```json { "settings": { "Telemetry": { "disable": false } }, "action": "Full" } ``` ### Response #### Success Response (200) - **settings** (object) - The settings configuration. - **action** (string) - The action performed. - **_inDesiredState** (boolean) - Indicates if the settings are in the desired state. #### Response Example ```json { "settings": { "$schema": "https://aka.ms/wingetcreate-settings.schema.0.1.json", "Telemetry": { "disable": true }, "CleanUp": { "intervalInDays": 7, "disable": false }, "WindowsPackageManagerRepository": { "owner": "microsoft", "name": "winget-pkgs" }, "Manifest": { "format": "yaml" }, "Visual": { "anonymizePaths": true } }, "action": "Full", "_inDesiredState": false } ``` ``` -------------------------------- ### GitHub Authentication Flow Source: https://github.com/microsoft/winget-create/blob/main/README.md Recommended method for setting up your GitHub token for testing. ```bash wingetcreate token -s ``` -------------------------------- ### Set Manifest Format Source: https://github.com/microsoft/winget-create/blob/main/doc/settings.md Configure the `Manifest.format` setting to specify the output format for created manifests. Defaults to `yaml`; `json` is also supported. Inline `--format` arguments take precedence. ```json "Manifest": { "format": "yaml" } ``` -------------------------------- ### Configure WindowsPackageManagerRepository Source: https://github.com/microsoft/winget-create/blob/main/doc/settings.md Specify the GitHub repository owner and name that Winget-Create targets for package manifests. Defaults to `microsoft/winget-pkgs`. ```json "WindowsPackageManagerRepository": { "owner": "microsoft", "name": "winget-pkgs" } ``` -------------------------------- ### Store a new GitHub token in your local cache Source: https://github.com/microsoft/winget-create/blob/main/doc/token.md Command to store a new GitHub personal access token in the local cache. ```bash wingetcreate.exe token --store --token ``` -------------------------------- ### Save and Publish Updated Manifest Source: https://github.com/microsoft/winget-create/blob/main/doc/update.md Save and publish an updated manifest to a specified output directory with a GitHub Personal Access Token. ```bash wingetcreate.exe update --out --token --version ``` -------------------------------- ### Update Version Source: https://github.com/microsoft/winget-create/blob/main/doc/update.md Search for an existing manifest and update the version. ```bash wingetcreate.exe update --version ``` -------------------------------- ### Submit Local Manifest to Windows Package Manager Repo Source: https://github.com/microsoft/winget-create/blob/main/doc/submit.md Use this command to submit a local manifest file to the Windows Package Manager repository. Ensure you provide a pull request title, your GitHub token, and the path to the manifest file. ```bash wingetcreate.exe submit --prtitle --token ``` -------------------------------- ### Winget-Create Cache Command Source: https://github.com/microsoft/winget-create/blob/main/doc/cache.md This section details the usage and options for the 'cache' command in Winget-Create. ```APIDOC ## cache command (Winget-Create) The **cache** command of the [Winget-Create](../README.md) tool is designed to help users manage their downloaded installers. Continued usage of the tool can result in many downloaded installers taking up unnecessary space on your machine. This command can help clean up some of the unneeded files. ### Usage `wingetcreate.exe cache [\]` ### Arguments The following arguments are available: | Argument | Description | |---|---| | **-c, --clean** | Deletes all downloaded installers in the cache folder | | **-l, --list** | Lists out all the downloaded installers stored in cache | | **-o, --open** | Opens the cache folder storing the downloaded installers | | **-?, --help** | Gets additional help on this command. | ``` -------------------------------- ### SET /settings Source: https://github.com/microsoft/winget-create/blob/main/doc/dsc/settings.md Sets or updates Winget-Create settings. Supports 'Full' or 'Partial' update actions. ```APIDOC ## SET /settings ### Description Sets or updates Winget-Create settings. Supports 'Full' or 'Partial' update actions. ### Method SET ### Endpoint /settings ### Parameters #### Request Body - **settings** (object) - Required - The settings object to apply. - **action** (string) - Required - The update action. Can be 'Full' or 'Partial'. - `Full`: Updates specified settings and resets others to default. - `Partial`: Updates only specified settings, leaving others unchanged. ### Request Example ```json { "settings": { "Telemetry": { "disable": false } }, "action": "Full" } ``` ### Response #### Success Response (200) - **settings** (object) - The updated settings configuration. - **action** (string) - The action performed. #### Response Example ```json { "settings": { "$schema": "https://aka.ms/wingetcreate-settings.schema.0.1.json", "Telemetry": { "disable": false }, "CleanUp": { "intervalInDays": 7, "disable": false }, "WindowsPackageManagerRepository": { "owner": "microsoft", "name": "winget-pkgs" }, "Manifest": { "format": "yaml" }, "Visual": { "anonymizePaths": true } }, "action": "Full" } ``` ``` -------------------------------- ### Update an existing manifest and submit PR to GitHub Source: https://github.com/microsoft/winget-create/blob/main/doc/update.md Update an existing manifest and submit a pull request to GitHub. ```bash wingetcreate.exe update --submit --token --urls --version ``` -------------------------------- ### DSC Command Usage Source: https://github.com/microsoft/winget-create/blob/main/doc/dsc.md The basic usage syntax for the dsc command. ```bash wingetcreate.exe dsc [] ``` -------------------------------- ### Update package locales using Winget-Create Source: https://github.com/microsoft/winget-create/blob/main/doc/update-locale.md Commands for updating package locales, supporting specific versions and custom output directories. ```bash wingetcreate.exe update-locale --token ``` ```bash wingetcreate.exe update-locale --token --version ``` ```bash wingetcreate.exe update-locale --out --token --version ``` -------------------------------- ### Usage of update command Source: https://github.com/microsoft/winget-create/blob/main/doc/update.md The general usage syntax for the update command, including various optional arguments. ```bash wingetcreate.exe update [-u ] [-v ] [-s] [-t ] [-o ] [-p ] [-r] [] [-d ] [--release-date ] [--release-notes-url ] [--format ] [--interactive] [--help] ``` -------------------------------- ### Create a new locale for a package Source: https://github.com/microsoft/winget-create/blob/main/doc/new-locale.md Commands to generate a new locale manifest for a package, supporting specific versions and output directories. ```bash wingetcreate.exe new-locale --token ``` ```bash wingetcreate.exe new-locale --token --version ``` ```bash wingetcreate.exe new-locale --out --token --version ``` -------------------------------- ### Show latest package manifest Source: https://github.com/microsoft/winget-create/blob/main/doc/show.md Use this command to display the most recent manifest for a given package identifier from the Windows Package Manager repository. A GitHub Personal Access Token is recommended for authenticated access. ```bash wingetcreate.exe show --token ``` -------------------------------- ### Environment Variable for GitHub Token Source: https://github.com/microsoft/winget-create/blob/main/README.md Alternative method for setting up your GitHub token, suitable for CI/CD pipelines. ```bash set WINGET_CREATE_GITHUB_TOKEN= ``` -------------------------------- ### Disable Cleanup Source: https://github.com/microsoft/winget-create/blob/main/doc/settings.md Set `CleanUp.disable` to `true` to prevent Winget-Create from removing temporary files. ```json "CleanUp": { "disable": true }, ``` -------------------------------- ### Set Cleanup Interval Source: https://github.com/microsoft/winget-create/blob/main/doc/settings.md Configure `CleanUp.intervalInDays` to specify the frequency in days for removing temporary files. Defaults to 7 days. ```json "CleanUp": { "intervalInDays": 7 }, ``` -------------------------------- ### Show specific version of package manifest Source: https://github.com/microsoft/winget-create/blob/main/doc/show.md Retrieve and display a manifest for a specific version of a package. This is useful when you need to inspect a particular historical version of a package's manifest. A GitHub Personal Access Token is recommended. ```bash wingetcreate.exe show --version --token ``` -------------------------------- ### Clear the cached GitHub token Source: https://github.com/microsoft/winget-create/blob/main/doc/token.md Command to clear the cached GitHub token. ```bash wingetcreate.exe token --clear ``` -------------------------------- ### Control Pull Request Browser Opening Source: https://github.com/microsoft/winget-create/blob/main/doc/settings.md Set `PullRequest.openInBrowser` to `false` to prevent the Winget-Create CLI from automatically opening the created pull request in the default browser. Defaults to `true`. The `--no-open` argument takes precedence. ```json "PullRequest": { "openInBrowser": false }, ``` -------------------------------- ### Anonymize Paths in Output Source: https://github.com/microsoft/winget-create/blob/main/doc/settings.md Set `Visual.anonymizePaths` to `true` to obscure user-specific path information in the CLI output by using environment variable substitutions. Defaults to `true`. ```json "Visual": { "anonymizePaths": true } ``` -------------------------------- ### Update manifest using standalone wingetcreate.exe Source: https://github.com/microsoft/winget-create/blob/main/README.md This PowerShell script downloads the latest wingetcreate.exe and uses it to update a manifest. It demonstrates using pipeline variables for sensitive information like GitHub PAT. ```PowerShell Invoke-WebRequest https://aka.ms/wingetcreate/latest -OutFile wingetcreate.exe .\wingetcreate.exe update -u $(packageUrls) -v $(manifestVersion) -t $(GITHUB_PAT) ``` -------------------------------- ### Telemetry Opt-out Configuration Source: https://github.com/microsoft/winget-create/blob/main/README.md Configuration to disable telemetry by setting the 'telemetry.disabled' field to true in settings.json. ```json { "telemetry": { "disabled": true } } ``` -------------------------------- ### Disable Telemetry Source: https://github.com/microsoft/winget-create/blob/main/doc/settings.md Set `telemetry.disable` to `true` to prevent Winget-Create from writing ETW events. ```json "telemetry": { "disable": true }, ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.