@quantum-hub/qhubctl 1.0.0

package/oclif.manifest.json

@@ -0,0 +1,530 @@
+{
+  "commands": {
+    "compress": {
+      "aliases": [],
+      "args": {},
+      "description": "Compresses the current project and creates a ZIP file. Use the '.dockerignore' file to exclude files and directories from the ZIP file.",
+      "examples": [
+        "$ qhubctl compress"
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "compress",
+      "pluginAlias": "@quantum-hub/qhubctl",
+      "pluginName": "@quantum-hub/qhubctl",
+      "pluginType": "core",
+      "strict": true,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "compress",
+        "index.js"
+      ]
+    },
+    "datapool:upload": {
+      "aliases": [],
+      "args": {},
+      "description": "Upload files to a data pool",
+      "examples": [
+        "$ qhubctl datapool upload --file ./data/dataset.csv",
+        "$ qhubctl datapool upload --file ./data/dataset.csv --file ./data/metadata.json",
+        "$ qhubctl datapool upload -f ./data/dataset.csv -f ./data/metadata.json --datapool-id 550e8400-e29b-41d4-a716-446655440000"
+      ],
+      "flags": {
+        "file": {
+          "char": "f",
+          "description": "Path to a file to upload (can be specified multiple times)",
+          "name": "file",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        },
+        "datapool-id": {
+          "char": "d",
+          "description": "ID of the data pool to upload the files to (optional - will prompt to create a new one if not provided)",
+          "name": "datapool-id",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "datapool:upload",
+      "pluginAlias": "@quantum-hub/qhubctl",
+      "pluginName": "@quantum-hub/qhubctl",
+      "pluginType": "core",
+      "strict": true,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "datapool",
+        "upload.js"
+      ]
+    },
+    "get-context": {
+      "aliases": [],
+      "args": {},
+      "description": "Get the current context, i.e., the personal or organization account you are currently working with.",
+      "examples": [
+        "$ qhubctl get-context"
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "get-context",
+      "pluginAlias": "@quantum-hub/qhubctl",
+      "pluginName": "@quantum-hub/qhubctl",
+      "pluginType": "core",
+      "strict": true,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "get-context",
+        "index.js"
+      ]
+    },
+    "list-contexts": {
+      "aliases": [],
+      "args": {},
+      "description": "Retrieves the available contexts, i.e., the personal or organizational accounts available to you to work with.",
+      "examples": [
+        "$ qhubctl list-contexts"
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "list-contexts",
+      "pluginAlias": "@quantum-hub/qhubctl",
+      "pluginName": "@quantum-hub/qhubctl",
+      "pluginType": "core",
+      "strict": true,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "list-contexts",
+        "index.js"
+      ]
+    },
+    "init": {
+      "aliases": [],
+      "args": {},
+      "description": "Bootstrap project to create a service.",
+      "examples": [
+        "$ qhubctl init"
+      ],
+      "flags": {
+        "name": {
+          "description": "The name of the service",
+          "name": "name",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "non-interactive": {
+          "description": "Run it in non-interactive mode",
+          "name": "non-interactive",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "init",
+      "pluginAlias": "@quantum-hub/qhubctl",
+      "pluginName": "@quantum-hub/qhubctl",
+      "pluginType": "core",
+      "strict": true,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "init",
+        "index.js"
+      ]
+    },
+    "openapi": {
+      "aliases": [],
+      "args": {},
+      "description": "Generates the OpenAPI description for your project based on the parameter and return types of your run() method. The output of this command will be used when creating or updating your service. Supports PYTHON_TEMPLATE (with src/program.py), PYTHON and DOCKER runtimes (with explicit entrypoint). The Python dependency \"qhub-commons\" must be installed in your activated Python environment to use this command.",
+      "examples": [
+        "$ qhubctl openapi",
+        "$ qhubctl openapi --file=./openapi.yaml --format=yaml --force",
+        "$ qhubctl openapi --entrypoint=src.program:run",
+        "$ qhubctl openapi --package=src.program --method=run",
+        "$ qhubctl openapi --package=src.program"
+      ],
+      "flags": {
+        "force": {
+          "char": "f",
+          "description": "Overwrite the output file if it already exists",
+          "name": "force",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "file": {
+          "description": "The file to write the OpenAPI description to",
+          "name": "file",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "format": {
+          "description": "The format to generate the OpenAPI description [possible values: yaml]",
+          "name": "format",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "yaml"
+          ],
+          "type": "option"
+        },
+        "entrypoint": {
+          "description": "The entrypoint to your program in the format \"package.module:function\" (default: \"src.program:run\"). Overrides package and method flags.",
+          "name": "entrypoint",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "package": {
+          "description": "The package/module path to your program (e.g., \"src.program\" or \"my_package.main\"). Only used if entrypoint is not provided.",
+          "name": "package",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "method": {
+          "description": "The method/function name in your program (default: \"run\"). Only used if entrypoint is not provided.",
+          "name": "method",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "openapi",
+      "pluginAlias": "@quantum-hub/qhubctl",
+      "pluginName": "@quantum-hub/qhubctl",
+      "pluginType": "core",
+      "strict": true,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "openapi",
+        "index.js"
+      ]
+    },
+    "run": {
+      "aliases": [],
+      "args": {
+        "serviceId": {
+          "name": "serviceId"
+        }
+      },
+      "description": "Creates a job execution",
+      "examples": [
+        "$ qhubctl run",
+        "$ qhubctl run --detached",
+        "$ qhubctl run -i '{\"values\": [10,12], \"round_up\": true}'",
+        "$ qhubctl run --input-files=./input/data.json,./input/params.json",
+        "$ qhubctl run --input-files=./config.json,./overrides.json"
+      ],
+      "flags": {
+        "input": {
+          "char": "i",
+          "description": "Input as JSON string.",
+          "name": "input",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "input-files": {
+          "aliases": [
+            "input-files"
+          ],
+          "description": "Comma-separated paths to files containing input to be merged (default: ./input/data.json,./input/params.json).",
+          "name": "input-files",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "detached": {
+          "description": "Executes the job in detached mode, i.e., without waiting for it to finish.",
+          "name": "detached",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "run",
+      "pluginAlias": "@quantum-hub/qhubctl",
+      "pluginName": "@quantum-hub/qhubctl",
+      "pluginType": "core",
+      "strict": true,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "run",
+        "index.js"
+      ]
+    },
+    "login": {
+      "aliases": [],
+      "args": {},
+      "description": "Login with your credentials",
+      "examples": [
+        "$ qhubctl login -t <personal access token>",
+        "$ qhubctl login -t <personal access token> --base-path https://api.hub.kipu-quantum.com"
+      ],
+      "flags": {
+        "token": {
+          "char": "t",
+          "description": "Your personal access token",
+          "name": "token",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "base-path": {
+          "description": "Custom base path for authentication (development)",
+          "name": "base-path",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "login",
+      "pluginAlias": "@quantum-hub/qhubctl",
+      "pluginName": "@quantum-hub/qhubctl",
+      "pluginType": "core",
+      "strict": true,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "login",
+        "index.js"
+      ]
+    },
+    "logout": {
+      "aliases": [],
+      "args": {},
+      "description": "Logout",
+      "examples": [
+        "$ qhubctl logout"
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "logout",
+      "pluginAlias": "@quantum-hub/qhubctl",
+      "pluginName": "@quantum-hub/qhubctl",
+      "pluginType": "core",
+      "strict": true,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "logout",
+        "index.js"
+      ]
+    },
+    "serve": {
+      "aliases": [],
+      "args": {},
+      "description": "Runs your project in a containerized environment and expose it through a local web server, similarly to how Kipu Quantum Hub would run your code. The local web server exposes the same HTTP endpoints to start a service execution, to check the status of running executions, to cancel executions, and to retrieve execution results.",
+      "examples": [
+        "$ qhubctl serve",
+        "$ qhubctl serve -p <port> --log_level <log_level>"
+      ],
+      "flags": {
+        "port": {
+          "char": "p",
+          "description": "The port on which the local web server accepts requests",
+          "name": "port",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "log_level": {
+          "description": "The log level for the service, possible values: DEBUG, INFO, WARNING, ERROR, CRITICAL",
+          "name": "log_level",
+          "required": false,
+          "default": "INFO",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "serve",
+      "pluginAlias": "@quantum-hub/qhubctl",
+      "pluginName": "@quantum-hub/qhubctl",
+      "pluginType": "core",
+      "strict": true,
+      "CONTAINER_NAME": "planqk-cli-serve",
+      "IMAGE": "registry.gitlab.com/planqk-foss/planqk-cli-serve:latest",
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "serve",
+        "index.js"
+      ]
+    },
+    "services": {
+      "aliases": [],
+      "args": {},
+      "description": "List all services of the current context.",
+      "examples": [
+        "$ qhubctl services",
+        "$ qhubctl services --json",
+        "$ qhubctl services --name \"my-service\"",
+        "$ qhubctl services --name \"my-service\" --json",
+        "$ qhubctl services --json --all"
+      ],
+      "flags": {
+        "json": {
+          "description": "output in JSON format",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "name": {
+          "description": "filter services by name (case-insensitive full match)",
+          "name": "name",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "all": {
+          "description": "display all service properties (only available with --json)",
+          "name": "all",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "services",
+      "pluginAlias": "@quantum-hub/qhubctl",
+      "pluginName": "@quantum-hub/qhubctl",
+      "pluginType": "core",
+      "strict": true,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "services",
+        "index.js"
+      ]
+    },
+    "up": {
+      "aliases": [],
+      "args": {},
+      "description": "Creates or updates a service",
+      "examples": [
+        "$ qhubctl up",
+        "$ qhubctl up --no-save-id",
+        "$ qhubctl up --name \"my-custom-service-name\"",
+        "$ qhubctl up --name \"test-service\" --no-save-id"
+      ],
+      "flags": {
+        "silent": {
+          "description": "Suppresses all outputs, helpful when executed in a CI/CD pipeline.",
+          "name": "silent",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "no-save-id": {
+          "description": "Prevents storing the created service ID in qhub.json file.",
+          "name": "no-save-id",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "name": {
+          "description": "Override the service name from qhub.json with a custom name.",
+          "name": "name",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "up",
+      "pluginAlias": "@quantum-hub/qhubctl",
+      "pluginName": "@quantum-hub/qhubctl",
+      "pluginType": "core",
+      "strict": true,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "up",
+        "index.js"
+      ]
+    },
+    "set-context": {
+      "aliases": [],
+      "args": {
+        "contextId": {
+          "name": "contextId"
+        }
+      },
+      "description": "Set the current context, i.e., the personal or organization account you are currently working with.",
+      "examples": [
+        "$ qhubctl set-context",
+        "$ qhubctl set-context <context-id>"
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "set-context",
+      "pluginAlias": "@quantum-hub/qhubctl",
+      "pluginName": "@quantum-hub/qhubctl",
+      "pluginType": "core",
+      "strict": true,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "set-context",
+        "index.js"
+      ]
+    }
+  },
+  "version": "1.0.0"
+}

package/package.json

@@ -0,0 +1,107 @@
+{
+  "name": "@quantum-hub/qhubctl",
+  "version": "1.0.0",
+  "description": "Quantum Hub CLI",
+  "author": "Kipu Quantum GmbH",
+  "contributors": [
+    "Wurster, Michael <michael.wurster@kipu-quantum.com>",
+    "Falkenthal, Michael <michael.falkenthal@kipu-quantum.com>",
+    "Krieger, Christoph <christoph.krieger@kipu-quantum.com>",
+    "Harzenetter, Lukas <lukas.harzenetter@kipu-quantum.com>"
+  ],
+  "license": "Apache-2.0",
+  "keywords": [
+    "hub",
+    "kipu",
+    "kipu-quantum",
+    "kqh"
+  ],
+  "bin": {
+    "qhubctl": "./bin/run.js"
+  },
+  "main": "dist/index.js",
+  "files": [
+    "/bin",
+    "/dist",
+    "/oclif.manifest.json"
+  ],
+  "dependencies": {
+    "@oclif/core": "^4.5.2",
+    "@oclif/plugin-autocomplete": "^3.2.34",
+    "@oclif/plugin-help": "^6.2.32",
+    "@oclif/plugin-not-found": "^3.2.62",
+    "@oclif/plugin-version": "^2.2.32",
+    "@oclif/plugin-warn-if-update-available": "^3.1.46",
+    "@quantum-hub/qhub-api": "^1",
+    "adm-zip": "^0.5.16",
+    "async-wait-until": "^2.0.27",
+    "fs-extra": "^11.3.0",
+    "ignore": "^7.0.5",
+    "inquirer": "^12.9.0",
+    "listr": "^0.14.3",
+    "terminal-link": "^4.0.0",
+    "tty-table": "^4.2.3",
+    "yaml": "^2.8.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9",
+    "@oclif/prettier-config": "^0.2.1",
+    "@oclif/test": "^4.1.13",
+    "@types/adm-zip": "^0.5.7",
+    "@types/chai": "^5.2.2",
+    "@types/fs-extra": "^11.0.4",
+    "@types/inquirer": "^9.0.8",
+    "@types/listr": "^0.14.9",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^24.1.0",
+    "chai": "^5.2.1",
+    "eslint": "^9.32.0",
+    "mocha": "^11.7.1",
+    "nyc": "^17.1.0",
+    "oclif": "^4.22.5",
+    "shx": "^0.4.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.3",
+    "typescript-eslint": "^8.38.0"
+  },
+  "oclif": {
+    "bin": "qhubctl",
+    "dirname": "qhubctl",
+    "commands": "./dist/commands",
+    "plugins": [
+      "@oclif/plugin-autocomplete",
+      "@oclif/plugin-help",
+      "@oclif/plugin-not-found",
+      "@oclif/plugin-version",
+      "@oclif/plugin-warn-if-update-available"
+    ],
+    "topicSeparator": " ",
+    "topics": {},
+    "warn-if-update-available": {
+      "timeoutInDays": 1,
+      "frequency": 1,
+      "message": "Update available from <%= chalk.greenBright(config.version) %> to <%= chalk.greenBright(latest) %>. Use 'npm install -g <%= config.name %>' to update."
+    }
+  },
+  "scripts": {
+    "build": "shx rm -rf dist && tsc -b",
+    "lint": "eslint",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "posttest": "npm run lint",
+    "prepack": "oclif manifest && oclif readme",
+    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
+    "test-with-coverage": "nyc --reporter=lcov --reporter=text-lcov mocha --forbid-only \"test/**/*.test.ts\"",
+    "version": "oclif readme && git add README.md"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "types": "dist/index.d.ts",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "overrides": {
+    "node-domexception": "file:.npm-overrides/node-domexception"
+  }
+}