Client Documentation

Using the Java Client

This project comes with a sample CLI client to interact with the web service. The following is a list of commands to give to the client:

list

Lists all published generator names and descriptions.

view {generator}

View the details of a specific generator. Details include name, description, and properties the user needs to set to use the generator.

publish {generator}

Publish a GitHub repository to the service as a new generator. If a generator already exists with this name, it will be overwritten.

run {generator} {properties...}

Run a generator with the specified parameters/properties, e.g. a file path to be uploaded. While the generator is running, the client will block further commands until the process is complete. The user may cancel generation using the Q key.

Java Client Options

You can also add the following options onto any client command:

-output

The output directory for generated files. Defaults to the directory the client was run from.

-host

A host URL for the client to contact. Defaults to http://localhost:8080/service/.

-pollrate

Change the rate (in milliseconds) the client should poll the service for updates on running generation tasks. Defaults to 500ms.

-unzip

Automatically unzip the files from a completed job. Defaults to false.