Basic Commands

make-version

Upload new version of application. Can import files from another on application, publish version and give it a label, changelog. Basic form of this command require apiKey, secret, path to files folder and label.

Syntax

patchkit-tools make-version -s <secret> -a <api_key> -l <label> (-f <files> | --import-app-secret <secret> --import-version <version>) [-p <true|false> (-c <changelog> | -z <changelog_file>) -x --import-copy-label --import-copy-changelog]


Parameters

Mandatory  
-s,   --secret <secret> application secret
-a,   --api-key <api_key> user API key
-l,   --label <label> version label
Provide either -f or --import* parameters
-f,   --files <files> path to version files directory
--import-app-secret <secret> secret of source application from which we want import files
--import-version <version> id of source application version from which we want import files
Optional  
-p,   --publish <true | false> (default: false) should version be published after upload
-c,   --changelog <changelog> version changelog
-z   <changelog_file>, --changelog-file text file with version changelog
-x,   --overwrite-draft should draft version be overwritten if it already exists (default: false)
--import-copy-label copy label from source version
–import-copy-changelog copy changelog from source version
Common  
--host  <host> Hostname (format: patchkit.net)
-h,   --help outputs a usage message and exit
Dependency
<version> - Id of a version from you want to import files is displayed in list-versions tool or on your app versions page in a row No.


Examples

Make version without asking about overwrite draft, upload files directory and changelog file. Automatic publish.

patchkit-tools.bat make-version -s aa11bb22cc33dd55ee66ff77gg88hh99 -a zz99yy88xx77ww66vv55uu44tt33ss22rr11 -l "My new app version" -f My_app_directory/ -z My_app_changelog.txt -x


Make version by import from version id 6 in other app and copy label and changelog.

patchkit-tools.bat make-version -s aa11bb22cc33dd55ee66ff77gg88hh99 -a zz99yy88xx77ww66vv55uu44tt33ss22rr11 --import-app-secret ii11jj22kk33l44mm55nn66oo77pp88qq99 --import-version 6 --import-copy-label --import-copy-changelog


Make version by import from version id 6 in other app without asking about overwrite draft and upload changelog file. Automatic publish.

patchkit-tools.bat make-version -s aa11bb22cc33dd55ee66ff77gg88hh99 -a zz99yy88xx77ww66vv55uu44tt33ss22rr11 --import-app-secret ii11jj22kk33l44mm55nn66oo77pp88qq99 --import-version 6  -z My_app_changelog.txt -x

channel-make-version

Creates a new channel version.

Syntax

patchkit-tools channel-make-version -s <secret> -a <api_key> -l <label>


Parameters

Mandatory  
-a,   --api-key <api_key> user API key
-s,   --secret <secret> application secret
-l,   --label <label> version label
Optional  
-c,   --changelog <changelog> version changelog
-z   <changelog_file>, --changelog-file text file with version changelog
--group-version   group version id
-x,   --overwrite-draft overwrites existing draft
-p,   --publish publish after finished
Common  
--host  <host> Hostname (format: patchkit.net)
--https  <true | false> Use HTTPS (false)
-h,   --help outputs a usage message and exit

list-versions

Display list of version in selected secret application. It need it in other tools like a “upload-version”, “publish-version”, “update-version”, “make-version” when you need id version with you want manipulate.

Syntax

patchkit-tools.bat list-versions -s <secret> [-a <api_key> -l <display_limit> -m <sort_mode> -f <format>]


Parameters

Mandatory  
-s,   --secret <secret> application secret
Optional  
-a,   --api-key <api_key> user API key
-l,   <display_limit>, --display-limit limit of displayed versions; -1 = infinite (default: -1)
-m,   --sort-mode <sort_mode> sort mode; desc, asc (default: desc)
-f,   --format <format> output formtat (default: yaml)
Common  
--host  <host> Hostname (format: patchkit.net)
-h,   --help outputs a usage message and exit


Examples

List all versions (include draft)

patchkit-tools.bat list-versions -s aa11bb22cc33dd55ee66ff77gg88hh99 -a zz99yy88xx77ww66vv55uu44tt33ss22rr11


List 4 first versions asc ordered in JSON format without draft.

patchkit-tools.bat list-versions -s aa11bb22cc33dd55ee66ff77gg88hh99 -l 4 -m asc -f json

Advanced Commands

Link application version to existing channel.

Syntax

patchkit-tools.bat channel-link-version -s <secret> -a <api_key> -v <version> --group-secret <secret> -g <version>


Parameters

Mandatory  
-s,   --secret <secret> application secret
-a,   --api-key <api_key> user API key
-v,   --version <api_key> application version id
--group-secret <secret> group secret
-g,   --group-version <version> group version id
Common  
--host  <host> Hostname (format: patchkit.net)
-h,   --help outputs a usage message and exit
Dependency
<version> - Id of a version from you want to import files is displayed in list-versions tool or on your app versions page in a row No.


Examples

Link persisted version id 8 into channel version id 4

patchkit-tools.bat channel-link-version -s aa11bb22cc33dd55ee66ff77gg88hh99 -a zz99yy88xx77ww66vv55uu44tt33ss22rr11 -v 4 --group-secret ii11jj22kk33l44mm55nn66oo77pp88qq99 -g 8

create-version

Create new version of PatchKit application but not upload any files.

Syntax

patchkit-tools.bat create-version -s <secret> -a <api_key> -l <label> [-c <changelog>]


Parameters

Mandatory  
-s,   --secret <secret> application secret
-a,   --api-key <api_key> user API key
-l,   --label <label> version label
Optional  
-c,   --changelog <changelog> version changelog
Common  
--host  <host> Hostname (format: patchkit.net)
-h,   --help outputs a usage message and exit


