vortex-cli 8.1.0__tar.gz → 8.1.1__tar.gz

{vortex_cli-8.1.0 → vortex_cli-8.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vortex_cli
-Version: 8.1.0
+Version: 8.1.1
 Summary: Vortex CLI
 Author-email: Jordan Amos <jordan.amos@gmail.com>
 License: MIT License
@@ -127,7 +127,7 @@ errors (exit 2).
 | `config --set-password` | `keyring set vortex-cli:<server> <username>` |
 | `config --sample` | `server get` (every option it reads) |
 | `execute --show-schedule` / `--refresh-agenda` / `--flush-cache` | `execute schedule` / `refresh-agenda` / `flush-cache` |
-| `execute --refresh-design N` | `app refresh-design N` |
+| `execute --refresh-design N` | `execute refresh-design N` or `app refresh N` |
 | `execute --run PATH` | `object run ID --app-id N` |
 | `status [--show-permissions] [--json]` | `vortex [-s NAME] [--show-permissions] [--json]` (no command) - plus the CLI version and the workspace |
 | `vortex` with no command (the workspace path) | the live status of the default server: `vortex-cli` and `workspace` first, then the server (`vortex --path` prints just the path) |
@@ -271,7 +271,7 @@ vortex app update   APP_ID [--name --group --description --inherit-from --templa
                     [--param NAME=VALUE ...] [--remove-param NAME ...]
 vortex app export   APP_ID... [--out-dir --exclude-source --timeout]
 vortex app import   FILE.pmx --name N --group G
-vortex app refresh-design APP_ID
+vortex app refresh  APP_ID  (alias: refresh-design)
 
 ── object ───────────────────────────────────────────────────────────────────
 vortex object get    ID --app-id ID [--show-source --show-data] [--json]
@@ -329,7 +329,8 @@ vortex code      [--refresh [--reset]] [-s]
 vortex           [-s NAME] [--show-permissions] [--json]   (the server's live status)
 vortex --path    (the workspace path)
 vortex log       [-n --source -m --errors-only|--debug-only|--info-only -k -d] [--json]
-vortex execute   CMD... | flush-cache | refresh-agenda | schedule [--json]  (alias: ex)
+vortex execute   CMD... | flush-cache | refresh-agenda | refresh-design APP_ID | schedule
+                 [--json]  (alias: ex)
 vortex server list  [--json]
 vortex server get   [NAME] [--json]
 vortex server use   NAME                                  (or: vortex use NAME)
@@ -406,27 +407,29 @@ and application write, so a manual cache flush is never required after one.
 
 `vortex execute CMD...` (or `ex`) sends any console command - the gateway's `POST console`,
 which needs `GatewaySystem`, or the SOAP console without the gateway. The words are joined,
-so no quoting is needed. Three names are shortcuts that send the exact strings the server's
+so no quoting is needed. These names are shortcuts that send the exact strings the server's
 addins match:
 
 | Shortcut | Sends | Effect |
 |---|---|---|
 | `schedule` | `tell agenda schedule` | lists every scheduled action and its next run |
 | `refresh-agenda` | `tell agenda refresh` | AGENDA rereads every schedule now |
+| `refresh-design APP_ID` | `tell agenda run /<webdesign_path>/RefreshDesign?&AppID=N` | rebuilds the application's design from its template, as `app refresh` does (a clone is then out of date) |
 | `flush-cache` | `tell http cache flush` | clears the design cache and all action class loaders |
 
 `tell http flush cache` is **not** a valid command: the HTTP addin only matches
 `cache flush`, and anything else does nothing, silently. Use `flush-cache`.
 
-Two console operations act on one application or object, so they live with those nouns:
+Two console operations act on one application or object, so they also live with those nouns:
 
 | Command | Sends |
 |---|---|
-| `vortex app refresh-design APP_ID` | `tell agenda run /<webdesign_path>/RefreshDesign?&AppID=N` - rebuilds the design from its template (a clone is then out of date) |
+| `vortex app refresh APP_ID` | `tell agenda run /<webdesign_path>/RefreshDesign?&AppID=N` - rebuilds the design from its template (a clone is then out of date) |
 | `vortex object run ID --app-id N` | `tell agenda run /group/app.pma/name` - runs an ACTION or SCHEDULED_ACTION now |
 
 The 8.0 flags (`--show-schedule`, `--refresh-agenda`, `--flush-cache`, `--refresh-design`,
-`--run`) were removed in 8.1.
+`--run`) were removed in 8.1. `app refresh` was `app refresh-design` in 8.1.0; the old
+name still works.
 
 ### Local clones stay in sync
 
@@ -449,7 +452,7 @@ prints the command to re-sync (`vortex clone APP_ID -s SERVER`).
 | `object copy` | the target application's clone |
 | `keyword set` / `delete` | the clone's stored keywords |
 | `compile` | writes `zbin/`; `--upload` stores the uploaded blobs |
-| `execute --refresh-design` | none - prints that the clone is out of date |
+| `app refresh` / `execute refresh-design` | none - prints that the clone is out of date |
 | `app create` / `import` / `export`, all `db` commands | none |
 
 A clone stores the design objects, the application's details (with its description), its

{vortex_cli-8.1.0 → vortex_cli-8.1.1}/README.md

@@ -83,7 +83,7 @@ errors (exit 2).
 | `config --set-password` | `keyring set vortex-cli:<server> <username>` |
 | `config --sample` | `server get` (every option it reads) |
 | `execute --show-schedule` / `--refresh-agenda` / `--flush-cache` | `execute schedule` / `refresh-agenda` / `flush-cache` |
-| `execute --refresh-design N` | `app refresh-design N` |
+| `execute --refresh-design N` | `execute refresh-design N` or `app refresh N` |
 | `execute --run PATH` | `object run ID --app-id N` |
 | `status [--show-permissions] [--json]` | `vortex [-s NAME] [--show-permissions] [--json]` (no command) - plus the CLI version and the workspace |
 | `vortex` with no command (the workspace path) | the live status of the default server: `vortex-cli` and `workspace` first, then the server (`vortex --path` prints just the path) |
@@ -227,7 +227,7 @@ vortex app update   APP_ID [--name --group --description --inherit-from --templa
                     [--param NAME=VALUE ...] [--remove-param NAME ...]
 vortex app export   APP_ID... [--out-dir --exclude-source --timeout]
 vortex app import   FILE.pmx --name N --group G
-vortex app refresh-design APP_ID
+vortex app refresh  APP_ID  (alias: refresh-design)
 
 ── object ───────────────────────────────────────────────────────────────────
 vortex object get    ID --app-id ID [--show-source --show-data] [--json]
@@ -285,7 +285,8 @@ vortex code      [--refresh [--reset]] [-s]
 vortex           [-s NAME] [--show-permissions] [--json]   (the server's live status)
 vortex --path    (the workspace path)
 vortex log       [-n --source -m --errors-only|--debug-only|--info-only -k -d] [--json]
-vortex execute   CMD... | flush-cache | refresh-agenda | schedule [--json]  (alias: ex)
+vortex execute   CMD... | flush-cache | refresh-agenda | refresh-design APP_ID | schedule
+                 [--json]  (alias: ex)
 vortex server list  [--json]
 vortex server get   [NAME] [--json]
 vortex server use   NAME                                  (or: vortex use NAME)
@@ -362,27 +363,29 @@ and application write, so a manual cache flush is never required after one.
 
 `vortex execute CMD...` (or `ex`) sends any console command - the gateway's `POST console`,
 which needs `GatewaySystem`, or the SOAP console without the gateway. The words are joined,
-so no quoting is needed. Three names are shortcuts that send the exact strings the server's
+so no quoting is needed. These names are shortcuts that send the exact strings the server's
 addins match:
 
 | Shortcut | Sends | Effect |
 |---|---|---|
 | `schedule` | `tell agenda schedule` | lists every scheduled action and its next run |
 | `refresh-agenda` | `tell agenda refresh` | AGENDA rereads every schedule now |
+| `refresh-design APP_ID` | `tell agenda run /<webdesign_path>/RefreshDesign?&AppID=N` | rebuilds the application's design from its template, as `app refresh` does (a clone is then out of date) |
 | `flush-cache` | `tell http cache flush` | clears the design cache and all action class loaders |
 
 `tell http flush cache` is **not** a valid command: the HTTP addin only matches
 `cache flush`, and anything else does nothing, silently. Use `flush-cache`.
 
-Two console operations act on one application or object, so they live with those nouns:
+Two console operations act on one application or object, so they also live with those nouns:
 
 | Command | Sends |
 |---|---|
-| `vortex app refresh-design APP_ID` | `tell agenda run /<webdesign_path>/RefreshDesign?&AppID=N` - rebuilds the design from its template (a clone is then out of date) |
+| `vortex app refresh APP_ID` | `tell agenda run /<webdesign_path>/RefreshDesign?&AppID=N` - rebuilds the design from its template (a clone is then out of date) |
 | `vortex object run ID --app-id N` | `tell agenda run /group/app.pma/name` - runs an ACTION or SCHEDULED_ACTION now |
 
 The 8.0 flags (`--show-schedule`, `--refresh-agenda`, `--flush-cache`, `--refresh-design`,
-`--run`) were removed in 8.1.
+`--run`) were removed in 8.1. `app refresh` was `app refresh-design` in 8.1.0; the old
+name still works.
 
 ### Local clones stay in sync
 
@@ -405,7 +408,7 @@ prints the command to re-sync (`vortex clone APP_ID -s SERVER`).
 | `object copy` | the target application's clone |
 | `keyword set` / `delete` | the clone's stored keywords |
 | `compile` | writes `zbin/`; `--upload` stores the uploaded blobs |
-| `execute --refresh-design` | none - prints that the clone is out of date |
+| `app refresh` / `execute refresh-design` | none - prints that the clone is out of date |
 | `app create` / `import` / `export`, all `db` commands | none |
 
 A clone stores the design objects, the application's details (with its description), its

{vortex_cli-8.1.0 → vortex_cli-8.1.1}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "vortex_cli"
-version = "8.1.0"
+version = "8.1.1"
 description = "Vortex CLI"
 requires-python = ">=3.10"
 readme = { file = "README.md", content-type = "text/markdown" }

{vortex_cli-8.1.0 → vortex_cli-8.1.1}/vortex/cli.py

@@ -562,6 +562,9 @@ _EXECUTE_SHORTCUTS_HELP = """\
 Shortcuts (each sends the exact string the server's addins match):
     flush-cache           | tell http cache flush ('tell http flush cache' does nothing)
     refresh-agenda        | tell agenda refresh: AGENDA rereads every schedule now
+    refresh-design APP_ID | tell agenda run /<webdesign_path>/RefreshDesign?&AppID=N:
+                          | rebuild the application's design from its template
+                          | (same as 'vortex app refresh APP_ID')
     schedule              | tell agenda schedule: every scheduled action and its next run
 
 Console commands:
@@ -576,7 +579,7 @@ def add_execute_parser(
         aliases=("ex",),
         help=(
             "Send a console command to the server (or a shortcut: flush-cache, "
-            "refresh-agenda, schedule)"
+            "refresh-agenda, refresh-design APP_ID, schedule)"
         ),
         description=_EXECUTE_SHORTCUTS_HELP + _EXECUTE_PARSER_DESCRIPTION,
         formatter_class=RawDescriptionHelpFormatter,

{vortex_cli-8.1.0 → vortex_cli-8.1.1}/vortex/commands/app.py

@@ -1,5 +1,5 @@
 """
-vortex app list | get | create | update | export | import | refresh-design,
+vortex app list | get | create | update | export | import | refresh,
 and 'vortex ls'
 (= app list --local).
 
@@ -587,7 +587,7 @@ def _render_import(ctx: Context, args: argparse.Namespace, reply: Any) -> None:
 # -- parsers ---------------------------------------------------------------
 
 
-# -- refresh-design --------------------------------------------------------
+# -- refresh ---------------------------------------------------------------
 
 
 def _refresh_design(ctx: Context, args: argparse.Namespace) -> dict[str, Any]:
@@ -767,7 +767,7 @@ COMMANDS = [
     ),
     Command(
         "app",
-        "refresh-design",
+        "refresh",
         "Rebuild an application's design from its template (AGENDA RefreshDesign)",
         _refresh_design,
         routes=(registry.INVENTORY, registry.CONSOLE),
@@ -778,7 +778,9 @@ COMMANDS = [
             "Rebuild an application's design from its template: sends\n"
             "'tell agenda run /<webdesign_path>/RefreshDesign?&AppID=N' to the\n"
             "console (the gateway's POST console needs GatewaySystem). A clone\n"
-            "of the application is then out of date - re-clone it."
+            "of the application is then out of date - re-clone it.\n"
+            "'vortex execute refresh-design N' sends the same command."
         ),
+        aliases=("refresh-design",),
     ),
 ]

{vortex_cli-8.1.0 → vortex_cli-8.1.1}/vortex/commands/execute.py

@@ -67,6 +67,18 @@ def resolve_command(words: list[str]) -> str:
     return SHORTCUTS.get(command, command)
 
 
+def refresh_design_app_id(words: list[str]) -> int | None:
+    """
+    N for 'vortex execute refresh-design N' (the console shortcut for
+    'app refresh N'), else None. Raises ValueError for a missing or bad N.
+    """
+    if not words or words[0] != "refresh-design":
+        return None
+    if len(words) != 2 or not words[1].isdigit() or int(words[1]) < 1:
+        raise ValueError("refresh-design takes one application id: refresh-design N")
+    return int(words[1])
+
+
 def warn_clone_out_of_date(
     workspace: Workspace, server: PuakmaServer, app_id: int
 ) -> None:
@@ -79,6 +91,21 @@ def warn_clone_out_of_date(
         )
 
 
+def execute_refresh_design(
+    workspace: Workspace,
+    server: PuakmaServer,
+    app_id: int,
+    *,
+    json_output: bool = False,
+) -> int:
+    """'vortex execute refresh-design N': 'app refresh N' as a console shortcut."""
+    command = refresh_design_command(server, app_id)
+    code = execute(server, command, json_output=json_output)
+    if code == 0:
+        warn_clone_out_of_date(workspace, server, app_id)
+    return code
+
+
 def execute(server: PuakmaServer, command: str, *, json_output: bool = False) -> int:
     """
     Sends one console command. --json: {command, reply} in one envelope, a

{vortex_cli-8.1.0 → vortex_cli-8.1.1}/vortex/main.py

@@ -20,6 +20,8 @@ from vortex.commands.code import code
 from vortex.commands.compile import compile_
 from vortex.commands.docs import docs
 from vortex.commands.execute import execute
+from vortex.commands.execute import execute_refresh_design
+from vortex.commands.execute import refresh_design_app_id
 from vortex.commands.execute import resolve_command
 from vortex.commands.log import log
 from vortex.commands.watch import watch
@@ -434,7 +436,7 @@ def build_parser() -> (
     cli.add_watch_parser(command_parser)
     cli.add_clean_parser(command_parser)
     cli.add_log_parser(command_parser)
-    cli.add_execute_parser(command_parser)
+    parsers["execute"] = cli.add_execute_parser(command_parser)
     cli.add_server_parser(command_parser)
     cli.add_docs_parser(command_parser)
     return parser, parsers
@@ -491,6 +493,11 @@ def main(argv: Sequence[str] | None = None) -> int:
         # 'vortex -s NAME COMMAND' is 'vortex COMMAND -s NAME'
         args.server = args.root_server
     cli.validate_args(args, parsers["clone"])
+    if args.command in ("execute", "ex"):
+        try:
+            args.refresh_design_app_id = refresh_design_app_id(args.cmd)
+        except ValueError as e:
+            parsers["execute"].error(str(e))
 
     if args.no_colour:
         Colour.disable()
@@ -646,6 +653,13 @@ def main(argv: Sequence[str] | None = None) -> int:
                 force=args.force,
             )
         elif args.command in ("execute", "ex"):
+            if args.refresh_design_app_id is not None:
+                return execute_refresh_design(
+                    workspace,
+                    server,
+                    args.refresh_design_app_id,
+                    json_output=args.json_output,
+                )
             return execute(
                 server, resolve_command(args.cmd), json_output=args.json_output
             )

{vortex_cli-8.1.0 → vortex_cli-8.1.1}/vortex/registry.py

@@ -253,6 +253,7 @@ def add_parsers(
                 )
             parser = nouns[cmd.noun].add_parser(
                 cmd.verb,
+                aliases=cmd.aliases,
                 help=cmd.help,
                 description=cmd.description or cmd.help,
                 formatter_class=argparse.RawDescriptionHelpFormatter,

{vortex_cli-8.1.0 → vortex_cli-8.1.1}/vortex_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vortex_cli
-Version: 8.1.0
+Version: 8.1.1
 Summary: Vortex CLI
 Author-email: Jordan Amos <jordan.amos@gmail.com>
 License: MIT License
@@ -127,7 +127,7 @@ errors (exit 2).
 | `config --set-password` | `keyring set vortex-cli:<server> <username>` |
 | `config --sample` | `server get` (every option it reads) |
 | `execute --show-schedule` / `--refresh-agenda` / `--flush-cache` | `execute schedule` / `refresh-agenda` / `flush-cache` |
-| `execute --refresh-design N` | `app refresh-design N` |
+| `execute --refresh-design N` | `execute refresh-design N` or `app refresh N` |
 | `execute --run PATH` | `object run ID --app-id N` |
 | `status [--show-permissions] [--json]` | `vortex [-s NAME] [--show-permissions] [--json]` (no command) - plus the CLI version and the workspace |
 | `vortex` with no command (the workspace path) | the live status of the default server: `vortex-cli` and `workspace` first, then the server (`vortex --path` prints just the path) |
@@ -271,7 +271,7 @@ vortex app update   APP_ID [--name --group --description --inherit-from --templa
                     [--param NAME=VALUE ...] [--remove-param NAME ...]
 vortex app export   APP_ID... [--out-dir --exclude-source --timeout]
 vortex app import   FILE.pmx --name N --group G
-vortex app refresh-design APP_ID
+vortex app refresh  APP_ID  (alias: refresh-design)
 
 ── object ───────────────────────────────────────────────────────────────────
 vortex object get    ID --app-id ID [--show-source --show-data] [--json]
@@ -329,7 +329,8 @@ vortex code      [--refresh [--reset]] [-s]
 vortex           [-s NAME] [--show-permissions] [--json]   (the server's live status)
 vortex --path    (the workspace path)
 vortex log       [-n --source -m --errors-only|--debug-only|--info-only -k -d] [--json]
-vortex execute   CMD... | flush-cache | refresh-agenda | schedule [--json]  (alias: ex)
+vortex execute   CMD... | flush-cache | refresh-agenda | refresh-design APP_ID | schedule
+                 [--json]  (alias: ex)
 vortex server list  [--json]
 vortex server get   [NAME] [--json]
 vortex server use   NAME                                  (or: vortex use NAME)
@@ -406,27 +407,29 @@ and application write, so a manual cache flush is never required after one.
 
 `vortex execute CMD...` (or `ex`) sends any console command - the gateway's `POST console`,
 which needs `GatewaySystem`, or the SOAP console without the gateway. The words are joined,
-so no quoting is needed. Three names are shortcuts that send the exact strings the server's
+so no quoting is needed. These names are shortcuts that send the exact strings the server's
 addins match:
 
 | Shortcut | Sends | Effect |
 |---|---|---|
 | `schedule` | `tell agenda schedule` | lists every scheduled action and its next run |
 | `refresh-agenda` | `tell agenda refresh` | AGENDA rereads every schedule now |
+| `refresh-design APP_ID` | `tell agenda run /<webdesign_path>/RefreshDesign?&AppID=N` | rebuilds the application's design from its template, as `app refresh` does (a clone is then out of date) |
 | `flush-cache` | `tell http cache flush` | clears the design cache and all action class loaders |
 
 `tell http flush cache` is **not** a valid command: the HTTP addin only matches
 `cache flush`, and anything else does nothing, silently. Use `flush-cache`.
 
-Two console operations act on one application or object, so they live with those nouns:
+Two console operations act on one application or object, so they also live with those nouns:
 
 | Command | Sends |
 |---|---|
-| `vortex app refresh-design APP_ID` | `tell agenda run /<webdesign_path>/RefreshDesign?&AppID=N` - rebuilds the design from its template (a clone is then out of date) |
+| `vortex app refresh APP_ID` | `tell agenda run /<webdesign_path>/RefreshDesign?&AppID=N` - rebuilds the design from its template (a clone is then out of date) |
 | `vortex object run ID --app-id N` | `tell agenda run /group/app.pma/name` - runs an ACTION or SCHEDULED_ACTION now |
 
 The 8.0 flags (`--show-schedule`, `--refresh-agenda`, `--flush-cache`, `--refresh-design`,
-`--run`) were removed in 8.1.
+`--run`) were removed in 8.1. `app refresh` was `app refresh-design` in 8.1.0; the old
+name still works.
 
 ### Local clones stay in sync
 
@@ -449,7 +452,7 @@ prints the command to re-sync (`vortex clone APP_ID -s SERVER`).
 | `object copy` | the target application's clone |
 | `keyword set` / `delete` | the clone's stored keywords |
 | `compile` | writes `zbin/`; `--upload` stores the uploaded blobs |
-| `execute --refresh-design` | none - prints that the clone is out of date |
+| `app refresh` / `execute refresh-design` | none - prints that the clone is out of date |
 | `app create` / `import` / `export`, all `db` commands | none |
 
 A clone stores the design objects, the application's details (with its description), its