From 16da6a9d9ca17ae2cee5671d7d61dac06f4bf2ff Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 23 Oct 2024 20:52:31 +0000 Subject: [PATCH] automatic update --- docs/reference/cli/content/vpk-linux.mdx | 310 +++++++++--------- docs/reference/cli/content/vpk-osx.mdx | 364 ++++++++++----------- docs/reference/cli/content/vpk-windows.mdx | 326 +++++++++--------- 3 files changed, 500 insertions(+), 500 deletions(-) diff --git a/docs/reference/cli/content/vpk-linux.mdx b/docs/reference/cli/content/vpk-linux.mdx index b89c346..46b58ce 100644 --- a/docs/reference/cli/content/vpk-linux.mdx +++ b/docs/reference/cli/content/vpk-linux.mdx @@ -4,70 +4,70 @@ ## `vpk -H` ``` Description: - Velopack CLI 0.0.626, for distributing applications. + Velopack CLI 0.0.626, for distributing applications. Usage: - vpk [command] [options] + vpk [command] [options] Options: - -h, -H, --help, --vhelp Show help (-h) or extended help (-H). - -x, --legacyConsole Disable console colors and interactive + -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 + -y, --yes 'yes' by instead of 'no' in non-interactive prompts. - --verbose Print diagnostic messages. - --skip-updates Skip update checks + --verbose Print diagnostic messages. + --skip-updates Skip update checks Commands: - pack Create a Linux .AppImage bundle from 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. + pack Create a Linux .AppImage bundle from 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: - Create a Linux .AppImage bundle from application files. + Create a Linux .AppImage bundle from application files. Usage: - vpk pack [options] + vpk pack [options] Options: - -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory + -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: linux] - -r, --runtime ENV=VPK_RUNTIME The target runtime + -r, --runtime ENV=VPK_RUNTIME The target runtime to build packages for. - -u, --packId (REQ) ENV=VPK_PACK_ID Unique Id for + -u, --packId (REQ) ENV=VPK_PACK_ID Unique Id for application bundle. - -v, --packVersion (REQ) ENV=VPK_PACK_VERSION Current version + -v, --packVersion (REQ) ENV=VPK_PACK_VERSION Current version for application bundle. - -p, --packDir (REQ) ENV=VPK_PACK_DIR Directory + -p, --packDir (REQ) ENV=VPK_PACK_DIR Directory containing application files for release. - --packAuthors ENV=VPK_PACK_AUTHORS Company name or + --packAuthors ENV=VPK_PACK_AUTHORS Company name or comma-delimited list of authors. - --packTitle ENV=VPK_PACK_TITLE Display/friendly + --packTitle ENV=VPK_PACK_TITLE Display/friendly name for application. - --releaseNotes ENV=VPK_RELEASE_NOTES File with + --releaseNotes ENV=VPK_RELEASE_NOTES File with markdown-formatted notes for this version. - --delta ENV=VPK_DELTA Disable or set the + --delta ENV=VPK_DELTA Disable or set the delta generation mode. [default: BestSpeed] - -i, --icon ENV=VPK_ICON Path to icon file for + -i, --icon ENV=VPK_ICON Path to icon file for package. - -e, --mainExe ENV=VPK_MAIN_EXE The file name (not + -e, --mainExe ENV=VPK_MAIN_EXE The file name (not path) of the main/entry executable. - --exclude ENV=VPK_EXCLUDE A regex which + --exclude ENV=VPK_EXCLUDE A regex which excludes matched files from the package. [default: .*\.pdb] - --categories ENV=VPK_CATEGORIES Categories from + --categories ENV=VPK_CATEGORIES Categories from the freedesktop.org Desktop Menu spec - --compression ENV=VPK_COMPRESSION Set the + --compression ENV=VPK_COMPRESSION Set the compression algorithm to use for the AppImage [default: xz] ``` @@ -75,248 +75,248 @@ Options: ## `vpk download -H` ``` Description: - Download's the latest release from a remote update source. + Download's the latest release from a remote update source. Usage: - vpk download [command] [options] + 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. + 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. + Download latest release from GitHub repository. Usage: - vpk download github [options] + vpk download github [options] Options: - -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created + -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for this + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: linux] - --repoUrl (REQ) ENV=VPK_REPO_URL Full url to the github + --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 + --token ENV=VPK_TOKEN OAuth token to use as login credentials. - --pre ENV=VPK_PRE Get latest pre-release instead of + --pre ENV=VPK_PRE Get latest pre-release instead of stable. ``` ## `vpk download gitea -H` ``` Description: - Download latest release from Gitea repository. + Download latest release from Gitea repository. Usage: - vpk download gitea [options] + vpk download gitea [options] Options: - -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created + -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for this + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: linux] - --repoUrl (REQ) ENV=VPK_REPO_URL Full url to the gitea + --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 + --token ENV=VPK_TOKEN OAuth token to use as login credentials. - --pre ENV=VPK_PRE Get latest pre-release instead of + --pre ENV=VPK_PRE Get latest pre-release instead of stable. ``` ## `vpk download s3 -H` ``` Description: - Download latest release from an S3 bucket. + Download latest release from an S3 bucket. Usage: - vpk download s3 [options] + vpk download s3 [options] Options: - -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created + -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for this + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: linux] - --keyId ENV=VPK_KEY_ID Authentication identifier or + --keyId ENV=VPK_KEY_ID Authentication identifier or access key. - --secret ENV=VPK_SECRET Authentication secret key. - --region ENV=VPK_REGION AWS service region (eg. + --secret ENV=VPK_SECRET Authentication secret key. + --region ENV=VPK_REGION AWS service region (eg. us-west-1). - --session ENV=VPK_SESSION Authentication session token. - --endpoint ENV=VPK_ENDPOINT Custom service url (backblaze, + --session ENV=VPK_SESSION Authentication session token. + --endpoint ENV=VPK_ENDPOINT Custom service url (backblaze, digital ocean, etc). - --bucket (REQ) ENV=VPK_BUCKET Name of the S3 bucket. - --prefix ENV=VPK_PREFIX Prefix to the S3 url. + --bucket (REQ) ENV=VPK_BUCKET Name of the S3 bucket. + --prefix ENV=VPK_PREFIX Prefix to the S3 url. ``` ## `vpk download az -H` ``` Description: - Download latest release from an Azure Blob Storage container. + Download latest release from an Azure Blob Storage container. Usage: - vpk download az [options] + vpk download az [options] Options: - -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for + -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for this + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: linux] - --account (REQ) ENV=VPK_ACCOUNT Account name - --key ENV=VPK_KEY Account secret key - --sas ENV=VPK_SAS Shared access signature token + --account (REQ) ENV=VPK_ACCOUNT Account name + --key ENV=VPK_KEY Account secret key + --sas ENV=VPK_SAS Shared access signature token (not the url) - --container (REQ) ENV=VPK_CONTAINER Azure container name - --endpoint ENV=VPK_ENDPOINT Service url (eg. + --container (REQ) ENV=VPK_CONTAINER Azure container name + --endpoint ENV=VPK_ENDPOINT Service url (eg. https://.blob.core.windows.net) ``` ## `vpk download local -H` ``` Description: - Download latest release from a local path or network share. + Download latest release from a local path or network share. Usage: - vpk download local [options] + vpk download local [options] Options: - -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created + -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for this + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: linux] - --path (REQ) ENV=VPK_PATH Target file path to copy releases + --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. + Download latest release from a HTTP source. Usage: - vpk download http [options] + vpk download http [options] Options: - -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created + -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for this + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: linux] - --url (REQ) ENV=VPK_URL Url to download remote releases + --url (REQ) ENV=VPK_URL Url to download remote releases from. ``` ## `vpk upload -H` ``` Description: - Upload local package(s) to a remote update source. + Upload local package(s) to a remote update source. Usage: - vpk upload [command] [options] + 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. + 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. + Upload releases to a GitHub repository. Usage: - vpk upload github [options] + vpk upload github [options] Options: - -o, --outputDir (REQ) ENV=VPK_OUTPUT_DIR Output directory for + -o, --outputDir (REQ) ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: linux] - --repoUrl (REQ) ENV=VPK_REPO_URL Full url to the github + --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 + --token ENV=VPK_TOKEN OAuth token to use as login credentials. - --publish ENV=VPK_PUBLISH Create and publish instead + --publish ENV=VPK_PUBLISH Create and publish instead of leaving as draft. - --pre ENV=VPK_PRE Create as pre-release instead + --pre ENV=VPK_PRE Create as pre-release instead of stable. - --merge ENV=VPK_MERGE Allow merging this upload + --merge ENV=VPK_MERGE Allow merging this upload with an existing release. - --releaseName ENV=VPK_RELEASE_NAME A custom name for the + --releaseName ENV=VPK_RELEASE_NAME A custom name for the release. - --tag ENV=VPK_TAG A custom tag for the release. - --targetCommitish ENV=VPK_TARGET_COMMITISH A commitish value + --tag ENV=VPK_TAG A custom tag for the release. + --targetCommitish ENV=VPK_TARGET_COMMITISH A commitish value for tag (branch or commit SHA). ``` ## `vpk upload gitea -H` ``` Description: - Upload releases to a Gitea repository. + Upload releases to a Gitea repository. Usage: - vpk upload gitea [options] + vpk upload gitea [options] Options: - -o, --outputDir (REQ) ENV=VPK_OUTPUT_DIR Output directory for + -o, --outputDir (REQ) ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: linux] - --repoUrl (REQ) ENV=VPK_REPO_URL Full url to the gitea + --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 + --token ENV=VPK_TOKEN OAuth token to use as login credentials. - --publish ENV=VPK_PUBLISH Create and publish instead + --publish ENV=VPK_PUBLISH Create and publish instead of leaving as draft. - --pre ENV=VPK_PRE Create as pre-release instead + --pre ENV=VPK_PRE Create as pre-release instead of stable. - --merge ENV=VPK_MERGE Allow merging this upload + --merge ENV=VPK_MERGE Allow merging this upload with an existing release. - --releaseName ENV=VPK_RELEASE_NAME A custom name for the + --releaseName ENV=VPK_RELEASE_NAME A custom name for the release. - --tag ENV=VPK_TAG A custom tag for the release. - --targetCommitish ENV=VPK_TARGET_COMMITISH A commitish value + --tag ENV=VPK_TAG A custom tag for the release. + --targetCommitish ENV=VPK_TARGET_COMMITISH A commitish value for tag (branch or commit SHA). ``` ## `vpk upload s3 -H` ``` Description: - Upload releases to a S3 bucket. + Upload releases to a S3 bucket. Usage: - vpk upload s3 [options] + vpk upload s3 [options] Options: - -o, --outputDir (REQ) ENV=VPK_OUTPUT_DIR Output directory for + -o, --outputDir (REQ) ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: linux] - --keyId ENV=VPK_KEY_ID Authentication identifier + --keyId ENV=VPK_KEY_ID Authentication identifier or access key. - --secret ENV=VPK_SECRET Authentication secret key. - --region ENV=VPK_REGION AWS service region (eg. + --secret ENV=VPK_SECRET Authentication secret key. + --region ENV=VPK_REGION AWS service region (eg. us-west-1). - --session ENV=VPK_SESSION Authentication session + --session ENV=VPK_SESSION Authentication session token. - --endpoint ENV=VPK_ENDPOINT Custom service url + --endpoint ENV=VPK_ENDPOINT Custom service url (backblaze, digital ocean, etc). - --bucket (REQ) ENV=VPK_BUCKET Name of the S3 bucket. - --prefix ENV=VPK_PREFIX Prefix to the S3 url. - --keepMaxReleases ENV=VPK_KEEP_MAX_RELEASES The maximum + --bucket (REQ) ENV=VPK_BUCKET Name of the S3 bucket. + --prefix ENV=VPK_PREFIX Prefix to the S3 url. + --keepMaxReleases ENV=VPK_KEEP_MAX_RELEASES The maximum number of releases to keep in the bucket, anything older will be deleted. ``` @@ -324,25 +324,25 @@ Options: ## `vpk upload az -H` ``` Description: - Upload releases to an Azure Blob Storage container. + Upload releases to an Azure Blob Storage container. Usage: - vpk upload az [options] + vpk upload az [options] Options: - -o, --outputDir (REQ) ENV=VPK_OUTPUT_DIR Output directory for + -o, --outputDir (REQ) ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: linux] - --account (REQ) ENV=VPK_ACCOUNT Account name - --key ENV=VPK_KEY Account secret key - --sas ENV=VPK_SAS Shared access signature token + --account (REQ) ENV=VPK_ACCOUNT Account name + --key ENV=VPK_KEY Account secret key + --sas ENV=VPK_SAS Shared access signature token (not the url) - --container (REQ) ENV=VPK_CONTAINER Azure container name - --endpoint ENV=VPK_ENDPOINT Service url (eg. + --container (REQ) ENV=VPK_CONTAINER Azure container name + --endpoint ENV=VPK_ENDPOINT Service url (eg. https://.blob.core.windows.ne t) - --keepMaxReleases ENV=VPK_KEEP_MAX_RELEASES The maximum + --keepMaxReleases ENV=VPK_KEEP_MAX_RELEASES The maximum number of releases to keep in the container, anything older will be deleted. ``` @@ -350,22 +350,22 @@ Options: ## `vpk upload local -H` ``` Description: - Upload releases to a local path or network share. + Upload releases to a local path or network share. Usage: - vpk upload local [options] + vpk upload local [options] Options: - -o, --outputDir (REQ) ENV=VPK_OUTPUT_DIR Output directory for + -o, --outputDir (REQ) ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: linux] - --path (REQ) ENV=VPK_PATH Target file path to copy + --path (REQ) ENV=VPK_PATH Target file path to copy releases to/from. - --keepMaxReleases ENV=VPK_KEEP_MAX_RELEASES The maximum + --keepMaxReleases 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 + --regenerate ENV=VPK_REGENERATE Force regenerate the releases.{channel}.json file in the target directory. ``` @@ -373,48 +373,48 @@ Options: ## `vpk delta -H` ``` Description: - Utilities for creating or applying delta packages. + Utilities for creating or applying delta packages. Usage: - vpk delta [command] [options] + 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. + 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. + Generate a delta patch from two full releases. Usage: - vpk delta generate [options] + vpk delta generate [options] Options: - --mode ENV=VPK_MODE Set the delta generation + --mode ENV=VPK_MODE Set the delta generation mode. [default: BestSpeed] - -b, --base (REQ) ENV=VPK_BASE The base package for the + -b, --base (REQ) ENV=VPK_BASE The base package for the created patch. - -n, --new (REQ) ENV=VPK_NEW The resulting package for + -n, --new (REQ) ENV=VPK_NEW The resulting package for the created patch. - -o, --output (REQ) ENV=VPK_OUTPUT The output file path + -o, --output (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. + Patch a base package and retrieve the original new package. Usage: - vpk delta patch [options] + vpk delta patch [options] Options: - -b, --base (REQ) ENV=VPK_BASE The base package for the + -b, --base (REQ) ENV=VPK_BASE The base package for the created patch. - -p, --patch ENV=VPK_PATCH The resulting package for the + -p, --patch ENV=VPK_PATCH The resulting package for the created patch. - -o, --output (REQ) ENV=VPK_OUTPUT The output file path for the + -o, --output (REQ) ENV=VPK_OUTPUT The output file path for the created patch. ``` diff --git a/docs/reference/cli/content/vpk-osx.mdx b/docs/reference/cli/content/vpk-osx.mdx index 20cedf2..191be5d 100644 --- a/docs/reference/cli/content/vpk-osx.mdx +++ b/docs/reference/cli/content/vpk-osx.mdx @@ -4,138 +4,138 @@ ## `vpk -H` ``` Description: - Velopack CLI 0.0.626, for distributing applications. + Velopack CLI 0.0.626, for distributing applications. Usage: - vpk [command] [options] + vpk [command] [options] Options: - -h, -H, --help, --vhelp Show help (-h) or extended help (-H). - -x, --legacyConsole Disable console colors and interactive + -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 + -y, --yes 'yes' by instead of 'no' in non-interactive prompts. - --verbose Print diagnostic messages. - --skip-updates Skip update checks + --verbose Print diagnostic messages. + --skip-updates Skip update checks Commands: - bundle Create's an OSX .app bundle from a folder containing + 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. + 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. + Create's an OSX .app bundle from a folder containing application files. Usage: - vpk bundle [options] + vpk bundle [options] Options: - -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory + -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: osx] - -r, --runtime ENV=VPK_RUNTIME The target runtime + -r, --runtime ENV=VPK_RUNTIME The target runtime to build packages for. - -u, --packId (REQ) ENV=VPK_PACK_ID Unique Id for + -u, --packId (REQ) ENV=VPK_PACK_ID Unique Id for application bundle. - -v, --packVersion (REQ) ENV=VPK_PACK_VERSION Current version + -v, --packVersion (REQ) ENV=VPK_PACK_VERSION Current version for application bundle. - -p, --packDir (REQ) ENV=VPK_PACK_DIR Directory + -p, --packDir (REQ) ENV=VPK_PACK_DIR Directory containing application files for release. - --packAuthors ENV=VPK_PACK_AUTHORS Company name or + --packAuthors ENV=VPK_PACK_AUTHORS Company name or comma-delimited list of authors. - --packTitle ENV=VPK_PACK_TITLE Display/friendly + --packTitle ENV=VPK_PACK_TITLE Display/friendly name for application. - -i, --icon ENV=VPK_ICON Path to icon file for + -i, --icon ENV=VPK_ICON Path to icon file for package. - -e, --mainExe ENV=VPK_MAIN_EXE The file name (not + -e, --mainExe ENV=VPK_MAIN_EXE The file name (not path) of the main/entry executable. - --exclude ENV=VPK_EXCLUDE A regex which + --exclude ENV=VPK_EXCLUDE A regex which excludes matched files from the package. [default: .*\.pdb] - --bundleId ENV=VPK_BUNDLE_ID Optional Apple + --bundleId ENV=VPK_BUNDLE_ID Optional Apple bundle Id. - --plist ENV=VPK_PLIST A custom Info.plist to + --plist 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. + Converts application files into a release and installer. Usage: - vpk pack [options] + vpk pack [options] Options: - -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory + -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: osx] - -r, --runtime ENV=VPK_RUNTIME The target runtime + -r, --runtime ENV=VPK_RUNTIME The target runtime to build packages for. - -u, --packId (REQ) ENV=VPK_PACK_ID Unique Id for + -u, --packId (REQ) ENV=VPK_PACK_ID Unique Id for application bundle. - -v, --packVersion (REQ) ENV=VPK_PACK_VERSION Current version + -v, --packVersion (REQ) ENV=VPK_PACK_VERSION Current version for application bundle. - -p, --packDir (REQ) ENV=VPK_PACK_DIR Directory + -p, --packDir (REQ) ENV=VPK_PACK_DIR Directory containing application files for release. - --packAuthors ENV=VPK_PACK_AUTHORS Company name or + --packAuthors ENV=VPK_PACK_AUTHORS Company name or comma-delimited list of authors. - --packTitle ENV=VPK_PACK_TITLE Display/friendly + --packTitle ENV=VPK_PACK_TITLE Display/friendly name for application. - --releaseNotes ENV=VPK_RELEASE_NOTES File with + --releaseNotes ENV=VPK_RELEASE_NOTES File with markdown-formatted notes for this version. - --delta ENV=VPK_DELTA Disable or set the + --delta ENV=VPK_DELTA Disable or set the delta generation mode. [default: BestSpeed] - -i, --icon ENV=VPK_ICON Path to icon file for + -i, --icon ENV=VPK_ICON Path to icon file for package. - -e, --mainExe ENV=VPK_MAIN_EXE The file name (not + -e, --mainExe ENV=VPK_MAIN_EXE The file name (not path) of the main/entry executable. - --exclude ENV=VPK_EXCLUDE A regex which + --exclude ENV=VPK_EXCLUDE A regex which excludes matched files from the package. [default: .*\.pdb] - --noPortable ENV=VPK_NO_PORTABLE Skip generating + --noPortable ENV=VPK_NO_PORTABLE Skip generating a portable bundle. - --noInst ENV=VPK_NO_INST Skip generating an + --noInst ENV=VPK_NO_INST Skip generating an installer package. - --bundleId ENV=VPK_BUNDLE_ID Optional Apple + --bundleId ENV=VPK_BUNDLE_ID Optional Apple bundle Id. - --plist ENV=VPK_PLIST A custom Info.plist to + --plist ENV=VPK_PLIST A custom Info.plist to use in the app bundle. - --instWelcome ENV=VPK_INST_WELCOME Set the + --instWelcome ENV=VPK_INST_WELCOME Set the installer package welcome content. - --instReadme ENV=VPK_INST_README Set the + --instReadme ENV=VPK_INST_README Set the installer package readme content. - --instLicense ENV=VPK_INST_LICENSE Set the + --instLicense ENV=VPK_INST_LICENSE Set the installer package license content. - --instConclusion ENV=VPK_INST_CONCLUSION Set the + --instConclusion ENV=VPK_INST_CONCLUSION Set the installer package conclusion content. - --signAppIdentity ENV=VPK_SIGN_APP_IDENTITY The + --signAppIdentity ENV=VPK_SIGN_APP_IDENTITY The subject name of the cert to use for app code signing. - --signInstallIdentity ENV=VPK_SIGN_INSTALL_IDENTITY The + --signInstallIdentity ENV=VPK_SIGN_INSTALL_IDENTITY The subject name of the cert to use for installation packages. - --signEntitlements ENV=VPK_SIGN_ENTITLEMENTS Path to + --signEntitlements ENV=VPK_SIGN_ENTITLEMENTS Path to entitlements file for hardened runtime signing. - --notaryProfile ENV=VPK_NOTARY_PROFILE Name of + --notaryProfile ENV=VPK_NOTARY_PROFILE Name of profile containing Apple credentials stored with notarytool. - --keychain ENV=VPK_KEYCHAIN Path to keychain + --keychain ENV=VPK_KEYCHAIN Path to keychain file to use for codesign and notarytool. ``` @@ -143,248 +143,248 @@ Options: ## `vpk download -H` ``` Description: - Download's the latest release from a remote update source. + Download's the latest release from a remote update source. Usage: - vpk download [command] [options] + 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. + 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. + Download latest release from GitHub repository. Usage: - vpk download github [options] + vpk download github [options] Options: - -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created + -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for this + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: osx] - --repoUrl (REQ) ENV=VPK_REPO_URL Full url to the github + --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 + --token ENV=VPK_TOKEN OAuth token to use as login credentials. - --pre ENV=VPK_PRE Get latest pre-release instead of + --pre ENV=VPK_PRE Get latest pre-release instead of stable. ``` ## `vpk download gitea -H` ``` Description: - Download latest release from Gitea repository. + Download latest release from Gitea repository. Usage: - vpk download gitea [options] + vpk download gitea [options] Options: - -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created + -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for this + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: osx] - --repoUrl (REQ) ENV=VPK_REPO_URL Full url to the gitea + --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 + --token ENV=VPK_TOKEN OAuth token to use as login credentials. - --pre ENV=VPK_PRE Get latest pre-release instead of + --pre ENV=VPK_PRE Get latest pre-release instead of stable. ``` ## `vpk download s3 -H` ``` Description: - Download latest release from an S3 bucket. + Download latest release from an S3 bucket. Usage: - vpk download s3 [options] + vpk download s3 [options] Options: - -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created + -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for this + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: osx] - --keyId ENV=VPK_KEY_ID Authentication identifier or + --keyId ENV=VPK_KEY_ID Authentication identifier or access key. - --secret ENV=VPK_SECRET Authentication secret key. - --region ENV=VPK_REGION AWS service region (eg. + --secret ENV=VPK_SECRET Authentication secret key. + --region ENV=VPK_REGION AWS service region (eg. us-west-1). - --session ENV=VPK_SESSION Authentication session token. - --endpoint ENV=VPK_ENDPOINT Custom service url (backblaze, + --session ENV=VPK_SESSION Authentication session token. + --endpoint ENV=VPK_ENDPOINT Custom service url (backblaze, digital ocean, etc). - --bucket (REQ) ENV=VPK_BUCKET Name of the S3 bucket. - --prefix ENV=VPK_PREFIX Prefix to the S3 url. + --bucket (REQ) ENV=VPK_BUCKET Name of the S3 bucket. + --prefix ENV=VPK_PREFIX Prefix to the S3 url. ``` ## `vpk download az -H` ``` Description: - Download latest release from an Azure Blob Storage container. + Download latest release from an Azure Blob Storage container. Usage: - vpk download az [options] + vpk download az [options] Options: - -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for + -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for this + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: osx] - --account (REQ) ENV=VPK_ACCOUNT Account name - --key ENV=VPK_KEY Account secret key - --sas ENV=VPK_SAS Shared access signature token + --account (REQ) ENV=VPK_ACCOUNT Account name + --key ENV=VPK_KEY Account secret key + --sas ENV=VPK_SAS Shared access signature token (not the url) - --container (REQ) ENV=VPK_CONTAINER Azure container name - --endpoint ENV=VPK_ENDPOINT Service url (eg. + --container (REQ) ENV=VPK_CONTAINER Azure container name + --endpoint ENV=VPK_ENDPOINT Service url (eg. https://.blob.core.windows.net) ``` ## `vpk download local -H` ``` Description: - Download latest release from a local path or network share. + Download latest release from a local path or network share. Usage: - vpk download local [options] + vpk download local [options] Options: - -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created + -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for this + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: osx] - --path (REQ) ENV=VPK_PATH Target file path to copy releases + --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. + Download latest release from a HTTP source. Usage: - vpk download http [options] + vpk download http [options] Options: - -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created + -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for this + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: osx] - --url (REQ) ENV=VPK_URL Url to download remote releases + --url (REQ) ENV=VPK_URL Url to download remote releases from. ``` ## `vpk upload -H` ``` Description: - Upload local package(s) to a remote update source. + Upload local package(s) to a remote update source. Usage: - vpk upload [command] [options] + 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. + 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. + Upload releases to a GitHub repository. Usage: - vpk upload github [options] + vpk upload github [options] Options: - -o, --outputDir (REQ) ENV=VPK_OUTPUT_DIR Output directory for + -o, --outputDir (REQ) ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: osx] - --repoUrl (REQ) ENV=VPK_REPO_URL Full url to the github + --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 + --token ENV=VPK_TOKEN OAuth token to use as login credentials. - --publish ENV=VPK_PUBLISH Create and publish instead + --publish ENV=VPK_PUBLISH Create and publish instead of leaving as draft. - --pre ENV=VPK_PRE Create as pre-release instead + --pre ENV=VPK_PRE Create as pre-release instead of stable. - --merge ENV=VPK_MERGE Allow merging this upload + --merge ENV=VPK_MERGE Allow merging this upload with an existing release. - --releaseName ENV=VPK_RELEASE_NAME A custom name for the + --releaseName ENV=VPK_RELEASE_NAME A custom name for the release. - --tag ENV=VPK_TAG A custom tag for the release. - --targetCommitish ENV=VPK_TARGET_COMMITISH A commitish value + --tag ENV=VPK_TAG A custom tag for the release. + --targetCommitish ENV=VPK_TARGET_COMMITISH A commitish value for tag (branch or commit SHA). ``` ## `vpk upload gitea -H` ``` Description: - Upload releases to a Gitea repository. + Upload releases to a Gitea repository. Usage: - vpk upload gitea [options] + vpk upload gitea [options] Options: - -o, --outputDir (REQ) ENV=VPK_OUTPUT_DIR Output directory for + -o, --outputDir (REQ) ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: osx] - --repoUrl (REQ) ENV=VPK_REPO_URL Full url to the gitea + --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 + --token ENV=VPK_TOKEN OAuth token to use as login credentials. - --publish ENV=VPK_PUBLISH Create and publish instead + --publish ENV=VPK_PUBLISH Create and publish instead of leaving as draft. - --pre ENV=VPK_PRE Create as pre-release instead + --pre ENV=VPK_PRE Create as pre-release instead of stable. - --merge ENV=VPK_MERGE Allow merging this upload + --merge ENV=VPK_MERGE Allow merging this upload with an existing release. - --releaseName ENV=VPK_RELEASE_NAME A custom name for the + --releaseName ENV=VPK_RELEASE_NAME A custom name for the release. - --tag ENV=VPK_TAG A custom tag for the release. - --targetCommitish ENV=VPK_TARGET_COMMITISH A commitish value + --tag ENV=VPK_TAG A custom tag for the release. + --targetCommitish ENV=VPK_TARGET_COMMITISH A commitish value for tag (branch or commit SHA). ``` ## `vpk upload s3 -H` ``` Description: - Upload releases to a S3 bucket. + Upload releases to a S3 bucket. Usage: - vpk upload s3 [options] + vpk upload s3 [options] Options: - -o, --outputDir (REQ) ENV=VPK_OUTPUT_DIR Output directory for + -o, --outputDir (REQ) ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: osx] - --keyId ENV=VPK_KEY_ID Authentication identifier + --keyId ENV=VPK_KEY_ID Authentication identifier or access key. - --secret ENV=VPK_SECRET Authentication secret key. - --region ENV=VPK_REGION AWS service region (eg. + --secret ENV=VPK_SECRET Authentication secret key. + --region ENV=VPK_REGION AWS service region (eg. us-west-1). - --session ENV=VPK_SESSION Authentication session + --session ENV=VPK_SESSION Authentication session token. - --endpoint ENV=VPK_ENDPOINT Custom service url + --endpoint ENV=VPK_ENDPOINT Custom service url (backblaze, digital ocean, etc). - --bucket (REQ) ENV=VPK_BUCKET Name of the S3 bucket. - --prefix ENV=VPK_PREFIX Prefix to the S3 url. - --keepMaxReleases ENV=VPK_KEEP_MAX_RELEASES The maximum + --bucket (REQ) ENV=VPK_BUCKET Name of the S3 bucket. + --prefix ENV=VPK_PREFIX Prefix to the S3 url. + --keepMaxReleases ENV=VPK_KEEP_MAX_RELEASES The maximum number of releases to keep in the bucket, anything older will be deleted. ``` @@ -392,25 +392,25 @@ Options: ## `vpk upload az -H` ``` Description: - Upload releases to an Azure Blob Storage container. + Upload releases to an Azure Blob Storage container. Usage: - vpk upload az [options] + vpk upload az [options] Options: - -o, --outputDir (REQ) ENV=VPK_OUTPUT_DIR Output directory for + -o, --outputDir (REQ) ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: osx] - --account (REQ) ENV=VPK_ACCOUNT Account name - --key ENV=VPK_KEY Account secret key - --sas ENV=VPK_SAS Shared access signature token + --account (REQ) ENV=VPK_ACCOUNT Account name + --key ENV=VPK_KEY Account secret key + --sas ENV=VPK_SAS Shared access signature token (not the url) - --container (REQ) ENV=VPK_CONTAINER Azure container name - --endpoint ENV=VPK_ENDPOINT Service url (eg. + --container (REQ) ENV=VPK_CONTAINER Azure container name + --endpoint ENV=VPK_ENDPOINT Service url (eg. https://.blob.core.windows.ne t) - --keepMaxReleases ENV=VPK_KEEP_MAX_RELEASES The maximum + --keepMaxReleases ENV=VPK_KEEP_MAX_RELEASES The maximum number of releases to keep in the container, anything older will be deleted. ``` @@ -418,22 +418,22 @@ Options: ## `vpk upload local -H` ``` Description: - Upload releases to a local path or network share. + Upload releases to a local path or network share. Usage: - vpk upload local [options] + vpk upload local [options] Options: - -o, --outputDir (REQ) ENV=VPK_OUTPUT_DIR Output directory for + -o, --outputDir (REQ) ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: osx] - --path (REQ) ENV=VPK_PATH Target file path to copy + --path (REQ) ENV=VPK_PATH Target file path to copy releases to/from. - --keepMaxReleases ENV=VPK_KEEP_MAX_RELEASES The maximum + --keepMaxReleases 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 + --regenerate ENV=VPK_REGENERATE Force regenerate the releases.{channel}.json file in the target directory. ``` @@ -441,48 +441,48 @@ Options: ## `vpk delta -H` ``` Description: - Utilities for creating or applying delta packages. + Utilities for creating or applying delta packages. Usage: - vpk delta [command] [options] + 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. + 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. + Generate a delta patch from two full releases. Usage: - vpk delta generate [options] + vpk delta generate [options] Options: - --mode ENV=VPK_MODE Set the delta generation + --mode ENV=VPK_MODE Set the delta generation mode. [default: BestSpeed] - -b, --base (REQ) ENV=VPK_BASE The base package for the + -b, --base (REQ) ENV=VPK_BASE The base package for the created patch. - -n, --new (REQ) ENV=VPK_NEW The resulting package for + -n, --new (REQ) ENV=VPK_NEW The resulting package for the created patch. - -o, --output (REQ) ENV=VPK_OUTPUT The output file path + -o, --output (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. + Patch a base package and retrieve the original new package. Usage: - vpk delta patch [options] + vpk delta patch [options] Options: - -b, --base (REQ) ENV=VPK_BASE The base package for the + -b, --base (REQ) ENV=VPK_BASE The base package for the created patch. - -p, --patch ENV=VPK_PATCH The resulting package for the + -p, --patch ENV=VPK_PATCH The resulting package for the created patch. - -o, --output (REQ) ENV=VPK_OUTPUT The output file path for the + -o, --output (REQ) ENV=VPK_OUTPUT The output file path for the created patch. ``` diff --git a/docs/reference/cli/content/vpk-windows.mdx b/docs/reference/cli/content/vpk-windows.mdx index f4cd223..fb3cdb2 100644 --- a/docs/reference/cli/content/vpk-windows.mdx +++ b/docs/reference/cli/content/vpk-windows.mdx @@ -4,339 +4,339 @@ ## `vpk -H` ``` Description: - Velopack CLI 0.0.626, for distributing applications. + Velopack CLI 0.0.626, for distributing applications. Usage: - vpk [command] [options] + vpk [command] [options] Options: - -h, -H, --help, --vhelp Show help (-h) or extended help (-H). - -x, --legacyConsole Disable console colors and interactive + -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 + -y, --yes 'yes' by instead of 'no' in non-interactive prompts. - --verbose Print diagnostic messages. - --skip-updates Skip update checks + --verbose Print diagnostic messages. + --skip-updates Skip update checks 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. + 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. + Creates a release from a folder containing application files. Usage: - vpk pack [options] + vpk pack [options] Options: - -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory + -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: win] - -r, --runtime ENV=VPK_RUNTIME The target runtime + -r, --runtime ENV=VPK_RUNTIME The target runtime to build packages for. - -u, --packId (REQ) ENV=VPK_PACK_ID Unique Id for + -u, --packId (REQ) ENV=VPK_PACK_ID Unique Id for application bundle. - -v, --packVersion (REQ) ENV=VPK_PACK_VERSION Current version + -v, --packVersion (REQ) ENV=VPK_PACK_VERSION Current version for application bundle. - -p, --packDir (REQ) ENV=VPK_PACK_DIR Directory + -p, --packDir (REQ) ENV=VPK_PACK_DIR Directory containing application files for release. - --packAuthors ENV=VPK_PACK_AUTHORS Company name or + --packAuthors ENV=VPK_PACK_AUTHORS Company name or comma-delimited list of authors. - --packTitle ENV=VPK_PACK_TITLE Display/friendly + --packTitle ENV=VPK_PACK_TITLE Display/friendly name for application. - --releaseNotes ENV=VPK_RELEASE_NOTES File with + --releaseNotes ENV=VPK_RELEASE_NOTES File with markdown-formatted notes for this version. - --delta ENV=VPK_DELTA Disable or set the + --delta ENV=VPK_DELTA Disable or set the delta generation mode. [default: BestSpeed] - -i, --icon ENV=VPK_ICON Path to icon file for + -i, --icon ENV=VPK_ICON Path to icon file for package. - -e, --mainExe ENV=VPK_MAIN_EXE The file name (not + -e, --mainExe ENV=VPK_MAIN_EXE The file name (not path) of the main/entry executable. - --exclude ENV=VPK_EXCLUDE A regex which + --exclude ENV=VPK_EXCLUDE A regex which excludes matched files from the package. [default: .*\.pdb] - --noPortable ENV=VPK_NO_PORTABLE Skip generating + --noPortable ENV=VPK_NO_PORTABLE Skip generating a portable bundle. - --noInst ENV=VPK_NO_INST Skip generating an + --noInst ENV=VPK_NO_INST Skip generating an installer package. - -f, --framework ENV=VPK_FRAMEWORK List of required + -f, --framework ENV=VPK_FRAMEWORK List of required runtimes to install during setup. Example: 'net6-x64-desktop,vcredist143'. - -s, --splashImage ENV=VPK_SPLASH_IMAGE Path to image + -s, --splashImage ENV=VPK_SPLASH_IMAGE Path to image displayed during installation. - --skipVeloAppCheck ENV=VPK_SKIP_VELO_APP_CHECK Skip the + --skipVeloAppCheck ENV=VPK_SKIP_VELO_APP_CHECK Skip the VelopackApp builder verification. - --signTemplate ENV=VPK_SIGN_TEMPLATE Use a custom + --signTemplate ENV=VPK_SIGN_TEMPLATE Use a custom signing command. {{file}} will be substituted. - --signSkipDll ENV=VPK_SIGN_SKIP_DLL Only signs EXE + --signSkipDll ENV=VPK_SIGN_SKIP_DLL Only signs EXE files, and skips signing DLL files. - --signParallel ENV=VPK_SIGN_PARALLEL The number of + --signParallel ENV=VPK_SIGN_PARALLEL The number of files to sign in each signing command. [default: 10] - --shortcuts ENV=VPK_SHORTCUTS List of locations + --shortcuts ENV=VPK_SHORTCUTS List of locations to install shortcuts to during setup. [default: Desktop,StartMenuRoot] - -n, --signParams ENV=VPK_SIGN_PARAMS Sign files via + -n, --signParams ENV=VPK_SIGN_PARAMS Sign files via signtool.exe using these parameters. ``` ## `vpk download -H` ``` Description: - Download's the latest release from a remote update source. + Download's the latest release from a remote update source. Usage: - vpk download [command] [options] + 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. + 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. + Download latest release from GitHub repository. Usage: - vpk download github [options] + vpk download github [options] Options: - -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created + -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for this + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: win] - --repoUrl (REQ) ENV=VPK_REPO_URL Full url to the github + --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 + --token ENV=VPK_TOKEN OAuth token to use as login credentials. - --pre ENV=VPK_PRE Get latest pre-release instead of + --pre ENV=VPK_PRE Get latest pre-release instead of stable. ``` ## `vpk download gitea -H` ``` Description: - Download latest release from Gitea repository. + Download latest release from Gitea repository. Usage: - vpk download gitea [options] + vpk download gitea [options] Options: - -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created + -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for this + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: win] - --repoUrl (REQ) ENV=VPK_REPO_URL Full url to the gitea + --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 + --token ENV=VPK_TOKEN OAuth token to use as login credentials. - --pre ENV=VPK_PRE Get latest pre-release instead of + --pre ENV=VPK_PRE Get latest pre-release instead of stable. ``` ## `vpk download s3 -H` ``` Description: - Download latest release from an S3 bucket. + Download latest release from an S3 bucket. Usage: - vpk download s3 [options] + vpk download s3 [options] Options: - -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created + -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for this + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: win] - --keyId ENV=VPK_KEY_ID Authentication identifier or + --keyId ENV=VPK_KEY_ID Authentication identifier or access key. - --secret ENV=VPK_SECRET Authentication secret key. - --region ENV=VPK_REGION AWS service region (eg. + --secret ENV=VPK_SECRET Authentication secret key. + --region ENV=VPK_REGION AWS service region (eg. us-west-1). - --session ENV=VPK_SESSION Authentication session token. - --endpoint ENV=VPK_ENDPOINT Custom service url (backblaze, + --session ENV=VPK_SESSION Authentication session token. + --endpoint ENV=VPK_ENDPOINT Custom service url (backblaze, digital ocean, etc). - --bucket (REQ) ENV=VPK_BUCKET Name of the S3 bucket. - --prefix ENV=VPK_PREFIX Prefix to the S3 url. + --bucket (REQ) ENV=VPK_BUCKET Name of the S3 bucket. + --prefix ENV=VPK_PREFIX Prefix to the S3 url. ``` ## `vpk download az -H` ``` Description: - Download latest release from an Azure Blob Storage container. + Download latest release from an Azure Blob Storage container. Usage: - vpk download az [options] + vpk download az [options] Options: - -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for + -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for this + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: win] - --account (REQ) ENV=VPK_ACCOUNT Account name - --key ENV=VPK_KEY Account secret key - --sas ENV=VPK_SAS Shared access signature token + --account (REQ) ENV=VPK_ACCOUNT Account name + --key ENV=VPK_KEY Account secret key + --sas ENV=VPK_SAS Shared access signature token (not the url) - --container (REQ) ENV=VPK_CONTAINER Azure container name - --endpoint ENV=VPK_ENDPOINT Service url (eg. + --container (REQ) ENV=VPK_CONTAINER Azure container name + --endpoint ENV=VPK_ENDPOINT Service url (eg. https://.blob.core.windows.net) ``` ## `vpk download local -H` ``` Description: - Download latest release from a local path or network share. + Download latest release from a local path or network share. Usage: - vpk download local [options] + vpk download local [options] Options: - -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created + -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for this + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: win] - --path (REQ) ENV=VPK_PATH Target file path to copy releases + --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. + Download latest release from a HTTP source. Usage: - vpk download http [options] + vpk download http [options] Options: - -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created + -o, --outputDir ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for this + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: win] - --url (REQ) ENV=VPK_URL Url to download remote releases + --url (REQ) ENV=VPK_URL Url to download remote releases from. ``` ## `vpk upload -H` ``` Description: - Upload local package(s) to a remote update source. + Upload local package(s) to a remote update source. Usage: - vpk upload [command] [options] + 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. + 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. + Upload releases to a GitHub repository. Usage: - vpk upload github [options] + vpk upload github [options] Options: - -o, --outputDir (REQ) ENV=VPK_OUTPUT_DIR Output directory for + -o, --outputDir (REQ) ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: win] - --repoUrl (REQ) ENV=VPK_REPO_URL Full url to the github + --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 + --token ENV=VPK_TOKEN OAuth token to use as login credentials. - --publish ENV=VPK_PUBLISH Create and publish instead + --publish ENV=VPK_PUBLISH Create and publish instead of leaving as draft. - --pre ENV=VPK_PRE Create as pre-release instead + --pre ENV=VPK_PRE Create as pre-release instead of stable. - --merge ENV=VPK_MERGE Allow merging this upload + --merge ENV=VPK_MERGE Allow merging this upload with an existing release. - --releaseName ENV=VPK_RELEASE_NAME A custom name for the + --releaseName ENV=VPK_RELEASE_NAME A custom name for the release. - --tag ENV=VPK_TAG A custom tag for the release. - --targetCommitish ENV=VPK_TARGET_COMMITISH A commitish value + --tag ENV=VPK_TAG A custom tag for the release. + --targetCommitish ENV=VPK_TARGET_COMMITISH A commitish value for tag (branch or commit SHA). ``` ## `vpk upload gitea -H` ``` Description: - Upload releases to a Gitea repository. + Upload releases to a Gitea repository. Usage: - vpk upload gitea [options] + vpk upload gitea [options] Options: - -o, --outputDir (REQ) ENV=VPK_OUTPUT_DIR Output directory for + -o, --outputDir (REQ) ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: win] - --repoUrl (REQ) ENV=VPK_REPO_URL Full url to the gitea + --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 + --token ENV=VPK_TOKEN OAuth token to use as login credentials. - --publish ENV=VPK_PUBLISH Create and publish instead + --publish ENV=VPK_PUBLISH Create and publish instead of leaving as draft. - --pre ENV=VPK_PRE Create as pre-release instead + --pre ENV=VPK_PRE Create as pre-release instead of stable. - --merge ENV=VPK_MERGE Allow merging this upload + --merge ENV=VPK_MERGE Allow merging this upload with an existing release. - --releaseName ENV=VPK_RELEASE_NAME A custom name for the + --releaseName ENV=VPK_RELEASE_NAME A custom name for the release. - --tag ENV=VPK_TAG A custom tag for the release. - --targetCommitish ENV=VPK_TARGET_COMMITISH A commitish value + --tag ENV=VPK_TAG A custom tag for the release. + --targetCommitish ENV=VPK_TARGET_COMMITISH A commitish value for tag (branch or commit SHA). ``` ## `vpk upload s3 -H` ``` Description: - Upload releases to a S3 bucket. + Upload releases to a S3 bucket. Usage: - vpk upload s3 [options] + vpk upload s3 [options] Options: - -o, --outputDir (REQ) ENV=VPK_OUTPUT_DIR Output directory for + -o, --outputDir (REQ) ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: win] - --keyId ENV=VPK_KEY_ID Authentication identifier + --keyId ENV=VPK_KEY_ID Authentication identifier or access key. - --secret ENV=VPK_SECRET Authentication secret key. - --region ENV=VPK_REGION AWS service region (eg. + --secret ENV=VPK_SECRET Authentication secret key. + --region ENV=VPK_REGION AWS service region (eg. us-west-1). - --session ENV=VPK_SESSION Authentication session + --session ENV=VPK_SESSION Authentication session token. - --endpoint ENV=VPK_ENDPOINT Custom service url + --endpoint ENV=VPK_ENDPOINT Custom service url (backblaze, digital ocean, etc). - --bucket (REQ) ENV=VPK_BUCKET Name of the S3 bucket. - --prefix ENV=VPK_PREFIX Prefix to the S3 url. - --keepMaxReleases ENV=VPK_KEEP_MAX_RELEASES The maximum + --bucket (REQ) ENV=VPK_BUCKET Name of the S3 bucket. + --prefix ENV=VPK_PREFIX Prefix to the S3 url. + --keepMaxReleases ENV=VPK_KEEP_MAX_RELEASES The maximum number of releases to keep in the bucket, anything older will be deleted. ``` @@ -344,25 +344,25 @@ Options: ## `vpk upload az -H` ``` Description: - Upload releases to an Azure Blob Storage container. + Upload releases to an Azure Blob Storage container. Usage: - vpk upload az [options] + vpk upload az [options] Options: - -o, --outputDir (REQ) ENV=VPK_OUTPUT_DIR Output directory for + -o, --outputDir (REQ) ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: win] - --account (REQ) ENV=VPK_ACCOUNT Account name - --key ENV=VPK_KEY Account secret key - --sas ENV=VPK_SAS Shared access signature token + --account (REQ) ENV=VPK_ACCOUNT Account name + --key ENV=VPK_KEY Account secret key + --sas ENV=VPK_SAS Shared access signature token (not the url) - --container (REQ) ENV=VPK_CONTAINER Azure container name - --endpoint ENV=VPK_ENDPOINT Service url (eg. + --container (REQ) ENV=VPK_CONTAINER Azure container name + --endpoint ENV=VPK_ENDPOINT Service url (eg. https://.blob.core.windows.ne t) - --keepMaxReleases ENV=VPK_KEEP_MAX_RELEASES The maximum + --keepMaxReleases ENV=VPK_KEEP_MAX_RELEASES The maximum number of releases to keep in the container, anything older will be deleted. ``` @@ -370,22 +370,22 @@ Options: ## `vpk upload local -H` ``` Description: - Upload releases to a local path or network share. + Upload releases to a local path or network share. Usage: - vpk upload local [options] + vpk upload local [options] Options: - -o, --outputDir (REQ) ENV=VPK_OUTPUT_DIR Output directory for + -o, --outputDir (REQ) ENV=VPK_OUTPUT_DIR Output directory for created packages. [default: Releases] - -c, --channel ENV=VPK_CHANNEL The channel to use for + -c, --channel ENV=VPK_CHANNEL The channel to use for this release. [default: win] - --path (REQ) ENV=VPK_PATH Target file path to copy + --path (REQ) ENV=VPK_PATH Target file path to copy releases to/from. - --keepMaxReleases ENV=VPK_KEEP_MAX_RELEASES The maximum + --keepMaxReleases 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 + --regenerate ENV=VPK_REGENERATE Force regenerate the releases.{channel}.json file in the target directory. ``` @@ -393,48 +393,48 @@ Options: ## `vpk delta -H` ``` Description: - Utilities for creating or applying delta packages. + Utilities for creating or applying delta packages. Usage: - vpk delta [command] [options] + 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. + 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. + Generate a delta patch from two full releases. Usage: - vpk delta generate [options] + vpk delta generate [options] Options: - --mode ENV=VPK_MODE Set the delta generation + --mode ENV=VPK_MODE Set the delta generation mode. [default: BestSpeed] - -b, --base (REQ) ENV=VPK_BASE The base package for the + -b, --base (REQ) ENV=VPK_BASE The base package for the created patch. - -n, --new (REQ) ENV=VPK_NEW The resulting package for + -n, --new (REQ) ENV=VPK_NEW The resulting package for the created patch. - -o, --output (REQ) ENV=VPK_OUTPUT The output file path + -o, --output (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. + Patch a base package and retrieve the original new package. Usage: - vpk delta patch [options] + vpk delta patch [options] Options: - -b, --base (REQ) ENV=VPK_BASE The base package for the + -b, --base (REQ) ENV=VPK_BASE The base package for the created patch. - -p, --patch ENV=VPK_PATCH The resulting package for the + -p, --patch ENV=VPK_PATCH The resulting package for the created patch. - -o, --output (REQ) ENV=VPK_OUTPUT The output file path for the + -o, --output (REQ) ENV=VPK_OUTPUT The output file path for the created patch. ```