Examples

Create version with changelog

patchkit-tools.bat create-version -s aa11bb22cc33dd55ee66ff77gg88hh99 -a zz99yy88xx77ww66vv55uu44tt33ss22rr11 -l "New version of my cool app" -c "All of this change is awesome"

publish-version

Publish uploaded version of your application but not published.

Syntax

patchkit-tools.bat publish-version -s <secret> -a <api_key> (-v <version> | -d ) [-w]


Parameters

Mandatory  
-s,   --secret <secret> application secret
-a,   --api-key <api_key> user API key
-v,   --version <version> version to publish
Optional  
-d,   --draft publishes current draft version (overrides --version) (default: false)
-w,   --wait waits until version is published (default: false)
Common  
--host  <host> Hostname (format: patchkit.net)
-h,   --help outputs a usage message and exit
Dependency
<version> - Id of a version from you want to import files is displayed in list-versions tool or on your app versions page in a row No.


Examples

Publish current draft id 5 (id showed by list-versions tools) and tools will be wait until publish

patchkit-tools.bat publish-version -s aa11bb22cc33dd55ee66ff77gg88hh99 -a zz99yy88xx77ww66vv55uu44tt33ss22rr11 -v 5 -w

Publish current draft (without type id)

patchkit-tools.bat publish-version -s aa11bb22cc33dd55ee66ff77gg88hh99 -a zz99yy88xx77ww66vv55uu44tt33ss22rr11 -d

update-version

Edit label or changelog. Support uploading changlelog from txt file.

Syntax

patchkit-tools.bat update-version -s <secret> -a <api_key> -v <version> [-l <label> (-c <changelog> | -z <changelog_file>)]


Parameters

Mandatory  
-s,   --secret <secret> application secret
-a,   --api-key <api_key> user API key
-v,   --version <version> application version
Provide either -f or --import* parameters
-l,   --label <label> version label
-c,   --changelog <changelog> version changelog
-z,   --changelog_file <changelog_file> text file with version changelog
Common  
--host  <host> Hostname (format: patchkit.net)
-h,   --help outputs a usage message and exit
Dependency
<version> - Id of a version from you want to import files is displayed in list-versions tool or on your app versions page in a row No.


Examples

Update version by upload new changelog file in draft id 5.

patchkit-tools.bat update-version -s aa11bb22cc33dd55ee66ff77gg88hh99 -a zz99yy88xx77ww66vv55uu44tt33ss22rr11 -v 5 -z my_new_pretty_changelog.txt

Update version by type new label and changelog in version id 12.

patchkit-tools.bat update-version -s aa11bb22cc33dd55ee66ff77gg88hh99 -a zz99yy88xx77ww66vv55uu44tt33ss22rr11 -v 12 -l "My new label" -c "My new changelog"

Examples

How to send?

a new version? (tools will ask you about publishing)

patchkit-tools make-version -s bc5e377068cb296d8540c1e6994498bc -a 4238042c19010adb4b0931183083b32b -f folder -l "Label" -c “Feature 1, Feature 2”

a new version without publishing?

patchkit-tools.bat make-version -s bc5e377068cb296d8540c1e6994498bc -a 4238042c19010adb4b0931183083b32b -f folder -l "Label" -c “Feature 1, Feature 2” -p false

a new version with changelog attached in txt file?

patchkit-tools.bat make-version -s bc5e377068cb296d8540c1e6994498bc -a 4238042c19010adb4b0931183083b32b -f folder -l "Label" -z changelog.txt

a new version with draft overriding?

patchkit-tools.bat make-version -s bc5e377068cb296d8540c1e6994498bc -a 4238042c19010adb4b0931183083b32b -f folder -l "Label" -c “Feature 1, Feature 2” -x true


How to display?

versions of existing apps?

patchkit-tools.bat list-versions -s bc5e377068cb296d8540c1e6994498bc -a 4238042c19010adb4b0931183083b32b

versions of existing apps with sort?

patchkit-tools.bat list-versions -s bc5e377068cb296d8540c1e6994498bc -a 4238042c19010adb4b0931183083b32b -m asc

versions of existing apps with limit?

patchkit-tools.bat list-versions -s bc5e377068cb296d8540c1e6994498bc -a 4238042c19010adb4b0931183083b32b -l 2

versions of existing apps with format?

patchkit-tools.bat list-versions -s bc5e377068cb296d8540c1e6994498bc -a 4238042c19010adb4b0931183083b32b -f json


How to publish?

a sent version?

patchkit-tools.bat publish-version -s bc5e377068cb296d8540c1e6994498bc -a 4238042c19010adb4b0931183083b32b -v 10

a version with feedback?

patchkit-tools.bat publish-version -s bc5e377068cb296d8540c1e6994498bc -a 4238042c19010adb4b0931183083b32b -v 10 -w


How to update?

a label?

patchkit-tools.bat update-version -s bc5e377068cb296d8540c1e6994498bc -a 4238042c19010adb4b0931183083b32b -v 1 -l "version1 edited"

a changelog?

patchkit-tools.bat update-version -s bc5e377068cb296d8540c1e6994498bc -a 4238042c19010adb4b0931183083b32b -v 1 -c changelog edited"

a changelog attached in txt file?

patchkit-tools.bat update-version -s bc5e377068cb296d8540c1e6994498bc -a 4238042c19010adb4b0931183083b32b -v 1 -z changelog.txt


How to create?

a new version without file sending?

patchkit-tools.bat create-version -s bc5e377068cb296d8540c1e6994498bc -a 4238042c19010adb4b0931183083b32b -l "Label" -c “Feature 1, Feature 2”

Copyright © 2015 - 2019 Upsoft
All Rights Reserved.