Running Joule on CLI
Joule ships with a Command Line Interface (CLI) for running your Joule project. To use the CLI your workflow generally looks like this:
Define your use case using the Joule DSL
Develop custom components within an IDE and test them locally, if required
Define the required data sources and sinks using Joule DSL
Run your use case from the command line
Example
Command line arguments
The CLI has a few command line arguments to run the Joule process.
Required
-s or --source
for data source file-u or --usecase
for stream processing use case file-p or --publish
for event sinks file
Optional
-c or --config
for custom Joule process configuration file-r or --refdata
for reference data sources file
Alternatively
Use the provided scripts within the example projects copy them to your project environment. See use cases running examples documentation.
Start Joule
Start up the Joule process. Joule will use the conf/app.env
configuration as its executing use case.
Start Quote generator
By starting the quote simulator events will be published to Kafka ready for Joule to consume and process
Shutting down processes
To stop the running processes just execute the below under the directory of which you started the processes
Clean up environment
Once you have run the example and viewed the results you can cleanup the environment by running the below script.
Prerequisites
OpenJDK 19+ to run the platform
To develop components read the setting up environment document for detailed requirements.
Within the example repository, we have provided a bash script for additional functionality. Check the README.MD for further information
Last updated