@quantum-hub/qhubctl 1.3.0 → 1.4.1

package/dist/commands/init.js

@@ -3,10 +3,11 @@ import fs from 'fs-extra';
 import path from 'node:path';
 import { DEFAULT_STARTER, promptUserInput } from '../lib/init-user-input.js';
 import { randomName } from '../lib/random-name.js';
-import { downloadRepository, extractStarter } from '../lib/repository.js';
+import { cloneRepository, downloadRepository, extractStarter } from '../lib/repository.js';
 import { error, stdout } from '../lib/output.js';
 import { Runtime } from '../model/managed-service-config.js';
 import { writeServiceConfig } from '../service/service-config-service.js';
+import { getUserConfig } from '../model/command.js';
 const EXAMPLES = `
 Examples:
   $ qhubctl init`;
@@ -51,9 +52,18 @@ export const initCommand = new Command('init')
     }
     writeServiceConfig(targetDirectory, serviceConfig);
     if (input.starter) {
-        const zip = await downloadRepository(input.starter.url);
-        const starterName = path.basename(input.starter.url, '.zip');
-        extractStarter(zip, starterName, targetDirectory);
+        if (input.starter.requiresAuth) {
+            const userConfig = getUserConfig();
+            if (!userConfig.auth?.value) {
+                error('This starter template requires authentication. Use the "login" command to log in first.');
+            }
+            await cloneRepository(input.starter.url, targetDirectory, userConfig.auth.value);
+        }
+        else {
+            const zip = await downloadRepository(input.starter.url);
+            const starterName = path.basename(input.starter.url, '.zip');
+            extractStarter(zip, starterName, targetDirectory);
+        }
     }
     stdout('\u{1F389} Initialized project. Happy hacking!');
     if (input.starter) {

package/dist/commands/services-list.d.ts

@@ -0,0 +1,2 @@
+import { Command } from 'commander';
+export declare const servicesListCommand: Command;

package/dist/commands/{services.js → services-list.js}

@@ -5,12 +5,12 @@ import { requireAuth } from '../model/command.js';
 import QuantumHubService from '../service/quantum-hub-service.js';
 const EXAMPLES = `
 Examples:
-  $ qhubctl services
-  $ qhubctl services --json
-  $ qhubctl services --name "my-service"
-  $ qhubctl services --name "my-service" --json
-  $ qhubctl services --json --all`;
-export const servicesCommand = new Command('services')
+  $ qhubctl services list
+  $ qhubctl services list --json
+  $ qhubctl services list --name "my-service"
+  $ qhubctl services list --name "my-service" --json
+  $ qhubctl services list --json --all`;
+export const servicesListCommand = new Command('list')
     .description('List all services of the current context.')
     .option('--json', 'Output in JSON format', false)
     .option('--name <value>', 'Filter services by name (case-insensitive full match)')

package/dist/lib/init-user-input.d.ts

@@ -2,6 +2,7 @@ import { GpuType, Runtime } from '../model/managed-service-config.js';
 export interface StarterInput {
     url: string;
     runtime: Runtime;
+    requiresAuth?: boolean;
 }
 export interface UserInput {
     cpu: number;
@@ -11,8 +12,5 @@ export interface UserInput {
     name: string;
     starter?: StarterInput;
 }
-export declare const DEFAULT_STARTER: {
-    url: string;
-    runtime: Runtime;
-};
+export declare const DEFAULT_STARTER: StarterInput;
 export declare const promptUserInput: (defaultName: string) => Promise<UserInput>;

package/dist/lib/init-user-input.js

@@ -2,7 +2,7 @@ import { input, select, number } from '@inquirer/prompts';
 import { GpuType, Runtime } from '../model/managed-service-config.js';
 export const DEFAULT_STARTER = {
     url: 'https://gitlab.com/planqk-foss/planqk-starter-python/-/archive/main/planqk-starter-python-main.zip',
-    runtime: Runtime.PYTHON_TEMPLATE
+    runtime: Runtime.PYTHON_TEMPLATE,
 };
 export const promptUserInput = async (defaultName) => {
     const name = await input({
@@ -19,15 +19,17 @@ export const promptUserInput = async (defaultName) => {
             {
                 name: 'Docker Starter (setup for experienced users)',
                 value: {
-                    url: 'https://gitlab.com/planqk-foss/planqk-starter-docker/-/archive/main/planqk-starter-docker-main.zip',
-                    runtime: Runtime.DOCKER
+                    url: 'https://repository.hub.kipu-quantum.com/cec4a31d-5856-4387-b4cf-718345803558/qhub-starter-docker.git',
+                    runtime: Runtime.DOCKER,
+                    requiresAuth: true,
                 },
             },
             {
                 name: 'NVIDIA CUDA-Q Starter (for GPU accelerated applications; setup for experienced users)',
                 value: {
-                    url: 'https://gitlab.com/planqk-foss/planqk-starter-gpu/-/archive/main/planqk-starter-gpu-main.zip',
-                    runtime: Runtime.DOCKER
+                    url: 'https://repository.hub.kipu-quantum.com/cec4a31d-5856-4387-b4cf-718345803558/qhub-starter-gpu.git',
+                    runtime: Runtime.DOCKER,
+                    requiresAuth: true,
                 },
             },
             { name: 'None (creates "qhub.json" in current directory)', value: undefined },
@@ -61,7 +63,7 @@ export const promptUserInput = async (defaultName) => {
         },
     });
     let gpu = undefined;
-    if (!starter || starter.url.includes('planqk-starter-gpu')) {
+    if (!starter || starter.url.includes('qhub-starter-gpu')) {
         gpu = await select({
             message: 'Choose your GPU configuration',
             choices: [

package/dist/lib/repository.d.ts

@@ -1,3 +1,11 @@
 import AdmZip from 'adm-zip';
-export declare const downloadRepository: (url: string) => Promise<AdmZip>;
+export declare const downloadRepository: (url: string, apiKey?: string) => Promise<AdmZip>;
+/**
+ * Clones a git repository (shallow, depth=1) into targetDirectory and removes
+ * the .git metadata afterwards, leaving only the working-tree files.
+ *
+ * Authentication uses HTTP Basic Auth with username "planqk" and the provided
+ * API key as the password.
+ */
+export declare const cloneRepository: (url: string, targetDirectory: string, apiKey: string) => Promise<void>;
 export declare const extractStarter: (zip: AdmZip, starterName: string, targetDirectory: string) => void;

package/dist/lib/repository.js

@@ -1,13 +1,23 @@
 import AdmZip from 'adm-zip';
+import fs from 'fs-extra';
+import git from 'isomorphic-git';
+import http from 'isomorphic-git/http/node';
+import nodeFs from 'node:fs';
 import { debugEnabled } from './debug.js';
 import { fetchOrThrow, PlatformError } from './fetch.js';
-export const downloadRepository = async (url) => {
+export const downloadRepository = async (url, apiKey) => {
+    const headers = {};
+    if (apiKey) {
+        // Use HTTP Basic Auth: username "planqk", password is the API key
+        const credentials = Buffer.from(`qhubctl:${apiKey}`).toString('base64');
+        headers['Authorization'] = `Basic ${credentials}`;
+    }
     const config = {
         cache: 'no-cache',
         method: 'GET',
         mode: 'same-origin',
         referrerPolicy: 'no-referrer',
-        responseType: 'arraybuffer',
+        headers,
     };
     let zip;
     try {
@@ -27,6 +37,35 @@ export const downloadRepository = async (url) => {
     }
     return zip;
 };
+/**
+ * Clones a git repository (shallow, depth=1) into targetDirectory and removes
+ * the .git metadata afterwards, leaving only the working-tree files.
+ *
+ * Authentication uses HTTP Basic Auth with username "planqk" and the provided
+ * API key as the password.
+ */
+export const cloneRepository = async (url, targetDirectory, apiKey) => {
+    const credentials = Buffer.from(`qhubctl:${apiKey}`).toString('base64');
+    try {
+        await git.clone({
+            fs: nodeFs,
+            http,
+            dir: targetDirectory,
+            url,
+            depth: 1,
+            singleBranch: true,
+            // Inject Authorization on every request so the proxy doesn't need to
+            // issue a 401 challenge first (onAuth is only triggered after a 401).
+            headers: { 'Authorization': `Basic ${credentials}` },
+        });
+    }
+    catch (error) {
+        console.error(error);
+        throw new Error('Failed to download starter template. Make sure you are logged in and try again.');
+    }
+    // Remove git metadata so the project directory is a clean working tree
+    await fs.remove(`${targetDirectory}/.git`);
+};
 export const extractStarter = (zip, starterName, targetDirectory) => {
     const templateFolder = `${starterName}/`;
     for (const entry of zip.getEntries()) {

package/dist/program.js

@@ -11,7 +11,7 @@ import { logoutCommand } from './commands/logout.js';
 import { openapiCommand } from './commands/openapi.js';
 import { runCommand } from './commands/run.js';
 import { serveCommand } from './commands/serve.js';
-import { servicesCommand } from './commands/services.js';
+import { servicesListCommand } from './commands/services-list.js';
 import { setContextCommand } from './commands/set-context.js';
 import { upCommand } from './commands/up.js';
 const require = createRequire(import.meta.url);
@@ -32,6 +32,9 @@ program.addCommand(logoutCommand);
 program.addCommand(openapiCommand);
 program.addCommand(runCommand);
 program.addCommand(serveCommand);
+// Nested: services <subcommand>
+const servicesCommand = new Command('services').description('Manage services');
+servicesCommand.addCommand(servicesListCommand);
 program.addCommand(servicesCommand);
 program.addCommand(setContextCommand);
 program.addCommand(upCommand);
@@ -41,7 +44,7 @@ datapoolCommand.addCommand(datapoolUploadCommand);
 program.addCommand(datapoolCommand);
 // Surface a clear error for unknown commands instead of silently doing nothing
 program.on('command:*', (operands) => {
-    process.stderr.write(`\n  error: unknown command '${operands[0]}'\n\n`);
-    process.stderr.write(`  Run 'qhubctl --help' to see available commands.\n\n`);
+    process.stderr.write(`\n  Error: Unknown command '${operands[0]}'\n\n`);
+    process.stderr.write(`  Run 'qhubctl help' to see available commands.\n\n`);
     process.exit(1);
 });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@quantum-hub/qhubctl",
-  "version": "1.3.0",
-  "description": "Quantum Hub CLI",
+  "version": "1.4.1",
+  "description": "Kipu Quantum Hub CLI",
   "author": "Kipu Quantum GmbH",
   "contributors": [
     "Wurster, Michael <michael.wurster@kipu-quantum.com>",
@@ -32,6 +32,7 @@
     "commander": "^14",
     "fs-extra": "^11",
     "ignore": "^7",
+    "isomorphic-git": "^1.37.2",
     "ora": "^9",
     "tty-table": "^5",
     "update-notifier": "^7",

package/dist/commands/services.d.ts

@@ -1,2 +0,0 @@
-import { Command } from 'commander';
-export declare const servicesCommand: Command;