ProtoData is a collection of tools for generating quality domain models from Protobuf definitions.
The project is under development right now. Proceed with caution.
To install ProtoData on a *nix system:
-
Download the
executable-<version>.jar
archive. -
Unzip the archive:
unzip -d ./target/dir path/to/protodata.jar
- Run the installer script:
./target/dir/install.sh
By default, the tool is installed into $HOME/Library/
dir. To change the installation dir,
pass it as a parameter to the install.sh
script:
./target/dir/install.sh $HOME/custom/installation/dir
In any case, the directory must exist. Otherwise, install.sh
will exit with an error.
- If you use either
bash
orzsh
shell, you will be asked to run asource
command to update thePATH
environmental variable. If you use another shell, you will have to update thePATH
variable manually.
Now ProtoData CLI should be accessible. To check the correctness of th installation, run:
protodata -h
There is currently no installation script for Windows.
Start using the app:
-
download and extract the
executable-<version>.jar
archive. -
To launch the app, launch the
bin/protodata.bat
script.
Note that it is necessary to keep the structure of the archive intact: the scripts in bin
rely
on the relative path to other files in the archive.