3.2 Using the command line

Before following this guide, please refer to the Windows or Linux pages and take note of a few edge cases that only concern the respective operating system. In general however, the command line guide is applicable to both.

The quick start guide explains how to set up and run an environment. This section covers some common work flows. For detailed explanations of the tasks used here, please refre to the tasks section of the wiki.

Commands summary

These are some console commands that are useful when working with the jazz development environment. Other tools that are used frequently are text editors to edit the configuration files and file explorers to navigate the user folders and to copy SDK and JTS files.

• ./gradlew gradle wrapper executable, used for running gradle tasks. This command always needs to be run from the base directory of the jazz development environment
• cd change directory, used to navigate to directories on the command line
• ls list directory contents
• Ctrl + C key combination for stopping a running task. Useful for stopping the server, but also when a gradle task gets stuck

Running powershell

The easiest way to run powershell in the correct folder is to navigate to the base folder of the jazz development environment using the file explorer, and then writing powershell in the address bar. This stackoverflow post breaks this procedure down in detail. For people not used to the command line, this eliminates having to navigate using cd.

Running the environment

This is probably the most commonly used functionality. As covered in the quick start guide, the latest available environment can be run using

./gradlew run

If you have multiple run times configured (covered in the setup task description), you can pass the appropriate run time parameter to start a run time of your choice

./gradlew run -Pruntime=6.0.3

Setting up a run time

Detailed setup instructions are in the setup task section. The latest run time can be configured using

./gradle setup

and a specific run time using

./gradle setup --sdk=6.0.3

Printing information

To get an overview of the currently configured development environment, you can use

./gradlew info

which prints information about your setup. For details on the information shown, please refer to the info task description. This task is especially useful for checking if your custom configurations worked.