Package: vortex-cli
Vortex CLIVortex CLI is a command line alternative to thePuakma Vortex IDEthat simplifies the process of developing Puakma Applications on aPuakma Tornado Serverusing Visual Studio Code. It allows you to clone applications from the server to a local workspace, edit the files using Visual Studio Code, and automatically upload changes to the server as you work.Vortex CLI also comes pre-packaged with the necessary Puakma .jar files for development.Visual Studio Code and ExtensionsWhile it is possible to use without it, this software has been purposefully designed for use withVisual Studio Codeand theProject Manager For Javaor theExtension Pack For Javaextension. This software leveragesWorkspacesin Visual Studio Code and manages avortex.code-workspacefile within the workspace.InstallationInstall the tool using pip.pip install vortex-cliIt is recommended to set the workspace you would like to work out of via theVORTEX_HOMEenvironment variable.On Unix:export VORTEX_HOME=/path/to/workspaceOtherwise, Vortex CLI will use a default'vortex-cli-workspace'directory inside your home directory.Run vortex with the--initflag to create your workspace (If it doesn't already exist) and the necessary config files:vortex --initDefine the servers you will be working with in theservers.inifile inside the.configdirectory within your workspace. You can quickly access this using thecodecommand to view your workspace in VSCode.vortex codeIn theservers.inifile, you can define as many servers as you need, each with their own unique name. For example:[DEFAULT] ; This section is optional and only useful if you have multiple definitions
port = 80 ; Options provided under DEFAULT will be applied to all definitions if not provided
soap_path = system/SOAPDesigner.pma
default = server1 ; Useful when you have multiple definitions

[server1] ; This can be called whatever you want and can be referenced using the '--server' flag
host = example.com
port = 8080 ; we can overwrite the DEFAULT value
puakma_db_conn_id = 13
username = myuser ; Optional - Prompted at runtime if not provided
password = mypassword ; Optional - Prompted at runtime if not providedSetup theVisual Studio Code Workspaceto use the same Java version as your server in /path/to/workspace/.vscode/vortex.code-workspace under "settings", for example:"java.configuration.runtimes": [
   {
      "default": true,
      "name": "JavaSE-1.8",
      "path": "/Library/Java/JavaVirtualMachines/temurin-8.jdk/Contents/Home"
   }
]UsageFor a full list of commands see--help.Command Overviewcode: Open the workspace in Visual Studio Code.list(orls): List Puakma Applications on the server or cloned locally. (lsis an alias forvortex list --local)clone: Clone Puakma Applications and their design objects into the workspace or in the .pmx format.watch: Watch the workspace for changes to Design Objects and automatically upload them to the server.clean: Delete the locally cloned Puakma Application directories in the workspace.config: View and manage configuration.log: View the server log.find: Find Design Objects of cloned applications by name.grep: Search the contents of cloned Design Objects using a Regular Expression.new: Create new Design Objects, Applications, or Keywords. Use --update  to update instead.copy: Copy a Design Object from one application to another.delete: Delete Design Objects by ID.db: Interact with Database Connections.docs: Open the Tornado Server Blackbook.execute: Execute a command on the server.