File-plz NPM | npm.io

📂 File Please

A simple command-line tool to generate files of various types and specific sizes.

🚀 Features

📁 Create files of common types (e.g., .txt, .zip, .jpg, etc.)
📏 Specify exact file size (e.g., 10KB, 5MB, 1GB, etc.)
⚡ Fast and lightweight utility

📋 Prerequisites

Node.js v22.12 (LTS)

🔧 Installation

Install globally using npm:

npm install file-plz -g

📘 Usage

Basic usage:

npx file-plz -t txt -s 10KB

Options: | Option | Shorthan | Description | Example | |----------------|----------------|-------------------------------------|-------------------| | --size | -s | Size of the file (KB, MB, or GB) | 10KB, 5MB | | --type | -t | File extension | jpg, txt | | --debug | -d | Output debug info | - |

📦 Examples

Create a 1MB text file
```
npx file-plz -t txt -s 1MB
```

Create a 500KB bitmap file

npx file-plz -t txt --size 500KB --t .bmp

Create a 1GB archive file
```
npx file-plz -t zip -size 1GB
```

🛠️ How It Works

File Generation: The program has a base set of instructions to create simple files, which are then merged with more complex file types to achieve the specific file size.
File Content: The data within the files is random characters or generated noise.

⚠️ Challenges with File Size Accuracy

Achieving precise file sizes can be challenging, especially when working with compression and noise. For compressed file types (like .zip), the final size depends on the compressibility of the file's contents. Random data is less compressible than repeating patterns, which can affect the actual size. Similarly, files with "noise" data may not be perfectly predictable in size, as different file systems and tools may handle binary data differently. This tool strives to get as close as possible to the requested size, but minor deviations may occur.