dsmt 0.2.1 → 0.3.1

package/README.md

@@ -1,25 +1,62 @@
-# 🐳 Docker Storage Migration Tool 📦
+# DSMT
 
-`dsmt` is a command-line utility for seamlessly exporting and importing Docker volumes and bind mounts.
+[![NPM Version](https://img.shields.io/npm/v/dsmt.svg?label=version&logo=semver)](https://www.npmjs.com/package/dsmt)
+[![NPM Downloads](https://img.shields.io/npm/dm/dsmt.svg?logo=npm)](https://www.npmjs.com/package/dsmt)
+[![License](https://img.shields.io/github/license/itskdhere/dsmt.svg?logo=github)](https://github.com/itskdhere/dsmt/blob/main/LICENSE)
+[![Build Status](https://github.com/itskdhere/dsmt/actions/workflows/ci.yml/badge.svg)](https://github.com/itskdhere/dsmt/actions/workflows/ci.yml)
 
-## 🔍 Overview
+**Docker Storage Migration Tool (DSMT)** is a command-line utility for seamlessly exporting and importing Docker volumes and bind mounts.
 
-DSMT (Docker Storage Migration Tool) provides a simple way to:
+## Overview
 
-- 📤 Export Docker volumes or bind mounts to compressed tarballs.
-- 📥 Import compressed tarballs into Docker volumes or bind mounts.
+DSMT provides a simple way to:
 
-🔄 This tool makes it easy to backup, restore, or migrate Docker storage across systems.
+- Export Docker volumes or bind mounts to compressed tarballs.
+- Import compressed tarballs into Docker volumes or bind mounts.
 
-## 💻 Installation
+This tool makes it easy to backup, restore, or migrate Docker storage across systems.
+
+## Installation
+
+### Global Installation
+
+Choose your preferred package manager to install the CLI globally:
 
 ```bash
+# npm
 npm install -g dsmt
+
+# yarn
+yarn global add dsmt
+
+# pnpm
+pnpm add -g dsmt
+
+# bun
+bun add -g dsmt
 ```
 
-## 🚀 Usage
+### Run Directly
 
-### 📤 Exporting Docker Storage
+Or run directly without manual installation using:
+
+```bash
+# npx (npm)
+npx dsmt <command> [args]
+
+# bunx (bun)
+bunx dsmt <command> [args]
+
+# pnpm dlx
+pnpm dlx dsmt <command> [args]
+
+# yarn dlx
+yarn dlx dsmt <command> [args]
+```
+
+## Usage
+
+### Exporting Docker Storage
 
 Export a Docker volume:
 
@@ -33,7 +70,7 @@ Export a bind mount:
 dsmt export /path/to/bind/mount /path/to/export/directory
 ```
 
-### 📥 Importing Docker Storage
+### Importing Docker Storage
 
 Import to a Docker volume:
 
@@ -47,7 +84,7 @@ Import to a bind mount:
 dsmt import /path/to/tarball.tar.gz /path/to/bind/mount
 ```
 
-## ⚙️ Options
+## Options
 
 Both commands support the following options:
 
@@ -56,7 +93,7 @@ Both commands support the following options:
 
 The tool will automatically detect the source/destination type in most cases, but you can use these flags to be explicit.
 
-## 📋 Examples
+## Examples
 
 ```bash
 # Export a volume named 'mongodb_data' to the current directory
@@ -72,14 +109,19 @@ dsmt export /var/www/html /backups
 dsmt import ./html.tar.gz /var/www/html
 ```
 
-## 🛠️ Contribution
+## Contribution
 
 Please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines on contributing to this project.
 
-## 🔒 Security
+## Security
 
 Please refer to the [SECURITY.md](SECURITY.md) file for security-related issues and reporting.
 
-## 📄 License
+## License
 
 MIT © [itskdhere](https://github.com/itskdhere)
+
+<br>
+<p align="center">
+  <a href="https://youtu.be/dQw4w9WgXcQ">🐳</a>
+</p>

package/dist/cli.js

@@ -6,7 +6,7 @@ const program = new Command();
 program
     .name("dsmt")
     .description("Docker Storage Migration Tool")
-    .version("0.2.1");
+    .version("0.3.1");
 program
     .command("export")
     .argument("<src>", "volume name or bind mount path")

package/package.json

@@ -1,25 +1,33 @@
 {
   "name": "dsmt",
-  "version": "0.2.1",
+  "version": "0.3.1",
   "description": "Docker Storage Migration Tool",
   "type": "module",
   "bin": {
     "dsmt": "dist/cli.js"
   },
   "scripts": {
-    "dev": "tsc -w",
+    "dev": "tsc --watch --preserveWatchOutput",
     "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",
+  "author": "itskdhere",
+  "license": "MIT",
+  "keywords": [
+    "dsmt",
+    "cli",
+    "docker",
+    "storage",
+    "migration",
+    "tool"
+  ],
   "dependencies": {
     "axios": "^1.8.4",
     "chalk": "^5.4.1",
@@ -27,6 +35,7 @@
     "ora": "^8.2.0"
   },
   "devDependencies": {
+    "@dsmt/tsconfig": "workspace:*",
     "@types/node": "^22.14.1",
     "typescript": "^5.8.3"
   }

package/CONTRIBUTING.md

@@ -1,99 +0,0 @@
-# Contributing to Docker Storage Migration Tool (DSMT)
-
-Thank you for considering contributing to DSMT! This document provides guidelines and instructions to help you contribute effectively.
-
-## Code of Conduct
-
-This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code.
-
-## How Can I Contribute?
-
-### Reporting Bugs
-
-Before submitting a bug report:
-
-- Check the [issue tracker](https://github.com/itskdhere/dsmt/issues) to see if the issue has already been reported
-- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/itskdhere/dsmt/issues/new?template=bug_report.md)
-
-When filing a bug report, please include:
-
-- A clear and descriptive title
-- Steps to reproduce the issue
-- Expected and actual behavior
-- System information (OS, Docker version, Node.js version)
-- Any relevant logs or error messages
-
-### Suggesting Features
-
-We welcome feature suggestions! [Open an issue](https://github.com/itskdhere/dsmt/issues/new?template=feature_request.md) with your idea, providing as much context and detail as possible.
-
-### Pull Requests
-
-1. Fork the repository
-2. Create a new branch for your feature or bugfix
-3. Make your changes
-4. Ensure your code follows the project style and passes all tests
-5. Submit a pull request
-
-## Development Setup
-
-```bash
-# Clone your fork of the repo
-git clone https://github.com/YOUR-USERNAME/dsmt.git
-cd dsmt
-
-# Install dependencies
-npm install
-
-# Start development mode (watches for changes)
-npm run dev
-
-# Link the package globally for testing
-npm link
-```
-
-## Project Structure
-
-- cli.ts - CLI entry point
-- cmd - Command implementations
-- docker - Docker API wrapper
-- types - TypeScript type definitions
-
-## Coding Guidelines
-
-- Use TypeScript for all new code
-- Follow existing code style (2 spaces for indentation)
-- Add appropriate error handling and logging
-- Document new functions and methods
-
-## Commit Messages
-
-- Use the present tense ("Add feature" not "Added feature")
-- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
-- Limit the first line to 72 characters
-- Reference issues and pull requests liberally after the first line
-
-## Testing Your Changes
-
-Please ensure your changes work properly with:
-
-- Different types of Docker volumes
-- Bind mounts with various path structures
-- Different operating systems (if possible)
-
-## Submitting Changes
-
-1. Push your changes to your fork
-2. Submit a pull request to the main repository
-3. The title of your PR should clearly describe the change
-4. Link any relevant issues in the PR description
-
-## License
-
-By contributing to DSMT, you agree that your contributions will be licensed under the project's MIT License.
-
-## Questions?
-
-Feel free to open an issue if you have any questions about contributing.
-
-Thank you for contributing to DSMT!

package/SECURITY.md

@@ -1,12 +0,0 @@
-# Security Policy
-
-## Supported Versions
-
-| Version | Supported          |
-| ------- | ------------------ |
-| > 0.2.0 | :white_check_mark: |
-
-## Reporting a Vulnerability
-
-:octocat: https://github.com/itskdhere/dsmt/security/advisories/new  
-📧 [support@itskdhere.eu.org](mailto:support@itskdhere.eu.org)