Command Line Tools

publishtool

Introduction

The publishtool is a command-line application that provides the ability to publish your KAB artifacts.

Details

The following shows the program’s "help" output:

usage: publishtool [OPTIONS...]

This is the KOS KAB file publisher.

-> General command format:
   publishtool [-options] [kabfile]
      and   'options'   provides the necessary artifact information
      and   'kabfile'   full path and file name of the KAB file to publish

-> Publish a KAB file:
   $ publishtool -r repo_name -l repo_location \
                 -n artifact_name -v artifact_version \
                 -q artifact_qualifier \
                [-d artifact_description] \
                [-a api_key] [-i is_immutable] [-m] \
                 myfile.kab

Options:

 -a,--api-key <apikey>           optional KOS Studio API key to be used to publish to the server
                                 (defaults to the "apikey" property in
                                 "~/kosStudio/tools.properties" and
                                 falls back to the current authentication of the Studio client)
 -d,--description <desc>         optional description of the kab being published
 -h,--help                       show this help page
 -i,--immutable                  optional flag that indicates that the published instance record
                                 can never be replaced (typically snapshots or development instances
                                 are not immutable while production instances are immutable)
 -l,--repo-location <location>   the location of the kab inside the given repository
                                 (maven locations use the following format:
                                 "mvn:group:artifact:version")
 -m,--marketplace                indicates that this instance should be published to the KOS
                                 marketplace which makes the instance available to other
                                 organizations
                                 (market artifacts can only be created in coordination with the KOS
                                 team)
 -n,--artifact-name <name>       the name of the artifact the published kab is an instance of
                                 (the artifact must already be created using Studio)
    --prop-file <arg>            Use a file other than ~/kosStudio/tools.properties to lookup
                                 defaults
 -q,--qualifier <qualifer>       comma separated list of qualifiers for the published kab
                                 used to distinguish multiple instances of an artifact that
                                 have the same type and version but differ by some other
                                 property such as cpu architecture or board type
                                 use "any" if the artifact can be used on any platform
 -r,--repo-name <reponame>       the name of the repository that holds the actual KAB file
                                 (the repo must already be created using Studio)
 -v,--version <version>          the version of the instance being published
                                 (defaults to the version in the kab header)

publishtool v23.02.27
(C) Copyright 2023 TCCC. All rights reserved.
Previous
Next
On this page
Java Development
Seamlessly transition from Legacy+ systems to Freestyle microdosing and advanced distributed dispense systems.
UI Development
Using KOS SDKs, integrating Consumer and Non-consumer facing UIs becomes seamless, giving you less hassle and more time to create.
Video Library
Meet some of our development team, as they lead you through the tools, features, and tips and tricks of various KOS tools.
Resources
Familiarize yourself with KOS terminology, our reference materials, and explore additional resources that complement your KOS journey.
Copyright © 2024 TCCC. All rights reserved.