@quantum-hub/qhubctl 1.1.4 → 1.2.0

package/dist/commands/serve/index.d.ts

@@ -1,13 +1,11 @@
 import { AbstractCommand } from '../../model/command.js';
 export default class Serve extends AbstractCommand {
-    static CONTAINER_NAME: string;
-    static IMAGE: string;
     static description: string;
     static examples: string[];
     static flags: {
-        port: import("@oclif/core/interfaces").OptionFlag<number | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        log_level: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        port: import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
+        'log-level': import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        workspace: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };
     run(): Promise<void>;
-    private isProjectSupported;
 }

package/dist/commands/serve/index.js

@@ -1,87 +1,51 @@
 import { Flags, ux } from '@oclif/core';
-import fs from 'fs-extra';
-import Listr from 'listr';
-import path from "node:path";
-import terminalLink from 'terminal-link';
-import { executeAsyncCommand, executeCommand } from '../../lib/command.js';
-import { randomString } from '../../lib/random-string.js';
+import { spawnSync } from 'node:child_process';
 import { AbstractCommand } from '../../model/command.js';
-import { Runtime } from "../../model/managed-service-config.js";
-import { readServiceConfig } from "../../service/service-config-service.js";
 export default class Serve extends AbstractCommand {
-    static CONTAINER_NAME = 'planqk-cli-serve';
-    static IMAGE = 'registry.gitlab.com/planqk-foss/planqk-cli-serve:latest';
-    static 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.';
+    static description = 'Runs your project locally via qhub-serve inside the workspace virtual environment, ' +
+        'exposing the same HTTP endpoints as Kipu Quantum Hub (start execution, check status, ' +
+        'cancel, retrieve results).';
     static examples = [
         '$ qhubctl serve',
-        '$ qhubctl serve -p <port> --log_level <log_level>',
+        '$ qhubctl serve -p 8081',
+        '$ qhubctl serve --workspace /path/to/workspace',
     ];
     static flags = {
         port: Flags.integer({
             char: 'p',
             description: 'The port on which the local web server accepts requests',
             required: false,
+            default: 8081,
         }),
-        log_level: Flags.string({
-            description: 'The log level for the service, possible values: DEBUG, INFO, WARNING, ERROR, CRITICAL',
+        'log-level': Flags.string({
+            description: 'Log level for qhub-serve. Possible values: TRACE, DEBUG, INFO, SUCCESS, WARNING, ERROR, CRITICAL',
             required: false,
             default: 'INFO',
+            options: ['TRACE', 'DEBUG', 'INFO', 'SUCCESS', 'WARNING', 'ERROR', 'CRITICAL'],
+        }),
+        workspace: Flags.string({
+            char: 'w',
+            description: 'Path to the workspace directory (must be a valid uv project). Defaults to the current directory.',
+            required: false,
         }),
     };
     async run() {
         const { flags } = await this.parse(Serve);
-        const hostPort = flags.port ?? 8081;
-        const logLevel = flags.log_level ?? 'INFO';
-        if (!this.isProjectSupported()) {
-            this.error('Please make sure you have a "./src/program.py" file and "runtime" is set to "PYTHON_TEMPLATE" (qhub.json).');
+        const workspaceDir = flags.workspace ?? process.cwd();
+        const port = flags.port;
+        const logLevel = flags['log-level'];
+        // Step 1: Add (or upgrade) qhub-serve as a dev dependency
+        ux.stdout('Ensuring qhub-serve is up to date...');
+        const addResult = spawnSync('uv', ['add', '--dev', '--upgrade', 'qhub-serve', '--project', workspaceDir], { stdio: 'inherit' });
+        if (addResult.status !== 0) {
+            this.error('Failed to install qhub-serve via uv. ' +
+                'Make sure uv is installed and the workspace is a valid uv project.');
+        }
+        // Step 2: Run qhub-serve inside the workspace venv
+        ux.stdout('\nStarting qhub-serve...');
+        const runResult = spawnSync('uv', ['run', '--project', workspaceDir, 'qhub-serve', '--workspace', workspaceDir, '--port', String(port), '--log-level', logLevel], { stdio: 'inherit' });
+        if (runResult.status !== 0) {
+            this.error('qhub-serve exited with a non-zero status code.');
         }
-        const containerName = `${Serve.CONTAINER_NAME}-${randomString(10)}`;
-        const tasks = new Listr([
-            {
-                task: () => executeAsyncCommand(`docker pull ${Serve.IMAGE}`),
-                title: 'Ensuring latest base image',
-            },
-            {
-                task: () => executeAsyncCommand(`docker run -e LOG_LEVEL=${logLevel} -e PORT=${hostPort} -p ${hostPort}:${hostPort} -v "$(pwd):/workspace" --name ${containerName} ${Serve.IMAGE}`),
-                title: 'Building container',
-            },
-            {
-                task: () => Promise.resolve(),
-                title: 'Starting container',
-            },
-        ]);
-        ux.stdout('Starting service locally...');
-        tasks.run()
-            .then(() => {
-            const baseUrl = `http://localhost:${hostPort}`;
-            const docsUrl = `${baseUrl}/docs`;
-            ux.stdout('\nLocal service running at:');
-            ux.stdout(terminalLink(baseUrl, baseUrl));
-            ux.stdout('\nDocumentation and interactive API client available at:');
-            ux.stdout(terminalLink(docsUrl, docsUrl));
-            ux.stdout('');
-            try {
-                executeCommand(`docker start -i -a ${containerName}`);
-            }
-            catch {
-                this.error(`There might be problems with your dependencies. Don't forget to verify the requirements.txt file`);
-            }
-        })
-            .catch(error => this.error(error))
-            .finally(() => {
-            ux.stdout('\nStopping and removing container...');
-            executeCommand(`docker stop ${containerName} > /dev/null 2>&1`);
-            return executeAsyncCommand(`docker rm ${containerName} > /dev/null 2>&1`);
-        });
-    }
-    isProjectSupported() {
-        const programFile = path.join(process.cwd(), 'src', 'program.py');
-        const hasProgramFile = fs.existsSync(programFile);
-        const serviceConfig = readServiceConfig(process.cwd());
-        const isPythonTemplate = serviceConfig.runtime == Runtime.PYTHON_TEMPLATE;
-        return isPythonTemplate && hasProgramFile;
     }
 }

package/dist/commands/set-context/index.js

@@ -29,8 +29,7 @@ export default class SetContext extends AuthenticatedCommand {
     }
     async run() {
         const { args } = await this.parse(SetContext);
-        const { contextId } = args;
-        let selectedContext;
+        let { contextId } = args;
         if (!contextId) {
             ux.action.start('Loading available contexts');
         }
@@ -38,17 +37,15 @@ export default class SetContext extends AuthenticatedCommand {
         if (!contextId) {
             ux.action.stop('Done');
         }
-        if (contextId) {
-            selectedContext = accounts.find(account => account.id === contextId);
-        }
-        else {
+        if (!contextId) {
             const response = await select({
                 choices: this.getPromptOptions(accounts),
                 message: 'Choose a context',
                 default: accounts[0],
             });
-            selectedContext = accounts.find(account => account.id === response.id);
+            contextId = response.id;
         }
+        const selectedContext = accounts.find(account => account.id === contextId);
         if (!selectedContext) {
             this.error(`Context with id "${contextId}" not found.`);
         }

package/oclif.manifest.json

@@ -129,6 +129,29 @@
         "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": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "list-contexts",
+        "index.js"
+      ]
+    },
     "login": {
       "aliases": [],
       "args": {},
@@ -171,17 +194,17 @@
         "index.js"
       ]
     },
-    "list-contexts": {
+    "logout": {
       "aliases": [],
       "args": {},
-      "description": "Retrieves the available contexts, i.e., the personal or organizational accounts available to you to work with.",
+      "description": "Logout",
       "examples": [
-        "$ qhubctl list-contexts"
+        "$ qhubctl logout"
       ],
       "flags": {},
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "list-contexts",
+      "id": "logout",
       "pluginAlias": "@quantum-hub/qhubctl",
       "pluginName": "@quantum-hub/qhubctl",
       "pluginType": "core",
@@ -190,21 +213,57 @@
       "relativePath": [
         "dist",
         "commands",
-        "list-contexts",
+        "logout",
         "index.js"
       ]
     },
-    "logout": {
+    "run": {
       "aliases": [],
-      "args": {},
-      "description": "Logout",
+      "args": {
+        "serviceId": {
+          "name": "serviceId"
+        }
+      },
+      "description": "Creates a job execution",
       "examples": [
-        "$ qhubctl logout"
+        "$ 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": {},
+      "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": "logout",
+      "id": "run",
       "pluginAlias": "@quantum-hub/qhubctl",
       "pluginName": "@quantum-hub/qhubctl",
       "pluginType": "core",
@@ -213,7 +272,7 @@
       "relativePath": [
         "dist",
         "commands",
-        "logout",
+        "run",
         "index.js"
       ]
     },
@@ -296,72 +355,14 @@
         "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": true,
-      "relativePath": [
-        "dist",
-        "commands",
-        "run",
-        "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.",
+      "description": "Runs your project locally via qhub-serve inside the workspace virtual environment, exposing the same HTTP endpoints as Kipu Quantum Hub (start execution, check status, cancel, retrieve results).",
       "examples": [
         "$ qhubctl serve",
-        "$ qhubctl serve -p <port> --log_level <log_level>"
+        "$ qhubctl serve -p 8081",
+        "$ qhubctl serve --workspace /path/to/workspace"
       ],
       "flags": {
         "port": {
@@ -369,17 +370,36 @@
           "description": "The port on which the local web server accepts requests",
           "name": "port",
           "required": false,
+          "default": 8081,
           "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",
+        "log-level": {
+          "description": "Log level for qhub-serve. Possible values: TRACE, DEBUG, INFO, SUCCESS, WARNING, ERROR, CRITICAL",
+          "name": "log-level",
           "required": false,
           "default": "INFO",
           "hasDynamicHelp": false,
           "multiple": false,
+          "options": [
+            "TRACE",
+            "DEBUG",
+            "INFO",
+            "SUCCESS",
+            "WARNING",
+            "ERROR",
+            "CRITICAL"
+          ],
+          "type": "option"
+        },
+        "workspace": {
+          "char": "w",
+          "description": "Path to the workspace directory (must be a valid uv project). Defaults to the current directory.",
+          "name": "workspace",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
           "type": "option"
         }
       },
@@ -390,8 +410,6 @@
       "pluginName": "@quantum-hub/qhubctl",
       "pluginType": "core",
       "strict": true,
-      "CONTAINER_NAME": "planqk-cli-serve",
-      "IMAGE": "registry.gitlab.com/planqk-foss/planqk-cli-serve:latest",
       "isESM": true,
       "relativePath": [
         "dist",
@@ -526,5 +544,5 @@
       ]
     }
   },
-  "version": "1.1.4"
+  "version": "1.2.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quantum-hub/qhubctl",
-  "version": "1.1.4",
+  "version": "1.2.0",
   "description": "Quantum Hub CLI",
   "author": "Kipu Quantum GmbH",
   "contributors": [