@procoderx/pcx-copy 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ProCoderX
+
+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,374 @@
+# @procoderx/pcx-copy
+
+> A lightweight Node.js CLI utility for copying files from one location to another.
+
+[![npm version](https://img.shields.io/npm/v/@procoderx/pcx-copy.svg)](https://www.npmjs.com/package/@procoderx/pcx-copy)
+[![npm downloads](https://img.shields.io/npm/dm/@procoderx/pcx-copy.svg)](https://www.npmjs.com/package/@procoderx/pcx-copy)
+[![License](https://img.shields.io/npm/l/@procoderx/pcx-copy.svg)](https://www.npmjs.com/package/@procoderx/pcx-copy)
+
+---
+
+## Features
+
+- Copy files directly from the terminal
+- Supports relative and absolute file paths
+- Handles binary files using Node.js `Buffer`
+- Built with modern ES Modules
+- Provides CLI argument validation
+- Displays clear usage and error messages
+- Returns appropriate process exit codes
+- Supports global installation
+- Supports `npx` execution
+- Separates CLI handling from core file-copy logic
+
+---
+
+## Requirements
+
+- Node.js `18+`
+- npm `9+`
+
+Check installed versions:
+
+```bash
+node -v
+npm -v
+```
+
+---
+
+## Quick Start
+
+Run directly with `npx`:
+
+```bash
+npx @procoderx/pcx-copy ./source.txt ./destination.txt
+```
+
+Or install globally:
+
+```bash
+npm install -g @procoderx/pcx-copy
+```
+
+Then use:
+
+```bash
+pcx-copy ./source.txt ./destination.txt
+```
+
+---
+
+## Installation
+
+### Global Installation
+
+```bash
+npm install -g @procoderx/pcx-copy
+```
+
+The `pcx-copy` command is then available globally.
+
+Verify the installation:
+
+```bash
+pcx-copy
+```
+
+Output:
+
+```text
+Usage: pcx-copy <source-file> <destination-file>
+```
+
+### Local Installation
+
+```bash
+npm install @procoderx/pcx-copy
+```
+
+### Using npx
+
+```bash
+npx @procoderx/pcx-copy ./source.txt ./destination.txt
+```
+
+---
+
+## Usage
+
+### Syntax
+
+```bash
+pcx-copy <source-file> <destination-file>
+```
+
+| Argument             | Required | Description                                  |
+| -------------------- | -------- | -------------------------------------------- |
+| `<source-file>`      | Yes      | Path to the source file                      |
+| `<destination-file>` | Yes      | Path where the copied file should be created |
+
+---
+
+## Examples
+
+### Copy a File
+
+```bash
+pcx-copy ./money.png ./buffer.png
+```
+
+Output:
+
+```text
+Successfully copied "./money.png" to "./buffer.png"
+```
+
+### Copy to Another Directory
+
+```bash
+pcx-copy ./money.png ./backup/money.png
+```
+
+### Copy Using an Absolute Path
+
+```bash
+pcx-copy ./money.png /c/Users/user/Desktop/buffer.png
+```
+
+### Run with npx
+
+```bash
+npx @procoderx/pcx-copy ./money.png ./buffer.png
+```
+
+---
+
+## Supported Files
+
+The utility can copy regular files including:
+
+- Images
+- PDFs
+- ZIP files
+- Documents
+- Videos
+- Executables
+- Other binary files
+
+File contents are handled as raw data, so the utility is not limited to text files.
+
+---
+
+## How It Works
+
+The CLI separates command-line handling from the core file-copy operation.
+
+```text
+Terminal Command
+       ↓
+process.argv
+       ↓
+Argument Validation
+       ↓
+copyFile()
+       ↓
+readFile()
+       ↓
+Buffer
+       ↓
+writeFile()
+       ↓
+Destination File
+```
+
+The CLI:
+
+- Reads arguments using `process.argv`
+- Validates the source and destination paths
+- Reads the source file asynchronously
+- Handles the file contents as a `Buffer`
+- Writes the contents to the destination
+- Reports the result to the terminal
+
+---
+
+## Project Structure
+
+```text
+pcx-copy/
+│
+├── bin/
+│   └── pcx-copy.js
+│
+├── src/
+│   └── copyFile.js
+│
+├── package.json
+├── README.md
+└── LICENSE
+```
+
+### `bin/pcx-copy.js`
+
+The CLI entry point responsible for:
+
+- Reading command-line arguments
+- Validating input
+- Calling the copy function
+- Displaying CLI messages
+- Handling process exit codes
+
+### `src/copyFile.js`
+
+Contains the core file-copy logic responsible for:
+
+- Resolving paths
+- Reading the source file
+- Writing the destination file
+- Performing the copy operation
+
+---
+
+## npm CLI Configuration
+
+The package exposes the `pcx-copy` command through the `bin` field in `package.json`.
+
+```json
+{
+  "name": "@procoderx/pcx-copy",
+  "type": "module",
+  "bin": {
+    "pcx-copy": "./bin/pcx-copy.js"
+  }
+}
+```
+
+This creates the following relationship:
+
+```text
+pcx-copy
+    ↓
+bin/pcx-copy.js
+    ↓
+Node.js
+```
+
+The CLI entry file uses the Node.js shebang:
+
+```js
+#!/usr/bin/env node
+```
+
+This allows npm to execute the file directly as a terminal command.
+
+---
+
+## Core Implementation
+
+The file-copy operation uses Node.js `fs/promises`:
+
+```js
+const content = await readFile(sourcePath);
+
+await writeFile(destinationPath, content);
+```
+
+The file contents are handled as a `Buffer`, allowing the utility to copy both text and binary files.
+
+---
+
+## Error Handling
+
+If required arguments are missing:
+
+```bash
+pcx-copy
+```
+
+The CLI displays:
+
+```text
+Usage: pcx-copy <source-file> <destination-file>
+```
+
+File-system errors are reported to the terminal.
+
+Example:
+
+```text
+Failed to copy file: ENOENT: no such file or directory
+```
+
+Failed operations return a non-zero process exit code.
+
+---
+
+## Development
+
+Clone the repository:
+
+```bash
+git clone https://github.com/theprocoderx/pcx-copy.git
+```
+
+Navigate into the project:
+
+```bash
+cd pcx-copy
+```
+
+Install dependencies:
+
+```bash
+npm install
+```
+
+Link the package locally:
+
+```bash
+npm link
+```
+
+Test the CLI:
+
+```bash
+pcx-copy ./source.txt ./destination.txt
+```
+
+---
+
+## Future Improvements
+
+Possible future versions may include:
+
+- `--help`
+- `--version`
+- Overwrite confirmation
+- File-existence checks
+- Directory copying
+- Recursive copying
+- Multiple source files
+- Progress indicators
+- Improved error codes
+- Automated tests
+
+---
+
+## License
+
+This project is licensed under the **MIT License**.
+
+---
+
+## Author
+
+**ProCoderX (Magan Singh)**
+
+Building practical Node.js tools and developer-focused projects.
+
+- **Website:** https://procoderx.com
+- **GitHub:** https://github.com/theprocoderx
+- **LinkedIn:** https://www.linkedin.com/in/procoderx
+- **npm:** https://www.npmjs.com/~procoderx
+- **Email:** procoderxs@gmail.com

package/bin/pcx-copy.js

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+
+import { copyFile } from '../src/copyFile.js';
+
+const [, , source, destination] = process.argv;
+
+if (!source || !destination) {
+  console.error(
+    'Usage: pcx-copy <source-file> <destination-file>'
+  );
+  process.exit(1);
+}
+
+await copyFile(source, destination);

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@procoderx/pcx-copy",
+  "version": "1.0.0",
+  "description": "A lightweight Node.js CLI utility for copying files from one location to another.",
+  "type": "module",
+  "bin": {
+    "pcx-copy": "./bin/pcx-copy.js"
+  },
+  "files": [
+    "bin",
+    "src",
+    "README.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "copy",
+    "copy-file",
+    "file-copy",
+    "copy-cli",
+    "nodejs-cli",
+    "cli-tool"
+  ],
+  "author": {
+    "name": "ProCoderX (Magan Singh)",
+    "url": "https://procoderx.com"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">=18"
+  }
+}

package/src/copyFile.js

@@ -0,0 +1,20 @@
+import { readFile, writeFile } from 'node:fs/promises';
+import { resolve } from 'node:path';
+
+export async function copyFile(source, destination) {
+  try {
+    const sourcePath = resolve(source);
+    const destinationPath = resolve(destination);
+
+    const content = await readFile(sourcePath);
+
+    await writeFile(destinationPath, content);
+
+    console.log(
+      `Successfully copied "${source}" to "${destination}"`
+    );
+  } catch (error) {
+    console.error(`Failed to copy file: ${error.message}`);
+    process.exit(1);
+  }
+}