Vortex CLI
Project description
Vortex CLI
Vortex CLI is a command line alternative to the Puakma Vortex IDE that simplifies the process of developing Puakma Applications on a Puakma Tornado Server using 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 Extensions
While it is possible to use without it, this software has been purposefully designed for use with Visual Studio Code and the Project Manager For Java or the Extension Pack For Java extension. This software leverages Workspaces in Visual Studio Code and manages a vortex.code-workspace
file within the workspace.
Installation
-
Install the tool using pip.
pip install vortex-cli
-
It is recommended to set the workspace you would like to work out of via the
VORTEX_WORKSPACE
environment variable.On Unix:
export VORTEX_WORKSPACE=/path/to/workspace
Otherwise, Vortex CLI will use a default 'vortex-cli-workspace' directory inside your home directory.
-
Create a vortex-server-config.ini file in your workspace to define the server(s) you will be working with.
To create the config file and also your workspace directory (if they don't already exist) you can use the config command:
vortex config --init
Then run the config command without flags to conviniently check your workspace and server configuration:
vortex config
Further, you can print a sample config definition using the '--sample' flag:
vortex config --sample
In the vortex-server-config.ini file, 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 specified when using the --server flag i.e. 'vortex --server server1 list' host = example.com port = 8080 ; we can overwrite the DEFAULT value puakma_db_conn_id = 13 username = myuser ; Optional password = mypassword ; Optional
-
Setup the Visual Studio Code Workspace to 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" } ]
Usage
List Puakma Applications
To list the Puakma Applications available on the server, use the list
command:
vortex list
This will display a table showing the ID, name, template, and inheritance of each Puakma Application.
Clone a Puakma Application
To clone a Puakma Application to the local workspace, use the clone
command:
vortex clone [<APP_ID>, ...]
Replace <APP_ID>
with the ID(s) of the Puakma Application(s) you want to clone. The tool will clone the application(s) into the local workspace.
Open the workspace in Visual Studio Code
To open the Vortex CLI workspace in Visual Studio Code, use the code
command:
vortex code
Watch the workspace for changes
To watch the workspace containing cloned Puakma Applications and automatically upload changes to the server, use the watch
command:
vortex watch
This will start watching the workspace for changes. As you make changes to the files in the directory, the tool will automatically upload the changes to the server.
Delete locally cloned Puakma Applications
To delete the locally cloned Puakma Application directories in the workspace, use the clean
command:
vortex clean
Create Design Objects
To create new design objects, use the new
command:
vortex new [NAME, ...] --app-id <app_id> --type <design_type>
Specify more than one name to create multiple design objects of the same type for the specified application
Delete Design Objects
To delete a design object, use the delete
command:
vortex delete [DESIGN_OBJECT_ID, ...]
Find cloned Design Objects
To search for Design Objects by name use the find
command:
vortex find <name> [options]
Search the contents of cloned Design Objects
To search for text patterns in Design Objects using a Regular Expression use the grep
command:
vortex grep <pattern> [options]
Copy Design Objects from one application to another
To copy Design Objects from one application to another (You can specify many --app-ids to copy to multiple applications) use the copy
command:
vortex copy DESIGN_OBJECT_ID --app-id [APP_ID ...]
View the server logs
To view the last n log items in the server log use the log
command:
vortex log [-n LIMIT]
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for vortex_cli-3.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bbdabd166bc553c964e61a5edf09f1225aef7591544572a9c600d0b79f91ad32 |
|
MD5 | db67093f6dd59df21fcaa8302a8a33a9 |
|
BLAKE2b-256 | 45e9561a57ec333154ed3586f5e00b2d033b469c5bb4ea44451e49b33f559794 |