dsmt 0.1.0

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+kd@itskdhere.eu.org.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Krishnendu Das
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,91 @@
+# 🐳 Docker Storage Migration Tool (DSMT) 📦
+
+A command-line utility for seamlessly exporting and importing Docker volumes and bind mounts.
+
+## 🔍 Overview
+
+DSMT (Docker Storage Migration Tool) provides a simple way to:
+
+- 📤 Export Docker volumes or bind mounts to compressed tarballs.
+- 📥 Import compressed tarballs into Docker volumes or bind mounts.
+
+🔄 This tool makes it easy to backup, restore, or migrate Docker storage across systems.
+
+## 💻 Installation
+
+```bash
+npm install -g dsmt
+```
+
+## 🚀 Usage
+
+### 📤 Exporting Docker Storage
+
+Export a Docker volume:
+
+```bash
+dsmt export volume_name /path/to/export/directory
+```
+
+Export a bind mount:
+
+```bash
+dsmt export /path/to/bind/mount /path/to/export/directory
+```
+
+### 📥 Importing Docker Storage
+
+Import to a Docker volume:
+
+```bash
+dsmt import /path/to/tarball.tar.gz volume_name
+```
+
+Import to a bind mount:
+
+```bash
+dsmt import /path/to/tarball.tar.gz /path/to/bind/mount
+```
+
+## ⚙️ Options
+
+Both commands support the following options:
+
+- `-v, --volume`: Explicitly specify source/destination as a Docker volume
+- `-m, --mount`: Explicitly specify source/destination as a bind mount
+
+The tool will automatically detect the source/destination type in most cases, but you can use these flags to be explicit.
+
+## 📋 Examples
+
+```bash
+# Export a volume named 'mongodb_data' to the current directory
+dsmt export mongodb_data ./
+
+# Import a tarball to a new volume
+dsmt import ./mongodb_data.tar.gz new_mongodb_data
+
+# Export a bind mount to the /backups directory
+dsmt export /var/www/html /backups
+
+# Import a tarball to a bind mount
+dsmt import ./html.tar.gz /var/www/html
+```
+
+## 🛠️ Development
+
+```bash
+# Clone the repository
+git clone https://github.com/itskdhere/dsmt.git
+cd dsmt
+
+# Install dependencies
+npm install
+
+# Run the development build
+npm run dev
+```
+
+## 📄 License
+
+MIT © [itskdhere](https://github.com/itskdhere)

package/dist/cli.js

@@ -0,0 +1,26 @@
+#! /usr/bin/env node
+import exportCmd from "./cmd/export.js";
+import importCmd from "./cmd/import.js";
+import { Command } from "commander";
+const program = new Command();
+program
+    .name("dsmt")
+    .description("Docker Storage Migration Tool")
+    .version("0.1.0");
+program
+    .command("export")
+    .argument("<src>", "volume name or bind mount path")
+    .argument("<dst>", "path to export to")
+    .option("-v, --volume", "Volume")
+    .option("-m, --mount", "Mount")
+    .description("Export a Docker Volume or Bind Mount to a Tarball")
+    .action(async (src, dst, options) => await exportCmd(src, dst, options));
+program
+    .command("import")
+    .argument("<src>", "path to import from")
+    .argument("<dst>", "volume name or bind mount path")
+    .option("-v, --volume", "Volume")
+    .option("-m, --mount", "Mount")
+    .description("Import a Docker Volume or Bind Mount from a Tarball")
+    .action(async (src, dst, options) => await importCmd(src, dst, options));
+program.parse(process.argv);

package/dist/cmd/export.js

@@ -0,0 +1,69 @@
+import docker from "../lib/docker/sdk.js";
+import chalk from "chalk";
+import ora from "ora";
+import path from "path";
+import { ensureAbsolutePath } from "../lib/etc/utils.js";
+export default async function exportCmd(src, dst, options) {
+    if (options.volume && options.mount) {
+        console.error(chalk.red("Cannot use both --volume and --mount options at the same time."));
+        process.exit(1);
+    }
+    if (!options.volume && !options.mount) {
+        if (src.startsWith("/") || src.startsWith("./") || src.startsWith("../")) {
+            options.mount = true;
+            console.log(chalk.blue(`Auto-detected bind mount path: ${src}`));
+        }
+        else {
+            options.volume = true;
+            console.log(chalk.blue(`Auto-detected volume name: ${src}`));
+        }
+    }
+    if (options.volume) {
+        await exportVolume(src, dst, options);
+    }
+    else if (options.mount) {
+        await exportMount(src, dst, options);
+    }
+}
+async function exportMount(src, dst, options) {
+    const spinner = ora("Preparing to export Docker bind mount...").start();
+    try {
+        const srcPath = ensureAbsolutePath(src);
+        const dstPath = ensureAbsolutePath(dst);
+        const name = path.basename(srcPath);
+        spinner.text = `Exporting bind mount from ${chalk.blue(srcPath)} to ${chalk.green(dst)}`;
+        await docker.run({
+            name: name,
+            src: srcPath,
+            dst: dstPath,
+            cmd: ["tar", "czf", `/dst/${name}.tar.gz`, "-C", "/src", "."],
+            options,
+        });
+        spinner.succeed(`Successfully exported bind mount to ${chalk.green(dstPath)}`);
+    }
+    catch (error) {
+        spinner.fail(`Failed to export bind mount: ${error.message}`);
+        process.exit(1);
+    }
+}
+async function exportVolume(src, dst, options) {
+    const spinner = ora("Preparing to export Docker volume...").start();
+    try {
+        const volumeName = src;
+        const dstPath = ensureAbsolutePath(dst);
+        const name = path.basename(src);
+        spinner.text = `Exporting volume ${chalk.blue(src)} to ${chalk.green(dstPath)}`;
+        await docker.run({
+            name: name,
+            src: volumeName,
+            dst: dstPath,
+            cmd: ["tar", "czf", `/dst/${name}.tar.gz`, "-C", "/src", "."],
+            options,
+        });
+        spinner.succeed(`Successfully exported volume to ${chalk.green(dstPath)}`);
+    }
+    catch (error) {
+        spinner.fail(`Failed to export volume: ${error.message}`);
+        process.exit(1);
+    }
+}

package/dist/cmd/import.js

@@ -0,0 +1,76 @@
+import docker from "../lib/docker/sdk.js";
+import chalk from "chalk";
+import ora from "ora";
+import path from "path";
+import fs from "fs";
+import { ensureAbsolutePath } from "../lib/etc/utils.js";
+export default async function importCmd(src, dst, options) {
+    if (options.volume && options.mount) {
+        console.error(chalk.red("Cannot use both --volume and --mount options at the same time."));
+        process.exit(1);
+    }
+    if (!options.volume && !options.mount) {
+        if (dst.startsWith("/") || dst.startsWith("./") || dst.startsWith("../")) {
+            options.mount = true;
+            console.log(chalk.blue(`Auto-detected bind mount path: ${dst}`));
+        }
+        else {
+            options.volume = true;
+            console.log(chalk.blue(`Auto-detected volume name: ${dst}`));
+        }
+    }
+    if (options.volume) {
+        await importVolume(src, dst, options);
+    }
+    else if (options.mount) {
+        await importMount(src, dst, options);
+    }
+}
+async function importMount(src, dst, options) {
+    const spinner = ora("Preparing to import to Docker bind mount...").start();
+    try {
+        const srcPath = ensureAbsolutePath(src);
+        const dstPath = ensureAbsolutePath(dst);
+        if (!fs.existsSync(srcPath)) {
+            throw new Error(`Source file ${srcPath} does not exist`);
+        }
+        const name = path.basename(srcPath);
+        spinner.text = `Importing from ${chalk.blue(srcPath)} to bind mount ${chalk.green(dstPath)}`;
+        await docker.run({
+            name: name,
+            src: srcPath,
+            dst: dstPath,
+            cmd: ["tar", "xzf", `/src/${name}`, "-C", "/dst"],
+            options,
+        });
+        spinner.succeed(`Successfully imported to bind mount at ${chalk.green(dstPath)}`);
+    }
+    catch (error) {
+        spinner.fail(`Failed to import to bind mount: ${error.message}`);
+        process.exit(1);
+    }
+}
+async function importVolume(src, dst, options) {
+    const spinner = ora("Preparing to import to Docker volume...").start();
+    try {
+        const srcPath = ensureAbsolutePath(src);
+        const volumeName = dst;
+        if (!fs.existsSync(srcPath)) {
+            throw new Error(`Source file ${srcPath} does not exist`);
+        }
+        const name = path.basename(srcPath);
+        spinner.text = `Importing from ${chalk.blue(srcPath)} to volume ${chalk.green(volumeName)}`;
+        await docker.run({
+            name: name,
+            src: srcPath,
+            dst: volumeName,
+            cmd: ["tar", "xzf", `/src/${name}`, "-C", "/dst"],
+            options,
+        });
+        spinner.succeed(`Successfully imported to volume ${chalk.green(volumeName)}`);
+    }
+    catch (error) {
+        spinner.fail(`Failed to import to volume: ${error.message}`);
+        process.exit(1);
+    }
+}

package/dist/lib/docker/container.js

@@ -0,0 +1,71 @@
+import axios from "axios";
+export async function containerCreate({ name, src, dst, cmd, image, }) {
+    const binds = [`${src}:/src`, `${dst}:/dst`];
+    try {
+        const createResponse = await axios({
+            method: "POST",
+            socketPath: "/var/run/docker.sock",
+            url: `http://localhost/containers/create`,
+            data: {
+                Image: image,
+                Tty: false,
+                Cmd: cmd,
+                HostConfig: {
+                    AutoRemove: true,
+                    Binds: binds,
+                },
+            },
+        });
+        if (!createResponse.data || !createResponse.data.Id) {
+            throw new Error("Failed to create container: Invalid response from Docker API");
+        }
+        return createResponse.data.Id;
+    }
+    catch (error) {
+        console.error("Failed to create Docker container:", error);
+        throw error;
+    }
+}
+export async function containerStart(containerId) {
+    try {
+        await axios({
+            method: "POST",
+            socketPath: "/var/run/docker.sock",
+            url: `http://localhost/containers/${containerId}/start`,
+        });
+    }
+    catch (error) {
+        console.error(`Failed to start Docker container ${containerId}:`, error);
+        await containerRemove(containerId).catch((removeError) => console.error(`Failed to remove container ${containerId} after start failure:`, removeError));
+        throw error;
+    }
+}
+export async function containerWait(containerId) {
+    try {
+        const response = await axios({
+            method: "POST",
+            socketPath: "/var/run/docker.sock",
+            url: `http://localhost/containers/${containerId}/wait`,
+        });
+        if (response.data.StatusCode !== 0) {
+            throw new Error(`Container ${containerId} exited with status code ${response.data.StatusCode}`);
+        }
+        return response.data.StatusCode;
+    }
+    catch (error) {
+        console.error(`Failed to wait for Docker container ${containerId}:`, error);
+        throw error;
+    }
+}
+export async function containerRemove(containerId) {
+    try {
+        await axios({
+            method: "DELETE",
+            socketPath: "/var/run/docker.sock",
+            url: `http://localhost/containers/${containerId}`,
+        });
+    }
+    catch (error) {
+        console.warn(`Failed to remove Docker container ${containerId}:`, error);
+    }
+}

package/dist/lib/docker/image.js

@@ -0,0 +1,32 @@
+import axios from "axios";
+export async function imageList() {
+    try {
+        const response = await axios({
+            method: "GET",
+            socketPath: "/var/run/docker.sock",
+            url: `http://localhost/images/json`,
+        });
+        return response.data
+            .map((image) => image.RepoTags)
+            .filter((tags) => tags)
+            .flat();
+    }
+    catch (error) {
+        console.error("Failed to list Docker images:", error);
+        throw error;
+    }
+}
+export async function imagePull(image) {
+    try {
+        const response = await axios({
+            method: "POST",
+            socketPath: "/var/run/docker.sock",
+            url: `http://localhost/images/create?fromImage=${image}`,
+        });
+        return response.data;
+    }
+    catch (error) {
+        console.error(`Failed to pull Docker image ${image}:`, error);
+        throw error;
+    }
+}

package/dist/lib/docker/sdk.js

@@ -0,0 +1,23 @@
+const image = "busybox:latest";
+import { containerCreate, containerStart, containerWait, containerRemove, } from "./container.js";
+import { imageList, imagePull } from "./image.js";
+export async function run({ name, src, dst, cmd }) {
+    const localImages = await imageList();
+    const isImageFound = localImages.some((localImage) => localImage === image);
+    if (!isImageFound) {
+        await imagePull(image);
+    }
+    const containerId = await containerCreate({ name, src, dst, cmd, image });
+    await containerStart(containerId);
+    await containerWait(containerId);
+}
+const docker = {
+    run,
+    containerCreate,
+    containerStart,
+    containerWait,
+    containerRemove,
+    imageList,
+    imagePull,
+};
+export default docker;

package/dist/lib/etc/utils.js

@@ -0,0 +1,4 @@
+import path from "path";
+export function ensureAbsolutePath(p) {
+    return path.isAbsolute(p) ? p : path.resolve(process.cwd(), p);
+}

package/dist/types/docker.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "dsmt",
+  "version": "0.1.0",
+  "description": "Docker Storage Migration Tool",
+  "type": "module",
+  "bin": {
+    "dsmt": "./dist/cli.js"
+  },
+  "scripts": {
+    "dev": "tsc -w",
+    "build": "tsc"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/itskdhere/dsmt.git"
+  },
+  "author": "itskdhere",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/itskdhere/dsmt/issues"
+  },
+  "homepage": "https://github.com/itskdhere/dsmt#readme",
+  "dependencies": {
+    "axios": "^1.8.4",
+    "chalk": "^5.4.1",
+    "commander": "^13.1.0",
+    "ora": "^8.2.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.14.1",
+    "typescript": "^5.8.3"
+  }
+}