Add iriscli and ipm container utility scripts

Author: isc-dchui

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - #992: Implement automatic history purge logic
 - #973: Enables CORS and JWT configuration for WebApplications in module.xml
+- #1110: Add `iriscli` and `ipm` container utility scripts
 
 ### Fixed
 - #1001: The `unmap` and `enable` commands will now only activate CPF merge once after all namespaces have been configured instead after every namespace

CONTRIBUTING.md

@@ -92,6 +92,49 @@ From time to time, you may also want to remove unused Docker data to save disk s
 docker system prune -a
 ```
 
+#### Convenience Scripts: `ipm` and `iriscli`
+
+The repo ships two bash scripts that wrap common IRIS interactions so you don't have to type `iris session iris` boilerplate every time. They are copied into `/home/irisowner/bin/` during the container build and are available by name in any running container.
+
+**`ipm`** — runs a single IPM/ZPM command non-interactively and exits:
+```bash
+# List installed packages
+docker exec -it <container-name, e.g. ipm-iris-1> ipm list
+
+# Install a package
+docker exec -it <container-name, e.g. ipm-iris-1> ipm install zpm-registry
+
+# Run tests for a module
+docker exec -it <container-name, e.g. ipm-iris-1> ipm test mymodule -only
+
+# Using docker compose exec (works for any container defined in docker-compose.yml)
+# Note: must be run from the directory containing docker-compose.yml
+docker compose exec iris ipm list
+```
+
+**`iriscli`** — opens an interactive IRIS terminal session:
+```bash
+# Either this command
+docker exec -it <container-name, e.g. ipm-iris-1> iriscli
+
+# Or this equivalent command (must be run from the directory containing docker-compose.yml)
+docker compose exec -it iris iriscli
+```
+
+`iriscli` also accepts an ObjectScript script file, executing each line and then halting:
+```bash
+docker compose exec -it iris iriscli /path/to/demo.script
+```
+
+A sample `demo.script`:
+```objectscript
+zn "USER"
+write $zversion,!
+zpm "list"
+```
+
+> **Namespace:** Both scripts respect the `IRIS_NAMESPACE` environment variable, or accept `-U <namespace>` as the first argument. For example: `docker exec -it <container-name> ipm -U %SYS list`.
+
 
 ### Developing IPM in an Existing IRIS Instance
 If you already have an IRIS instance running and you want to test IPM in this instance, run the following command:

Dockerfile

@@ -4,6 +4,11 @@ FROM ${BASE}
 
 ARG REGISTRY=https://pm.community.intersystems.com
 
+# --- Create dirs and place tools (use --chown to avoid extra chown layers) ---
+COPY --chown=irisowner:irisowner iriscli /home/irisowner/bin/iriscli
+COPY --chown=irisowner:irisowner ipm    /home/irisowner/bin/ipm
+RUN chmod +x /home/irisowner/bin/iriscli /home/irisowner/bin/ipm
+
 RUN --mount=type=bind,src=.,dst=/home/irisowner/zpm/ \
     iris start iris && \
     iris session IRIS < /home/irisowner/zpm/iris.script && \

ipm

@@ -0,0 +1,44 @@
+#!/bin/bash
+
+# ipm: convenience wrapper to run a ZPM command in an IRIS session
+# Usage examples:
+#   ipm isc.genai test -only
+#   ipm -U PLAZA isc.genai test -only
+
+ARGS=()
+CMD=()
+
+# Allow namespace via env like iriscli
+if [ -n "$IRIS_NAMESPACE" ]; then
+  ARGS+=( -U "$IRIS_NAMESPACE" )
+elif [ -n "$IRISNAMESPACE" ]; then
+  ARGS+=( -U "$IRISNAMESPACE" )
+fi
+
+# Optional leading -U <ns>
+if [ "$1" = "-U" ] && [ -n "$2" ]; then
+  ARGS+=( -U "$2" )
+  shift 2
+fi
+
+# Remaining args compose the ZPM command string
+while [[ $# -gt 0 ]]; do
+  CMD+=( "$1" )
+  shift
+done
+
+if [ ${#CMD[@]} -eq 0 ]; then
+  echo "Usage: ipm [ -U <NAMESPACE> ] <zpm command and args...>" >&2
+  exit 1
+fi
+
+# Join CMD array into a single string
+CMDSTR="${CMD[*]}"
+# Escape quotes for ObjectScript string literal
+CMDSTR_ESC=${CMDSTR//\"/\"\"}
+
+# Build an OS snippet and feed to iris session
+(
+  echo "zpm \"${CMDSTR_ESC}\":1:1"
+  echo "halt"
+) | iris session ${ISC_PACKAGE_INSTANCENAME:-iris} "${ARGS[@]}"

iriscli

@@ -0,0 +1,34 @@
+#!/bin/bash
+
+ARGS=()
+PARAMS=()
+file=
+
+if [ -n "$IRIS_NAMESPACE" ]; then
+    ARGS+=( -U $IRIS_NAMESPACE )
+elif [ -n "$IRISNAMESPACE" ]; then
+    ARGS+=( -U $IRISNAMESPACE )
+fi
+
+while [[ $# -gt 0 ]]; do
+    if [ -x $1 ]; then
+        file=$1
+    elif [ -z "$file" ]; then
+        ARGS+=("$1")
+    else 
+        PARAMS+=("$1")
+    fi
+    shift
+done
+
+if [ -n "$file" ]; then
+    (
+        for param in ${PARAMS[@]}; do
+            echo "Set params(\$i(params)) = \"${param//\"/\"\"}\""
+        done
+        egrep -v '^(;|#|//)|^$' $file; 
+        echo halt
+    ) | iris session $ISC_PACKAGE_INSTANCENAME "${ARGS[@]}"
+else
+    iris session iris "${ARGS[@]}"
+fi