Skip to main content
Kinetic Community

JAR Commands

IDF guide rendered from cache
The first part of this article provides some information about general usage of the KURL jar.  The second part of this article is a table of contents that lists the commands provided by the KURL jar with a link to each one.

JAR Usage

The kurl.jar is executed using the java -jar command as shown below.  It also takes an action argument that specifies the action KURL will execute.

java -jar kurl.jar -action=(action name) (other arguments....)

General Arguments

action Specifies the action to be executed by KURL.  Below is a list of commands with links to their articles and overviews of each command.
config Specifies the YAML configuration file that will be used to connect.  Defaults to a file named config.yml in the current directory.
environment Specifies which environment in the YAML configuration to use.  Defaults to kurl.
log_level Specifies the logging level for the execution.  Defaults to off.  If a logging level is specified a log file will be created in the current directory named kurl.log.



The setup command is used to automatically generate the YAML configuration file.  It will prompt for the necessary values and create a file named config.yml in the current directory.

java -jar kurl.jar -setup


The help command prints the jar file help text, which contains details about the commands and arguments.

java -jar kurl.jar -help


The version command prints the version number of the kurl.jar.

java -jar kurl.jar -version