Skip to content

Commit e0fd0ac

Browse files
committed
update cli reference
1 parent 847cdd3 commit e0fd0ac

File tree

1 file changed

+22
-13
lines changed

1 file changed

+22
-13
lines changed

docs/troubleshooting/cli.mdx

+22-13
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,18 @@ Overview of Velopack binary command line options.
44

55
## vpk
66
```txt
7+
> vpk -h
78
Description:
8-
Velopack CLI 0.0.61-g2e7ffeb (prerelease) for creating and distributing releases.
9+
Velopack CLI 0.0.349, for distributing applications.
910
1011
Usage:
1112
vpk [command] [options]
1213
1314
Options:
14-
-?, -h, --help Show help and usage information
15-
--version Show version information
16-
--verbose Print diagnostic messages.
15+
-h, -H, --help, --vhelp Show help (-h) or extended help (-H).
16+
-x, --legacyConsole Disable console colors and interactive components.
17+
-y, --yes 'yes' by instead of 'no' in non-interactive prompts.
18+
--verbose Print diagnostic messages.
1719
1820
Commands:
1921
pack Creates a release from a folder containing application files.
@@ -22,14 +24,16 @@ Commands:
2224
delta Utilities for creating or applying delta packages.
2325
```
2426

25-
## Update.exe & UpdateMac
27+
## Update.exe, UpdateMac, and UpdateNix
2628
```txt
27-
Velopack Updater (0.0.66) manages packages and installs updates.
29+
> Update.exe -h
30+
Velopack Updater (0.0.398-g3777828) manages packages and installs updates.
2831
https://github.com/velopack/velopack
2932
3033
Usage: update [OPTIONS]
3134
update apply [OPTIONS] [-- [EXE_ARGS]...]
3235
update patch [OPTIONS] --old <FILE> --patch <FILE> --output <FILE>
36+
update get-version [OPTIONS]
3337
update start [OPTIONS] [EXE_NAME] [-- [EXE_ARGS]...]
3438
update uninstall [OPTIONS]
3539
@@ -44,8 +48,8 @@ update apply:
4448
Applies a staged / prepared update, installing prerequisite runtimes if necessary
4549
-r, --restart Restart the application after the update
4650
-w, --wait Wait for the parent process to terminate before applying the update
51+
--waitPid <PID> Wait for the specified process to terminate before applying the update
4752
-p, --package <FILE> Update package to apply
48-
--noelevate If the application does not have sufficient privileges, do not elevate to admin
4953
-h, --help Print help
5054
[EXE_ARGS]... Arguments to pass to the started executable. Must be preceeded by '--'.
5155
@@ -56,23 +60,28 @@ Applies a Zstd patch file
5660
--output <FILE> The file to create with the patch applied
5761
-h, --help Print help
5862
63+
update get-version:
64+
Prints the current version of the application
65+
-h, --help Print help
66+
5967
update start:
6068
Starts the currently installed version of the application
61-
-w, --wait Wait for the parent process to terminate before starting the application
62-
-h, --help Print help
63-
[EXE_ARGS]... Arguments to pass to the started executable. Must be preceeded by '--'.
64-
[EXE_NAME] The optional name of the binary to execute
69+
-w, --wait Wait for the parent process to terminate before starting the application
70+
--waitPid <PID> Wait for the specified process to terminate before applying the update
71+
-h, --help Print help
72+
[EXE_ARGS]... Arguments to pass to the started executable. Must be preceeded by '--'.
73+
[EXE_NAME] The optional name of the binary to execute
6574
6675
update uninstall:
6776
Remove all app shortcuts, files, and registry entries.
6877
-h, --help Print help
6978
```
7079

71-
7280
## Setup.exe
7381

7482
```txt
75-
Velopack Setup (0.0.66) installs applications.
83+
> Setup.exe -h
84+
Velopack Setup (0.0.398-g3777828) installs applications.
7685
https://github.com/velopack/velopack
7786
7887
Usage: setup [OPTIONS]

0 commit comments

Comments
 (0)