Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
..
Failed to load latest commit information.
src
.gitignore
LICENSE-2.0.txt
README.md
cli.iml
pom.xml
werminal.sh

README.md

Werminal

Werminal is a terminal (command line) application for WRML model browsing and editing.

Werminal can be used to create new models of any type such as: Schemas, Teams, Players, Aliens, HomeScreens, Movies; whatever your application calls for.

Werminal also enables you to open, edit, and save data (of any data type).

Running Werminal

Note that all the following examples are dependent on the wrml-cli.jar file. This file can be built from maven in the cli project:

Default

To run Werminal with the default options, execute the wrml-cli.jar using the java -jar command:

java -jar cli/target/wrml-cli.jar

This assumes that you have a WRML configuration file named wrml.json in either the current working directory or your user directory.

Specify -config command line argument

To run Werminal with a specified configuration file path using the -config program argument:

java -jar cli/target/wrml-cli.jar org.wrml.werminal.Werminal -config my/path/to/wrml.json

or to specify the UNIX terminal mode:

java -jar cli/target/wrml-cli.jar org.wrml.werminal.Werminal -config my/path/to/wrml.json -unix

Specify wrmlConfiguration JVM argument

To run Werminal with a specific configuration file path using the -DwrmlConfiguration JVM argument:

java -DwrmlConfiguration=my/path/to/wrml.json -jar cli/target/wrml-cli.jar

or to manually specify the CLI's main class:

java -DwrmlConfiguration=my/path/to/wrml.json -jar cli/target/wrml-cli.jar org.wrml.werminal.Werminal

or to specify the UNIX terminal mode:

java -DwrmlConfiguration=my/path/to/wrml.json -jar cli/target/wrml-cli.jar org.wrml.werminal.Werminal -unix

Via Eclipse .launch Configuration

  1. In 'Run Configurations', choose 'New Java Application'.
  2. On the 'Main' tab, enter:
    1. Project: "cli"
    2. Main class: "org.wrml.werminal.Werminal"
    3. Check "Stop in main"
  3. [Optional] On the 'Arguments' tab, either the -config or -DwrmlConfiguration options described above.

References

For more about the Werminal app, please consult the "Werminal Masters Handbook": https://github.com/wrml/wrml/blob/master/doc/WRML_WerminalMastersHandbook.pdf