# Vortex CLI
[](https://dev.azure.com/amostj/vortex-cli/_build/latest?definitionId=11&branchName=main) [](https://badge.fury.io/py/vortex-cli)
Vortex CLI is a command line alternative to the [Puakma Vortex IDE](https://github.com/brendonupson/PuakmaVortex) that simplifies the process of developing Puakma Applications on a [Puakma Tornado Server](https://github.com/brendonupson/Puakma) 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](https://github.com/microsoft/vscode) and the [Project Manager For Java](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-dependency) or the [Extension Pack For Java](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-pack) extension. This software leverages [Workspaces](https://code.visualstudio.com/docs/editor/workspaces) in Visual Studio Code and manages a `vortex.code-workspace` file within the workspace.
## Installation
1. Install the tool using pip.
```
pip install vortex-cli
```
2. It is recommended to set the workspace you would like to work out of via the `VORTEX_HOME` environment variable.
On Unix:
```
export VORTEX_HOME=/path/to/workspace
```
Otherwise, Vortex CLI will use a default **'vortex-cli-workspace'** directory inside your home directory.
3. Run vortex with the `--init` flag to create your workspace (If it doesn't already exist) and the necessary config files:
```
vortex --init
```
4. Define the servers you will be working with in the `servers.ini` file inside the `.config` directory within your workspace. You can quickly access this using the `code` command to view your workspace in VSCode.
```
vortex code
```
In the `servers.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 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 provided
lib_path = ; additional jars that should be included in the classpath
java_home = /usr/lib/jvm/java-17-openjdk-amd64/ ; The local path to the JRE to use. Should be the same version running on your server
java_environment_name = JavaSE-17 ; Java Execution Environment name https://docs.osgi.org/reference/eenames.html
```
## Usage
For a full list of commands see `--help`.
### Command Overview
- `code`: Open the workspace in Visual Studio Code.
- `list` (or `ls`): List Puakma Applications on the server or cloned locally. (`ls` is an alias for `vortex 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 <ID> 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/jordanamos/vortex-cli",
"name": "vortex-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "vortex cli",
"author": "Jordan Amos",
"author_email": "jordan.amos@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/80/68/c3beb0766c0e80132281d4c0fb776395dda15d8acb8d7b557676a601d309/vortex_cli-4.12.1.tar.gz",
"platform": null,
"description": "# Vortex CLI\n\n[](https://dev.azure.com/amostj/vortex-cli/_build/latest?definitionId=11&branchName=main) [](https://badge.fury.io/py/vortex-cli)\n\nVortex CLI is a command line alternative to the [Puakma Vortex IDE](https://github.com/brendonupson/PuakmaVortex) that simplifies the process of developing Puakma Applications on a [Puakma Tornado Server](https://github.com/brendonupson/Puakma) 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.\n\nVortex CLI also comes pre-packaged with the necessary Puakma .jar files for development.\n\n#### Visual Studio Code and Extensions\n\nWhile it is possible to use without it, this software has been purposefully designed for use with [Visual Studio Code](https://github.com/microsoft/vscode) and the [Project Manager For Java](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-dependency) or the [Extension Pack For Java](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-pack) extension. This software leverages [Workspaces](https://code.visualstudio.com/docs/editor/workspaces) in Visual Studio Code and manages a `vortex.code-workspace` file within the workspace.\n\n## Installation\n\n1. Install the tool using pip.\n\n ```\n pip install vortex-cli\n ```\n\n2. It is recommended to set the workspace you would like to work out of via the `VORTEX_HOME` environment variable.\n\n On Unix:\n\n ```\n export VORTEX_HOME=/path/to/workspace\n ```\n\n Otherwise, Vortex CLI will use a default **'vortex-cli-workspace'** directory inside your home directory.\n\n3. Run vortex with the `--init` flag to create your workspace (If it doesn't already exist) and the necessary config files:\n ```\n vortex --init\n ```\n\n4. Define the servers you will be working with in the `servers.ini` file inside the `.config` directory within your workspace. You can quickly access this using the `code` command to view your workspace in VSCode.\n\n ```\n vortex code\n ```\n\n In the `servers.ini` file, you can define as many servers as you need, each with their own unique name. For example:\n\n ```\n [DEFAULT] ; This section is optional and only useful if you have multiple definitions\n port = 80 ; Options provided under DEFAULT will be applied to all definitions if not provided\n soap_path = system/SOAPDesigner.pma\n default = server1 ; Useful when you have multiple definitions\n\n\n [server1] ; This can be called whatever you want and can be referenced using the '--server' flag\n host = example.com\n port = 8080 ; we can overwrite the DEFAULT value\n puakma_db_conn_id = 13\n username = myuser ; Optional - Prompted at runtime if not provided\n password = mypassword ; Optional - Prompted at runtime if not provided\n lib_path = ; additional jars that should be included in the classpath\n java_home = /usr/lib/jvm/java-17-openjdk-amd64/ ; The local path to the JRE to use. Should be the same version running on your server\n java_environment_name = JavaSE-17 ; Java Execution Environment name https://docs.osgi.org/reference/eenames.html\n ```\n\n## Usage\n\nFor a full list of commands see `--help`.\n\n### Command Overview\n\n- `code`: Open the workspace in Visual Studio Code.\n- `list` (or `ls`): List Puakma Applications on the server or cloned locally. (`ls` is an alias for `vortex list --local`)\n- `clone`: Clone Puakma Applications and their design objects into the workspace or in the .pmx format.\n- `watch`: Watch the workspace for changes to Design Objects and automatically upload them to the server.\n- `clean`: Delete the locally cloned Puakma Application directories in the workspace.\n- `config`: View and manage configuration.\n- `log`: View the server log.\n- `find`: Find Design Objects of cloned applications by name.\n- `grep`: Search the contents of cloned Design Objects using a Regular Expression.\n- `new`: Create new Design Objects, Applications, or Keywords. Use --update <ID> to update instead.\n- `copy`: Copy a Design Object from one application to another.\n- `delete`: Delete Design Objects by ID.\n- `db`: Interact with Database Connections.\n- `docs`: Open the Tornado Server Blackbook.\n- `execute`: Execute a command on the server.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Vortex CLI",
"version": "4.12.1",
"project_urls": {
"Homepage": "https://github.com/jordanamos/vortex-cli"
},
"split_keywords": [
"vortex",
"cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a48a1311e2244d79ba08e02d2ac554bfab142fdedbea3ac8e1ac34c7962b06e4",
"md5": "bdaa7ddbec20d7a48c72c4be26bc34bd",
"sha256": "0136de00af270d23f01b59f7c2cbebf2f3348366a5a301ec44388944aecc29ae"
},
"downloads": -1,
"filename": "vortex_cli-4.12.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bdaa7ddbec20d7a48c72c4be26bc34bd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 3098459,
"upload_time": "2024-03-31T06:57:43",
"upload_time_iso_8601": "2024-03-31T06:57:43.207158Z",
"url": "https://files.pythonhosted.org/packages/a4/8a/1311e2244d79ba08e02d2ac554bfab142fdedbea3ac8e1ac34c7962b06e4/vortex_cli-4.12.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8068c3beb0766c0e80132281d4c0fb776395dda15d8acb8d7b557676a601d309",
"md5": "2ecd5b595b934bbf5a9c75ea80e08556",
"sha256": "a95a7f439d356b874fbe7b7678a06c8871645d31637ee22070a54de86b46d1e5"
},
"downloads": -1,
"filename": "vortex_cli-4.12.1.tar.gz",
"has_sig": false,
"md5_digest": "2ecd5b595b934bbf5a9c75ea80e08556",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 3091264,
"upload_time": "2024-03-31T06:57:46",
"upload_time_iso_8601": "2024-03-31T06:57:46.911361Z",
"url": "https://files.pythonhosted.org/packages/80/68/c3beb0766c0e80132281d4c0fb776395dda15d8acb8d7b557676a601d309/vortex_cli-4.12.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-31 06:57:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jordanamos",
"github_project": "vortex-cli",
"github_not_found": true,
"lcname": "vortex-cli"
}
JSON
