vpk (MacOS)
vpk -H
Description:
Velopack CLI 0.0.1049, for distributing applications.
Usage:
vpk [command] [options]
Options:
-h, -H, --help, --vhelp Show help (-h) or extended help (-H).
-x, --legacyConsole Disable console colors and interactive
components.
-y, --yes 'yes' by instead of 'no' in non-interactive
prompts.
--verbose Print diagnostic messages.
--skip-updates Skip update checks
Commands:
bundle Create's an OSX .app bundle from a folder containing
application files.
pack Converts application files into a release and installer.
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 bundle -H
Description:
Create's an OSX .app bundle from a folder containing application files.
Usage:
vpk bundle [options]
Options:
-o, --outputDir <DIR> ENV=VPK_OUTPUT_DIR Output directory
for created packages. [default:
Releases]
-c, --channel <NAME> ENV=VPK_CHANNEL The channel to use
for this release. [default: osx]
-r, --runtime <RID> ENV=VPK_RUNTIME The target runtime
to build packages for.
-u, --packId <ID> (REQ) ENV=VPK_PACK_ID Unique Id for
application bundle.
-v, --packVersion <VERSION> (REQ) ENV=VPK_PACK_VERSION Current version
for application bundle.
-p, --packDir <DIR> (REQ) ENV=VPK_PACK_DIR Directory
containing application files for
release.
--packAuthors <AUTHORS> ENV=VPK_PACK_AUTHORS Company name or
comma-delimited list of authors.
--packTitle <NAME> ENV=VPK_PACK_TITLE Display/friendly
name for application.
-i, --icon <PATH> ENV=VPK_ICON Path to icon file for
package.
-e, --mainExe <NAME> ENV=VPK_MAIN_EXE The file name (not
path) of the main/entry executable.
--exclude <REGEX> ENV=VPK_EXCLUDE A regex which
excludes matched files from the
package. [default: .*\.pdb]
--bundleId <ID> ENV=VPK_BUNDLE_ID Optional Apple
bundle Id.
--plist <PATH> ENV=VPK_PLIST A custom Info.plist to
use in the app bundle.
vpk pack -H
Description:
Converts application files into a release and installer.
Usage:
vpk pack [options]
Options:
-o, --outputDir <DIR> ENV=VPK_OUTPUT_DIR Output directory
for created packages. [default:
Releases]
-c, --channel <NAME> ENV=VPK_CHANNEL The channel to use
for this release. [default: osx]
-r, --runtime <RID> ENV=VPK_RUNTIME The target runtime
to build packages for.
-u, --packId <ID> (REQ) ENV=VPK_PACK_ID Unique Id for
application bundle.
-v, --packVersion <VERSION> (REQ) ENV=VPK_PACK_VERSION Current version
for application bundle.
-p, --packDir <DIR> (REQ) ENV=VPK_PACK_DIR Directory
containing application files for
release.
--packAuthors <AUTHORS> ENV=VPK_PACK_AUTHORS Company name or
comma-delimited list of authors.
--packTitle <NAME> ENV=VPK_PACK_TITLE Display/friendly
name for application.
--releaseNotes <PATH> ENV=VPK_RELEASE_NOTES File with
markdown-formatted notes for this
version.
--delta <BestSize|BestSpeed|None> ENV=VPK_DELTA Disable or set the
delta generation mode. [default:
BestSpeed]
-i, --icon <PATH> ENV=VPK_ICON Path to icon file for
package.
-e, --mainExe <NAME> ENV=VPK_MAIN_EXE The file name (not
path) of the main/entry executable.
--exclude <REGEX> ENV=VPK_EXCLUDE A regex which
excludes matched files from the
package. [default: .*\.pdb]
--noPortable ENV=VPK_NO_PORTABLE Skip generating
a portable bundle.
--noInst ENV=VPK_NO_INST Skip generating an
installer package.
--bundleId <ID> ENV=VPK_BUNDLE_ID Optional Apple
bundle Id.
--plist <PATH> ENV=VPK_PLIST A custom Info.plist to
use in the app bundle.
--instWelcome <PATH> ENV=VPK_INST_WELCOME Set the
installer package welcome content.
--instReadme <PATH> ENV=VPK_INST_README Set the
installer package readme content.
--instLicense <PATH> ENV=VPK_INST_LICENSE Set the
installer package license content.
--instConclusion <PATH> ENV=VPK_INST_CONCLUSION Set the
installer package conclusion content.
--signAppIdentity <SUBJECT> ENV=VPK_SIGN_APP_IDENTITY The
subject name of the cert to use for
app code signing.
--signInstallIdentity <SUBJECT> ENV=VPK_SIGN_INSTALL_IDENTITY The
subject name of the cert to use for
installation packages.
--signEntitlements <PATH> ENV=VPK_SIGN_ENTITLEMENTS Path to
entitlements file for hardened
runtime signing.
--notaryProfile <NAME> ENV=VPK_NOTARY_PROFILE Name of
profile containing Apple credentials
stored with notarytool.
--keychain <PATH> ENV=VPK_KEYCHAIN Path to keychain
file to use for codesign and
notarytool.
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:
-o, --outputDir <DIR> ENV=VPK_OUTPUT_DIR Output directory for created
packages. [default: Releases]
-c, --channel <NAME> ENV=VPK_CHANNEL The channel to use for this
release. [default: osx]
--repoUrl (REQ) ENV=VPK_REPO_URL Full url to the github
repository (eg.
'https://github.com/myname/myrepo').
--token ENV=VPK_TOKEN OAuth token to use as login
credentials.
--timeout <MINUTES> ENV=VPK_TIMEOUT Network timeout in minutes. [
default: 30]
--pre ENV=VPK_PRE Get latest pre-release instead of
stable.
vpk download gitea -H
Description:
Download latest release from Gitea repository.
Usage:
vpk download gitea [options]
Options:
-o, --outputDir <DIR> ENV=VPK_OUTPUT_DIR Output directory for created
packages. [default: Releases]
-c, --channel <NAME> ENV=VPK_CHANNEL The channel to use for this
release. [default: osx]
--repoUrl (REQ) ENV=VPK_REPO_URL Full url to the gitea
repository (eg.
'https://gitea.com/myname/myrepo').
--token ENV=VPK_TOKEN OAuth token to use as login
credentials.
--timeout <MINUTES> ENV=VPK_TIMEOUT Network timeout in minutes. [
default: 30]
--pre ENV=VPK_PRE Get latest pre-release instead of
stable.
vpk download s3 -H
Description:
Download latest release from an S3 bucket.
Usage:
vpk download s3 [options]
Options:
-o, --outputDir <DIR> ENV=VPK_OUTPUT_DIR Output directory for created
packages. [default: Releases]
-c, --channel <NAME> ENV=VPK_CHANNEL The channel to use for this
release. [default: osx]
--keyId <KEYID> ENV=VPK_KEY_ID Authentication identifier or
access key.
--secret <KEY> ENV=VPK_SECRET Authentication secret key.
--region <REGION> ENV=VPK_REGION AWS service region (eg.
us-west-1).
--session <TOKEN> ENV=VPK_SESSION Authentication session token.
--endpoint <URL> ENV=VPK_ENDPOINT Custom service url (backblaze,
digital ocean, etc).
--bucket <NAME> (REQ) ENV=VPK_BUCKET Name of the S3 bucket.
--prefix <PREFIX> ENV=VPK_PREFIX Prefix to the S3 url.
--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:
-o, --outputDir <DIR> ENV=VPK_OUTPUT_DIR Output directory for
created packages. [default: Releases]
-c, --channel <NAME> ENV=VPK_CHANNEL The channel to use for this
release. [default: osx]
--account <ACCOUNT> (REQ) ENV=VPK_ACCOUNT Account name
--key <KEY> ENV=VPK_KEY Account secret key
--sas <TOKEN> ENV=VPK_SAS Shared access signature token
(not the url)
--container <NAME> (REQ) ENV=VPK_CONTAINER Azure container name
--endpoint <URL> ENV=VPK_ENDPOINT Service url (eg.
https://<account-name>.blob.core.windows.net)
--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:
-o, --outputDir <DIR> ENV=VPK_OUTPUT_DIR Output directory for created
packages. [default: Releases]
-c, --channel <NAME> ENV=VPK_CHANNEL The channel to use for this
release. [default: osx]
--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:
-o, --outputDir <DIR> ENV=VPK_OUTPUT_DIR Output directory for created
packages. [default: Releases]
-c, --channel <NAME> ENV=VPK_CHANNEL The channel to use for this
release. [default: osx]
--url (REQ) ENV=VPK_URL Url to download remote releases
from.
--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:
-o, --outputDir <DIR> (REQ) ENV=VPK_OUTPUT_DIR Output directory for
created packages. [default: Releases]
-c, --channel <NAME> ENV=VPK_CHANNEL The channel to use for
this release. [default: osx]
--repoUrl (REQ) ENV=VPK_REPO_URL Full url to the github
repository (eg.
'https://github.com/myname/myrepo').
--token ENV=VPK_TOKEN OAuth token to use as login
credentials.
--timeout <MINUTES> ENV=VPK_TIMEOUT Network timeout in
minutes. [default: 30]
--publish ENV=VPK_PUBLISH Create and publish instead
of leaving as draft.
--pre ENV=VPK_PRE Create as pre-release instead
of stable.
--merge ENV=VPK_MERGE Allow merging this upload
with an existing release.
--releaseName <NAME> ENV=VPK_RELEASE_NAME A custom name for the
release.
--tag <NAME> ENV=VPK_TAG A custom tag for the release.
--targetCommitish <NAME> ENV=VPK_TARGET_COMMITISH A 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:
-o, --outputDir <DIR> (REQ) ENV=VPK_OUTPUT_DIR Output directory for
created packages. [default: Releases]
-c, --channel <NAME> ENV=VPK_CHANNEL The channel to use for
this release. [default: osx]
--repoUrl (REQ) ENV=VPK_REPO_URL Full url to the gitea
repository (eg.
'https://gitea.com/myname/myrepo').
--token ENV=VPK_TOKEN OAuth token to use as login
credentials.
--timeout <MINUTES> ENV=VPK_TIMEOUT Network timeout in
minutes. [default: 30]
--publish ENV=VPK_PUBLISH Create and publish instead
of leaving as draft.
--pre ENV=VPK_PRE Create as pre-release instead
of stable.
--merge ENV=VPK_MERGE Allow merging this upload
with an existing release.
--releaseName <NAME> ENV=VPK_RELEASE_NAME A custom name for the
release.
--tag <NAME> ENV=VPK_TAG A custom tag for the release.
--targetCommitish <NAME> ENV=VPK_TARGET_COMMITISH A 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:
-o, --outputDir <DIR> (REQ) ENV=VPK_OUTPUT_DIR Output directory for
created packages. [default: Releases]
-c, --channel <NAME> ENV=VPK_CHANNEL The channel to use for
this release. [default: osx]
--keyId <KEYID> ENV=VPK_KEY_ID Authentication identifier
or access key.
--secret <KEY> ENV=VPK_SECRET Authentication secret key.
--region <REGION> ENV=VPK_REGION AWS service region (eg.
us-west-1).
--session <TOKEN> ENV=VPK_SESSION Authentication session
token.
--endpoint <URL> ENV=VPK_ENDPOINT Custom service url
(backblaze, digital ocean, etc).
--bucket <NAME> (REQ) ENV=VPK_BUCKET Name of the S3 bucket.
--prefix <PREFIX> ENV=VPK_PREFIX Prefix to the S3 url.
--timeout <MINUTES> ENV=VPK_TIMEOUT Network timeout in
minutes. [default: 30]
--keepMaxReleases <COUNT> ENV=VPK_KEEP_MAX_RELEASES The 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:
-o, --outputDir <DIR> (REQ) ENV=VPK_OUTPUT_DIR Output directory for
created packages. [default: Releases]
-c, --channel <NAME> ENV=VPK_CHANNEL The channel to use for
this release. [default: osx]
--account <ACCOUNT> (REQ) ENV=VPK_ACCOUNT Account name
--key <KEY> ENV=VPK_KEY Account secret key
--sas <TOKEN> ENV=VPK_SAS Shared access signature token
(not the url)
--container <NAME> (REQ) ENV=VPK_CONTAINER Azure container name
--endpoint <URL> ENV=VPK_ENDPOINT Service url (eg.
https://<account-name>.blob.core.windows.ne
t)
--timeout <MINUTES> ENV=VPK_TIMEOUT Network timeout in
minutes. [default: 30]
--keepMaxReleases <COUNT> ENV=VPK_KEEP_MAX_RELEASES The 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:
-o, --outputDir <DIR> (REQ) ENV=VPK_OUTPUT_DIR Output directory for
created packages. [default: Releases]
-c, --channel <NAME> ENV=VPK_CHANNEL The channel to use for
this release. [default: osx]
--path <PATH> (REQ) ENV=VPK_PATH Target file path to copy
releases to/from.
--keepMaxReleases <COUNT> ENV=VPK_KEEP_MAX_RELEASES The maximum
number of releases to keep in the target
directory, anything older will be deleted.
--regenerate ENV=VPK_REGENERATE Force regenerate the
releases.{channel}.json file in the target
directory.
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 <BestSize|BestSpeed|None> ENV=VPK_MODE Set the delta generation
mode. [default: BestSpeed]
-b, --base <PATH> (REQ) ENV=VPK_BASE The base package for the
created patch.
-n, --new <PATH> (REQ) ENV=VPK_NEW The resulting package for
the created patch.
-o, --output <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:
-b, --base <PATH> (REQ) ENV=VPK_BASE The base package for the
created patch.
-p, --patch <PATH> ENV=VPK_PATCH The resulting package for the
created patch.
-o, --output <PATH> (REQ) ENV=VPK_OUTPUT The output file path for the
created patch.