The token command of the Winget-Create tool is designed to manage cached GitHub personal access tokens used by the tool for interacting with the Windows Package Manager repo automatically. To use the token command, you can specify whether you want to store a new GitHub token or clear any existing cached tokens. If you choose not to provide a token when storing, the tool will initiate an OAuth flow and prompt for your GitHub login credentials.
When creating your own GitHub Personal Access Token (PAT) to be used with WingetCreate, make sure the following permissions are selected.
- Select "Tokens (classic)". Fine-grained tokens are not supported (#595)
- Select the public_repo scope to allow access to public repositories
- (Optional) Select the delete_repo scope permission if you want WingetCreate to automatically delete the forked repo that it created if the PR submission fails.
Warning
Using the --token argument may result in the token being logged.
For local development, it is recommended to go through the OAuth flow by omitting the --token argument.
For CI/CD scenarios, it is recommended to use the 'WINGET_CREATE_GITHUB_TOKEN' environment variable to store the token.
wingetcreate.exe token [\<options>]
wingetcreate.exe token --store --token <GitHubPersonalAccessToken>
wingetcreate.exe token --clear
The following arguments are available:
Argument |
Description |
|---|---|
| -c, --clear | Required. Clear the cached GitHub token |
| -s, --store | Required. Set the cached GitHub token. Can specify token to cache with --token parameter, otherwise will initiate OAuth flow. |
| -t, --token | GitHub personal access token used for direct submission to the Windows Package Manager repo. If no token is provided, tool will prompt for GitHub login credentials. |
| -?, --help | Gets additional help on this command. |