https://github.com/tuki0918/pixzle

[NPM] Image Fragmentation, Restoration, and Protection
https://github.com/tuki0918/pixzle

cli fragmentation image-processing nodejs pixzle react

Last synced: 3 months ago
JSON representation

[NPM] Image Fragmentation, Restoration, and Protection

• Host: GitHub
• URL: https://github.com/tuki0918/pixzle
• Owner: tuki0918
• License: mit
• Created: 2025-11-13T10:38:19.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2026-03-28T13:37:58.000Z (3 months ago)
• Last Synced: 2026-03-28T16:34:29.021Z (3 months ago)
• Topics: cli, fragmentation, image-processing, nodejs, pixzle, react
• Language: TypeScript
• Homepage: https://www.npmjs.com/~pixzle
• Size: 8.82 MB
• Stars: 1
• Watchers: 0
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# pixzle

![](.docs/figure.png)

This npm package provides functionality for image fragmentation and restoration.

Please note that this does not guarantee strong security.

## Requirements

- Node >= 20

## Packages

See each package README for usage details.

| Platform | Package | Shuffle | Restore |

|------|-----------|:------:|:------:|

| [CLI](./packages/cli/README.md) | `@pixzle/cli` | ✅ | ✅ |

| [Node.js](./packages/node/README.md) | `@pixzle/node` | ✅ | ✅ |

| [Browser](./packages/browser/README.md) | `@pixzle/browser` | - | ✅ |

| [React](./packages/react/README.md) | `@pixzle/react` | - | ✅ |

## Quick Start (CLI)

You can easily try image fragmentation using the CLI.

```bash

# Install CLI

npm install -g @pixzle/cli

# Shuffle images

pixzle shuffle input.png -o ./output

# Restore images

pixzle restore ./output/*.png -m ./output/manifest.json -o ./restored

```

## Shuffle Overview

### Result Example

| Fragmented | Restored |

|:---:|:---:|

| ![](.docs/fragmented1/img_2_fragmented.png) | ![](.docs/restored1/img_2.png) |

| ![](.docs/fragmented1/img_3_fragmented.png) | ![](.docs/restored1/img_3.png) |

| ![](.docs/fragmented1/img_1_fragmented.png) | ![](.docs/restored1/img_1.png) |

### List by blockSize

You can change the block size with `-b` or `--block-size `.

| input | blockSize: 1 | blockSize: 2 | blockSize: 3 | blockSize: 4 |

|:-------:|:---------------:|:---------------:|:---------------:|:----------------:|

| ![](.docs/input_sample.png) | ![](.docs/output_1.png) | ![](.docs/output_2.png) | ![](.docs/output_3.png) | ![](.docs/output_4.png) |

| blockSize: 8 (default) | blockSize: 16 | blockSize: 32 | blockSize: 50 | blockSize: 128 |

|:-------:|:---------------:|:---------------:|:---------------:|:----------------:|

| ![](.docs/output_8.png) | ![](.docs/output_16.png) | ![](.docs/output_32.png) | ![](.docs/output_50.png) | ![](.docs/output_128.png) |

> [!WARNING]

> - May cause memory shortage depending on the value of block size.