@cloud-cli/dx 2.6.0 → 2.7.0

package/dist/index.d.ts

@@ -1,10 +1,12 @@
 import { getLogs, refreshContainer, restartContainer, startAll, updateAll, startContainer, stopAll, stopContainer, renameContainer, runContainer } from "./containers.js";
 import { prune, pull } from "./images.js";
-import { addContainer, getContainer, listContainers, removeContainer, updateContainer } from "./store.js";
+import { addContainer, clone, getContainer, listContainers, removeContainer, updateContainer } from "./store.js";
+import { help } from "@cloud-cli/cli";
 export type { Config } from "./types.js";
 declare function ps(options?: {
     status?: boolean;
 }): Promise<string[]> | Promise<import("./types.js").NameAndStatus[]>;
+export { clone };
 declare const _default: {
     pull: typeof pull;
     prune: typeof prune;
@@ -24,5 +26,7 @@ declare const _default: {
     restart: typeof restartContainer;
     ps: typeof ps;
     logs: typeof getLogs;
+    clone: typeof clone;
+    [help]: () => string;
 };
 export default _default;

package/dist/index.js

@@ -1,12 +1,42 @@
 import { getAllContainers, getLogs, getRunningContainers, refreshContainer, restartContainer, startAll, updateAll, startContainer, stopAll, stopContainer, renameContainer, runContainer, } from "./containers.js";
 import { prune, pull } from "./images.js";
-import { addContainer, getContainer, listContainers, removeContainer, updateContainer, } from "./store.js";
+import { addContainer, clone, getContainer, listContainers, removeContainer, updateContainer } from "./store.js";
+import { help } from "@cloud-cli/cli";
 function ps(options = {}) {
     if (options.status) {
         return getAllContainers();
     }
     return getRunningContainers();
 }
+const helpFunction = () => {
+    const commands = {
+        pull: "--image <image> - Pull a Docker image",
+        prune: "- Remove unused Docker images",
+        add: "--name <name> --image <image> [--domain <domain>] [--port <port>] [--volumes <mounts>] [--worker] [--startArgs <json>] - Add a container entry",
+        clone: "--name <name> --newName <new-name> - Clone a container entry",
+        remove: "--name <name> - Remove a container entry",
+        rename: "--name <name> --newName <new-name> - Rename a container entry",
+        get: "--name <name> - Get a container entry",
+        list: "[--name <name>] [--image <image>] [--domain <domain>] [--port <port>] [--volumes <mounts>] - List/filter entries",
+        refresh: "--name <name> - Pull and restart a container",
+        update: "--name <name> [--image <image>] [--domain <domain>] [--port <port>] [--volumes <mounts>] [--worker] [--startArgs <json>] - Update container properties",
+        updateAll: "[--image <image>] - Refresh all matching containers",
+        startAll: "[--image <image>] - Start all matching containers",
+        start: "--name <name> [--worker] [--startArgs <json>] - Start a stored container",
+        run: "--name <name> [--startArgs <json>] - Start a container in worker mode",
+        stop: "--name <name> - Stop a container",
+        stopAll: "[--image <image>] - Stop all matching containers",
+        restart: "--name <name> - Restart a container",
+        ps: "[--status] - List running containers (include stored stopped containers with status)",
+        logs: "--name <name> [--lines <count>] - Read container logs",
+    };
+    const lines = ["Docker container management", "", "Commands:"];
+    for (const [name, desc] of Object.entries(commands)) {
+        lines.push(`  dx.${name} ${desc}`);
+    }
+    return lines.join("\n");
+};
+export { clone };
 export default {
     pull,
     prune,
@@ -26,4 +56,6 @@ export default {
     restart: restartContainer,
     ps: ps,
     logs: getLogs,
+    clone,
+    [help]: helpFunction,
 };

package/dist/store.d.ts

@@ -1,4 +1,5 @@
-import type { Container, ExtraOptions } from './types.js';
+import type { Container, ExtraOptions } from "./types.js";
+import { type ServerParams } from "@cloud-cli/cli";
 interface ContainerName extends ExtraOptions {
     name: string;
 }
@@ -17,5 +18,9 @@ export declare function getContainer(options: ContainerName): Container;
 export declare function updateContainer(options: Partial<ContainerUpdateOptions>): Container;
 export declare function rename(name: string, newName: string): Container;
 export declare function listContainers(options?: ContainerListOptions): Container[];
+export declare function clone(options: {
+    name: string;
+    newName: string;
+}, { run }: ServerParams): Promise<Container>;
 export declare function findContainer(name: string): Container;
 export {};

package/dist/store.js

@@ -1,16 +1,18 @@
-import { readTargetImage, readTargetName } from './utils.js';
-import { getStorage } from '@cloud-cli/cli';
-const { get, set, has, remove, getAll } = getStorage('dx');
+import { readTargetImage, readTargetName } from "./utils.js";
+import { getStorage } from "@cloud-cli/cli";
+const { get, set, has, remove, getAll } = getStorage("dx");
 export function addContainer(options) {
     readTargetName(options);
     readTargetImage(options);
     const { name, image } = options;
-    if (!name)
-        throw new Error('Name required');
-    if (!image)
-        throw new Error('Image required');
-    const volumes = options.volumes ? sanitiseVolumes(options.volumes) : '';
-    const { port = '', domain = '', worker = false, startArgs = '' } = options;
+    if (!name) {
+        throw new Error("Name required");
+    }
+    if (!image) {
+        throw new Error("Image required");
+    }
+    const volumes = options.volumes ? sanitiseVolumes(options.volumes) : "";
+    const { port = "", domain = "", worker = false, startArgs = "" } = options;
     const container = { name, image, volumes, port, domain, worker, startArgs };
     set(name, container);
     return container;
@@ -21,7 +23,7 @@ export function removeContainer(options) {
         remove(options.name);
         return true;
     }
-    throw new Error('Container not found: ' + options.name);
+    throw new Error("Container not found: " + options.name);
 }
 export function getContainer(options) {
     readTargetName(options);
@@ -30,10 +32,10 @@ export function getContainer(options) {
 const optionSplitter = /,\s*/;
 export function updateContainer(options) {
     readTargetName(options);
-    let { port, volumes, name, image, domain, startArgs, worker } = options;
+    const { port, volumes, name, image, domain, startArgs, worker } = options;
     const container = get(name);
     if (!container) {
-        throw new Error('Container not found');
+        throw new Error("Container not found");
     }
     if (port !== undefined) {
         container.port = port;
@@ -64,7 +66,7 @@ export function rename(name, newName) {
     return container;
 }
 export function listContainers(options = {}) {
-    const keys = ['name', 'image', 'domain', 'port', 'volumes'];
+    const keys = ["name", "image", "domain", "port", "volumes"];
     const list = getAll();
     const filtered = keys.reduce((list, key) => {
         if (options[key]) {
@@ -74,6 +76,26 @@ export function listContainers(options = {}) {
     }, list);
     return filtered.sort((a, b) => Number(a.name > b.name) || -1);
 }
+export async function clone(options, { run }) {
+    const { name, newName } = options;
+    if (!name || !newName) {
+        throw new Error("Name and new name required");
+    }
+    const container = get(name);
+    if (!container) {
+        throw new Error("Container not found: " + name);
+    }
+    const vars = (await run("env.show", { name }));
+    for (const varItem of vars) {
+        await run("env.set", { name: newName, key: varItem.key, value: varItem.value });
+    }
+    const cloned = {
+        ...container,
+        name: newName,
+    };
+    set(newName, cloned);
+    return cloned;
+}
 export function findContainer(name) {
     return get(name);
 }
@@ -83,5 +105,5 @@ function sanitiseVolumes(volumes) {
         .split(optionSplitter)
         .map((s) => s.trim())
         .filter((s) => volumeTester.test(s))
-        .join(',');
+        .join(",");
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloud-cli/dx",
-  "version": "2.6.0",
+  "version": "2.7.0",
   "description": "Docker container management",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -35,9 +35,9 @@
     "get-port": "^7.1.0"
   },
   "peerDependencies": {
-    "@cloud-cli/cli": "^2.0.0",
-    "@cloud-cli/env": "^1.0.0",
+    "@cloud-cli/cli": "^2.2.0",
     "@cloud-cli/dns": "^2.0.0",
+    "@cloud-cli/env": "^1.0.0",
     "@cloud-cli/px": "^4.0.0"
   }
 }