fj-tool-helper

Simple project with utilities for stand alone tool.

Quickstart

build :

mvn clean install -P singlepackage

run :

Example : java -jar target/dist-fj-tool-helper-*.jar \
 --tool-help-config-path src/main/resources/tool/tool-help-config.xml \
 --output-file target/help.md \
 --output-format md  

parameter help

name	required	default	description	since	info
tool-help-config-path	true	none	Path to tool-help-config xml file.	0.1.0	By default the path will be looked on file system, to search in classpath prefix with cl://
output-file	true	none	Path to the the file to create.	0.1.0	Must be a physical file
output-format	true	none	Output format, currently accepted formats are md (markdown), html, pdf, txt.	0.1.0	The output will be generated via Venus Fugerit document generation framework (https://github.com/fugerit-org/fj-doc).
exclude-info	false	false	If set to true, the 'info' columns of tool parameters will be ignored.	0.1.0	The output will be generated via Venus Fugerit document generation framework (https://github.com/fugerit-org/fj-doc).
help	false	none	Print help about the tool.	0.1.0	In case of errors the help will be printed too.