Documentation: Flowy Util
Flowy Util
Flowy Util is a Command-Line-based tool which supports the following modes of operation:
- export or import objects
- encrypt or decrypt files
Export or import Flowy objects
The CLI tool provides a simple and efficient way to export or import objects using the following syntax:
$ java -jar flowy-cli.jar
--flowy.show-error-stacktrace=true
--flowy.username=admin@getflowy.io
--flowy.password=admin
--flowy.command=EXPORT_MODULE|IMPORT_MODULE|EXPORT_RESOURCE|INSERT_IMPORT_RESOURCE|UPDATE_IMPORT_RESOURCE
--flowy.base-url=http://localhost:8080/api
--flowy.resource-path=/module
--flowy.resource-name=module_test
--flowy.file=module.json
--flowy.overrides=status=ACTIVE,name=newModuleName
Encrypt or decrypt files
In order to validate or restore encrypted files, the following syntax shall be used:
$ java -jar flowy-cli.jar
--flowy.show-error-stacktrace=true
--flowy.command=ENCRYPT|DECRYPT
--flowy.security.password=pass
--flowy.security.input-file=input.txt
--flowy.security.output-file=output.txt
Export or import libraries
$ java -jar flowy-cli.jar
--flowy.username=admin@getflowy.io
--flowy.password=admin
--flowy.command=EXPORT_RESOURCE
--flowy.base-url=http://localhost:8080/api
--flowy.resource-path=/library
--flowy.resource-name=libraryName
--flowy.file=library.json
$ java -jar flowy-cli.jar
--flowy.username=admin@getflowy.io
--flowy.password=admin
--flowy.command=INSERT_IMPORT_RESOURCE
--flowy.base-url=http://localhost:8080/api
--flowy.resource-path=/library
--flowy.resource-name=libraryName
--flowy.file=library.json
Update frontend setting
$ java -jar flowy-cli.jar
--flowy.username=admin@getflowy.io
--flowy.password=admin
--flowy.command=UPDATE_FRONTEND_SETTING
--flowy.base-url=http://localhost:8080/api
--flowy.frontend-setting-path=/global-setting/frontend