vpk (Windows)
vpk -H
Description:
Velopack CLI 1.1.1, for distributing applications.
Usage:
vpk [command] [options]
Options:
--help, -h, -H, --vhelp Show help (-h) or extended help
(-H). [default: False]
--legacyConsole, -x <legacyConsole> Disable console colors and
interactive components. [default:
False]
--yes, -y <yes> 'yes' by instead of 'no' in
non-interactive prompts. [default:
False]
--verbose <verbose> Print diagnostic messages.
[default: False]
--skip-updates <skip-updates> Skip update checks [default: False]
Commands:
pack Creates a release from a folder containing application files.
download Download's the latest release from a remote update source.
upload Upload local package(s) to a remote update source.
delta Utilities for creating or applying delta packages.
vpk pack -H
Description:
Creates a release from a folder containing application files.
Usage:
vpk pack [options]
Options:
--outputDir, -o, --outputDir <DIR> ENV=VPK_OUTPUT_DIR Output
directory for created packages.
[default: Releases]
--channel, -c, --channel <NAME> ENV=VPK_CHANNEL The channel to use
for this release. [default: win]
--runtime, -r, --runtime <RID> ENV=VPK_RUNTIME The target runtime
to build packages for.
--packId, --packId, -u <ID> (REQ) ENV=VPK_PACK_ID Unique Id for
application bundle.
--packVersion, --packVersion, -v ENV=VPK_PACK_VERSION Current
<VERSION> (REQ) version for application bundle.
--packDir, --packDir, -p <DIR> ENV=VPK_PACK_DIR Directory
(REQ) containing application files for
release.
--packAuthors, --packAuthors ENV=VPK_PACK_AUTHORS Company name
<AUTHORS> or comma-delimited list of authors.
--packTitle, --packTitle <NAME> ENV=VPK_PACK_TITLE
Display/friendly name for
application.
--releaseNotes, --releaseNotes ENV=VPK_RELEASE_NOTES File with
<PATH> markdown-formatted notes for this
version.
--delta, --delta <delta> ENV=VPK_DELTA Disable or set the
delta generation mode. [default:
BestSpeed]
--icon, -i, --icon <PATH> ENV=VPK_ICON Path to icon file for
package.
--mainExe, -e, --mainExe <NAME> ENV=VPK_MAIN_EXE The file name
(not path) of the main/entry
executable.
--exclude, --exclude <REGEX> ENV=VPK_EXCLUDE A regex which
excludes matched files from the
package (in addition to built-in
defaults). [default: .*\.pdb]
--noDefaultExclude, ENV=VPK_NO_DEFAULT_EXCLUDE Do not
--noDefaultExclude exclude built-in default file
<noDefaultExclude> patterns (eg. .nupkg, createdump,
.vshost.). [default: False]
--noPortable, --noPortable ENV=VPK_NO_PORTABLE Skip
<noPortable> generating a portable bundle.
[default: False]
--noInst, --noInst <noInst> ENV=VPK_NO_INST Skip generating an
installer package. [default: False]
--framework, -f, --framework ENV=VPK_FRAMEWORK List of required
<RUNTIMES> runtimes to install during setup.
Example:
'net6-x64-desktop,vcredist143-x64'.
--splashImage, -s, --splashImage ENV=VPK_SPLASH_IMAGE Path to image
<PATH> displayed during installation.
--splashProgressColor, ENV=VPK_SPLASH_PROGRESS_COLOR
--splashProgressColor <COLOR> Progress bar color (e.g. #FF0000),
or 'None' to hide.
--skipVeloAppCheck, ENV=VPK_SKIP_VELO_APP_CHECK Skip
--skipVeloAppCheck the VelopackApp builder
<skipVeloAppCheck> verification. [default: False]
--signTemplate, --signTemplate ENV=VPK_SIGN_TEMPLATE Use a custom
<COMMAND> signing command. {{file}} will be
substituted.
--signExclude, --signExclude ENV=VPK_SIGN_EXCLUDE A regex which
<signExclude> excludes matched files from
signing.
--signParallel, --signParallel ENV=VPK_SIGN_PARALLEL The number
<NUM> of files to sign in each signing
command. [default: 10]
--aumid, --aumid <AUMID> ENV=VPK_AUMID Override the
Application User Model ID (AUMID)
for shortcuts.
--shortcuts, --shortcuts <LOC> ENV=VPK_SHORTCUTS List of
locations to install shortcuts to
during setup. [default:
Desktop,StartMenuRoot]
--signParams, --signParams, -n ENV=VPK_SIGN_PARAMS Sign files via
<PARAMS> signtool.exe using these
parameters.
--azureTrustedSignFile, ENV=VPK_AZURE_TRUSTED_SIGN_FILE
--azureTrustedSignFile <PATH> Path to Azure Trusted Signing
metadata.json.
--msi, --msi <msi> ENV=VPK_MSI Compile a .msi
machine-wide bootstrap package.
[default: False]
--msiVersion, --msiVersion ENV=VPK_MSI_VERSION Override the
<VERSION> product version for the generated
msi.
--instWelcome, --instWelcome <PATH> ENV=VPK_INST_WELCOME Set the
plain-text installer package
welcome content.
--instLicense, --instLicense <PATH> ENV=VPK_INST_LICENSE Set the
installer package license content.
Can be either RTF or Markdown.
--instReadme, --instReadme <PATH> ENV=VPK_INST_README Set the
installer package readme content.
Can be RTF, Markdown, or plain
text.
--instConclusion, --instConclusion ENV=VPK_INST_CONCLUSION Set the
<PATH> plain-text installer package
conclusion content.
--instLocation, --instLocation ENV=VPK_INST_LOCATION Set the
<LOCATION> installation location. [default:
Either]
--msiBanner, --msiBanner <PATH> ENV=VPK_MSI_BANNER Set the top
banner bitmap image for the MSI UI
dialogs. The resolution must be
493x58.
--msiLogo, --msiLogo <PATH> ENV=VPK_MSI_LOGO Set the
background logo bitmap image for
the MSI UI dialogs. The resolution
must be 493x312.
vpk download -H
Description:
Download's the latest release from a remote update source.
Usage:
vpk download [command] [options]
Commands:
github Download latest release from GitHub repository.
gitea Download latest release from Gitea repository.
s3 Download latest release from an S3 bucket.
az Download latest release from an Azure Blob Storage container.
local Download latest release from a local path or network share.
http Download latest release from a HTTP source.
vpk download github -H
Description:
Download latest release from GitHub repository.
Usage:
vpk download github [options]
Options:
--outputDir, -o, --outputDir <DIR> ENV=VPK_OUTPUT_DIR Output
directory for created packages.
[default: Releases]
--channel, -c, --channel <NAME> ENV=VPK_CHANNEL The channel to use
for this release. [default: win]
--repoUrl, --repoUrl <repoUrl> ENV=VPK_REPO_URL Full url to the
(REQ) github repository (eg.
'https://github.com/myname/myrepo')
.
--token, --token <token> ENV=VPK_TOKEN OAuth token to use
as login credentials.
--timeout, --timeout <MINUTES> ENV=VPK_TIMEOUT Network timeout in
minutes. [default: 30]
--pre, --pre <pre> ENV=VPK_PRE Get latest pre-release
instead of stable. [default: False]
vpk download gitea -H
Description:
Download latest release from Gitea repository.
Usage:
vpk download gitea [options]
Options:
--outputDir, -o, --outputDir <DIR> ENV=VPK_OUTPUT_DIR Output
directory for created packages.
[default: Releases]
--channel, -c, --channel <NAME> ENV=VPK_CHANNEL The channel to use
for this release. [default: win]
--repoUrl, --repoUrl <repoUrl> ENV=VPK_REPO_URL Full url to the
(REQ) gitea repository (eg.
'https://gitea.com/myname/myrepo').
--token, --token <token> ENV=VPK_TOKEN OAuth token to use
as login credentials.
--timeout, --timeout <MINUTES> ENV=VPK_TIMEOUT Network timeout in
minutes. [default: 30]
--pre, --pre <pre> ENV=VPK_PRE Get latest pre-release
instead of stable. [default: False]
vpk download s3 -H
Description:
Download latest release from an S3 bucket.
Usage:
vpk download s3 [options]
Options:
--outputDir, -o, --outputDir <DIR> ENV=VPK_OUTPUT_DIR Output
directory for created packages.
[default: Releases]
--channel, -c, --channel <NAME> ENV=VPK_CHANNEL The channel to use
for this release. [default: win]
--keyId, --keyId <KEYID> ENV=VPK_KEY_ID Authentication
identifier or access key.
--secret, --secret <KEY> ENV=VPK_SECRET Authentication
secret key.
--region, --region <REGION> ENV=VPK_REGION AWS service region
(eg. us-west-1).
--session, --session <TOKEN> ENV=VPK_SESSION Authentication
session token.
--endpoint, --endpoint <URL> ENV=VPK_ENDPOINT Custom
S3-compatible service url
(backblaze, digital ocean, etc).
--bucket, --bucket <NAME> (REQ) ENV=VPK_BUCKET Name of the S3
bucket.
--prefix, --prefix <PREFIX> ENV=VPK_PREFIX Optional filename
path prefix.
--disablePathStyle, ENV=VPK_DISABLE_PATH_STYLE Disable
--disablePathStyle <BOOL> the default of path-style endpoint
and use a subdomain endpoint
instead. [default: False]
--timeout, --timeout <MINUTES> ENV=VPK_TIMEOUT Network timeout in
minutes. [default: 30]
vpk download az -H
Description:
Download latest release from an Azure Blob Storage container.
Usage:
vpk download az [options]
Options:
--outputDir, -o, --outputDir <DIR> ENV=VPK_OUTPUT_DIR Output
directory for created packages.
[default: Releases]
--channel, -c, --channel <NAME> ENV=VPK_CHANNEL The channel to use
for this release. [default: win]
--account, --account <ACCOUNT> ENV=VPK_ACCOUNT Account name.
(REQ)
--key, --key <KEY> ENV=VPK_KEY Account secret key.
--sas, --sas <TOKEN> ENV=VPK_SAS Shared access
signature token (not the url).
--container, --container <NAME> ENV=VPK_CONTAINER Azure storage
(REQ) container name.
--prefix, --prefix <PREFIX> ENV=VPK_PREFIX Optional blob
filename path prefix.
--endpoint, --endpoint <URL> ENV=VPK_ENDPOINT Service url (eg.
https://<account-name>.blob.core.wi
ndows.net).
--timeout, --timeout <MINUTES> ENV=VPK_TIMEOUT Network timeout in
minutes. [default: 30]
vpk download local -H
Description:
Download latest release from a local path or network share.
Usage:
vpk download local [options]
Options:
--outputDir, -o, --outputDir <DIR> ENV=VPK_OUTPUT_DIR Output directory
for created packages. [default:
Releases]
--channel, -c, --channel <NAME> ENV=VPK_CHANNEL The channel to use
for this release. [default: win]
--path, --path <PATH> (REQ) ENV=VPK_PATH Target file path to
copy releases to/from.
vpk download http -H
Description:
Download latest release from a HTTP source.
Usage:
vpk download http [options]
Options:
--outputDir, -o, --outputDir <DIR> ENV=VPK_OUTPUT_DIR Output directory
for created packages. [default:
Releases]
--channel, -c, --channel <NAME> ENV=VPK_CHANNEL The channel to use
for this release. [default: win]
--url, --url <url> (REQ) ENV=VPK_URL Url to download remote
releases from.
--timeout, --timeout <MINUTES> ENV=VPK_TIMEOUT Network timeout in
minutes. [default: 30]
vpk upload -H
Description:
Upload local package(s) to a remote update source.
Usage:
vpk upload [command] [options]
Commands:
github Upload releases to a GitHub repository.
gitea Upload releases to a Gitea repository.
s3 Upload releases to a S3 bucket.
az Upload releases to an Azure Blob Storage container.
local Upload releases to a local path or network share.
vpk upload github -H
Description:
Upload releases to a GitHub repository.
Usage:
vpk upload github [options]
Options:
--outputDir, -o, --outputDir <DIR> ENV=VPK_OUTPUT_DIR Output
(REQ) directory for created packages.
[default: Releases]
--channel, -c, --channel <NAME> ENV=VPK_CHANNEL The channel to use
for this release. [default: win]
--repoUrl, --repoUrl <repoUrl> ENV=VPK_REPO_URL Full url to the
(REQ) github repository (eg.
'https://github.com/myname/myrepo')
.
--token, --token <token> ENV=VPK_TOKEN OAuth token to use
as login credentials.
--timeout, --timeout <MINUTES> ENV=VPK_TIMEOUT Network timeout in
minutes. [default: 30]
--publish, --publish <publish> ENV=VPK_PUBLISH Create and publish
instead of leaving as draft.
[default: False]
--pre, --pre <pre> ENV=VPK_PRE Create as pre-release
instead of stable. [default: False]
--merge, --merge <merge> ENV=VPK_MERGE Allow merging this
upload with an existing release.
[default: False]
--releaseName, --releaseName <NAME> ENV=VPK_RELEASE_NAME A custom name
for the release.
--tag, --tag <NAME> ENV=VPK_TAG A custom tag for the
release.
--targetCommitish, ENV=VPK_TARGET_COMMITISH A
--targetCommitish <NAME> commitish value for tag (branch or
commit SHA).
vpk upload gitea -H
Description:
Upload releases to a Gitea repository.
Usage:
vpk upload gitea [options]
Options:
--outputDir, -o, --outputDir <DIR> ENV=VPK_OUTPUT_DIR Output
(REQ) directory for created packages.
[default: Releases]
--channel, -c, --channel <NAME> ENV=VPK_CHANNEL The channel to use
for this release. [default: win]
--repoUrl, --repoUrl <repoUrl> ENV=VPK_REPO_URL Full url to the
(REQ) gitea repository (eg.
'https://gitea.com/myname/myrepo').
--token, --token <token> ENV=VPK_TOKEN OAuth token to use
as login credentials.
--timeout, --timeout <MINUTES> ENV=VPK_TIMEOUT Network timeout in
minutes. [default: 30]
--publish, --publish <publish> ENV=VPK_PUBLISH Create and publish
instead of leaving as draft.
[default: False]
--pre, --pre <pre> ENV=VPK_PRE Create as pre-release
instead of stable. [default: False]
--merge, --merge <merge> ENV=VPK_MERGE Allow merging this
upload with an existing release.
[default: False]
--releaseName, --releaseName <NAME> ENV=VPK_RELEASE_NAME A custom name
for the release.
--tag, --tag <NAME> ENV=VPK_TAG A custom tag for the
release.
--targetCommitish, ENV=VPK_TARGET_COMMITISH A
--targetCommitish <NAME> commitish value for tag (branch or
commit SHA).
vpk upload s3 -H
Description:
Upload releases to a S3 bucket.
Usage:
vpk upload s3 [options]
Options:
--outputDir, -o, --outputDir <DIR> ENV=VPK_OUTPUT_DIR Output
(REQ) directory for created packages.
[default: Releases]
--channel, -c, --channel <NAME> ENV=VPK_CHANNEL The channel to use
for this release. [default: win]
--keyId, --keyId <KEYID> ENV=VPK_KEY_ID Authentication
identifier or access key.
--secret, --secret <KEY> ENV=VPK_SECRET Authentication
secret key.
--region, --region <REGION> ENV=VPK_REGION AWS service region
(eg. us-west-1).
--session, --session <TOKEN> ENV=VPK_SESSION Authentication
session token.
--endpoint, --endpoint <URL> ENV=VPK_ENDPOINT Custom
S3-compatible service url
(backblaze, digital ocean, etc).
--bucket, --bucket <NAME> (REQ) ENV=VPK_BUCKET Name of the S3
bucket.
--prefix, --prefix <PREFIX> ENV=VPK_PREFIX Optional filename
path prefix.
--disablePathStyle, ENV=VPK_DISABLE_PATH_STYLE Disable
--disablePathStyle <BOOL> the default of path-style endpoint
and use a subdomain endpoint
instead. [default: False]
--timeout, --timeout <MINUTES> ENV=VPK_TIMEOUT Network timeout in
minutes. [default: 30]
--keepMaxReleases, ENV=VPK_KEEP_MAX_RELEASES The
--keepMaxReleases <COUNT> maximum number of releases to keep
in the bucket, anything older will
be deleted.
vpk upload az -H
Description:
Upload releases to an Azure Blob Storage container.
Usage:
vpk upload az [options]
Options:
--outputDir, -o, --outputDir <DIR> ENV=VPK_OUTPUT_DIR Output
(REQ) directory for created packages.
[default: Releases]
--channel, -c, --channel <NAME> ENV=VPK_CHANNEL The channel to use
for this release. [default: win]
--account, --account <ACCOUNT> ENV=VPK_ACCOUNT Account name.
(REQ)
--key, --key <KEY> ENV=VPK_KEY Account secret key.
--sas, --sas <TOKEN> ENV=VPK_SAS Shared access
signature token (not the url).
--container, --container <NAME> ENV=VPK_CONTAINER Azure storage
(REQ) container name.
--prefix, --prefix <PREFIX> ENV=VPK_PREFIX Optional blob
filename path prefix.
--endpoint, --endpoint <URL> ENV=VPK_ENDPOINT Service url (eg.
https://<account-name>.blob.core.wi
ndows.net).
--timeout, --timeout <MINUTES> ENV=VPK_TIMEOUT Network timeout in
minutes. [default: 30]
--keepMaxReleases, ENV=VPK_KEEP_MAX_RELEASES The
--keepMaxReleases <COUNT> maximum number of releases to keep
in the container, anything older
will be deleted.
vpk upload local -H
Description:
Upload releases to a local path or network share.
Usage:
vpk upload local [options]
Options:
--outputDir, -o, --outputDir <DIR> ENV=VPK_OUTPUT_DIR Output
(REQ) directory for created packages.
[default: Releases]
--channel, -c, --channel <NAME> ENV=VPK_CHANNEL The channel to use
for this release. [default: win]
--path, --path <PATH> (REQ) ENV=VPK_PATH Target file path to
copy releases to/from.
--keepMaxReleases, ENV=VPK_KEEP_MAX_RELEASES The
--keepMaxReleases <COUNT> maximum number of releases to keep
in the target directory, anything
older will be deleted.
--regenerate, --regenerate ENV=VPK_REGENERATE Force
<regenerate> regenerate the
releases.{channel}.json file in the
target directory. [default: False]
vpk delta -H
Description:
Utilities for creating or applying delta packages.
Usage:
vpk delta [command] [options]
Commands:
generate Generate a delta patch from two full releases.
patch Patch a base package and retrieve the original new package.
vpk delta generate -H
Description:
Generate a delta patch from two full releases.
Usage:
vpk delta generate [options]
Options:
--mode, --mode <mode> ENV=VPK_MODE Set the delta
generation mode. [default:
BestSpeed]
--base, --base, -b <PATH> (REQ) ENV=VPK_BASE The base package for
the created patch.
--new, --new, -n <PATH> (REQ) ENV=VPK_NEW The resulting package
for the created patch.
--output, --output, -o <PATH> (REQ) ENV=VPK_OUTPUT The output file
path for the created patch.
vpk delta patch -H
Description:
Patch a base package and retrieve the original new package.
Usage:
vpk delta patch [options]
Options:
--base, --base, -b <PATH> (REQ) ENV=VPK_BASE The base package for
the created patch.
--patch, --patch, -p <PATH> ENV=VPK_PATCH The resulting
package for the created patch.
--output, --output, -o <PATH> (REQ) ENV=VPK_OUTPUT The output file
path for the created patch.