Skip to content

Latest commit

 

History

History
58 lines (33 loc) · 2.79 KB

new.md

File metadata and controls

58 lines (33 loc) · 2.79 KB

new command (Winget-Create)

The new command of the Winget-Create tool begins the process of generating a manifest file. This command is used if you need to create a manifest file for submitting software to the Microsoft Community Package Manifest Repository on GitHub.

Usage

WingetCreateCLI.exe new [<url>] [\<options>]

The new command can be called with the optional URL. If the URL is provided, Winget-Create will download the installer as it begins. If the URL is not included, the user will need to add it when prompted.

Arguments

The following arguments are available:

Argument Description
-o,--out The output directory where the newly created manifests will be saved locally
-t,--token GitHub personal access token used for direct submission to the Windows Package Manager repo
-?, --help Gets additional help on this command

Winget-Create New Command flow

Downloading the installer

The first action Winget-Create will take is to download the installer. Winget-Create will attempt to access the meta data associated with the installer. If the metadata is discovered, it will pre-populate the default strings.
As can be seen in this image, the Windows SDK was used as the URL and the PackageIdentifier is pre-populated.

new command

You can now accept the PackageIdentifier as it is, or you can choose to edit it by using the DEL and ARROW keys.

By typing ENTER you will accept the string, and the wizard will move on.

new command PackageIdentifier

Remaining required fields

Like the PackageIdentifier you will have the opportunity to accept or modify the remaining fields.

new command default values

Review Changes

Once you have successfully filled in the details, fields, Winget-Create will display the results for you to review.

new command review

If you would like to make changes, Winget-Create will walk you through the fields again allowing you to change them.

If you are content with the changes, choose no and the manifest will be saved.

Submit

The last option Winget-Create will offer is for you to submit the manifest to the Windows Package Manager repository.
If you choose yes, you will automatically submit your Pull Request (PR) to the Windows Package Manager repository.

Note

If you have not logged on to GitHub, you will be taken to the GitHub authentication web page before allowing you to submit your manifest.