# edcrypt-image-encrypt-decrypt

> nodejs cli tool to encrypt and decrypt image

Latest version **1.0.0** (published 2023-04-13) · ISC license · 0 weekly downloads

## Install

```sh
npm install edcrypt-image-encrypt-decrypt
pnpm add edcrypt-image-encrypt-decrypt
yarn add edcrypt-image-encrypt-decrypt
bun add edcrypt-image-encrypt-decrypt
```

Provides the command `edcrypt`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2023-04-13 |
| First published | 2023-04-13 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 9.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Vasu Devrani |
| Maintainers | vasudevrani |
| Keywords | edcrypt, encrypt, decrypt, image, cryptography, nodejs, cli |

## Links

- npm: https://www.npmjs.com/package/edcrypt-image-encrypt-decrypt
- Repository: https://github.com/VasuDevrani/image-encrypt-decrypt
- Homepage: https://github.com/VasuDevrani/image-encrypt-decrypt#readme
- Issues: https://github.com/VasuDevrani/image-encrypt-decrypt/issues
- npm.io page: https://npm.io/package/edcrypt-image-encrypt-decrypt

## Dependencies (4)

- [jimp](https://npm.io/package/jimp.md) ^0.22.7
- [meow](https://npm.io/package/meow.md) ^9.0.0
- [cli-alerts](https://npm.io/package/cli-alerts.md) ^1.2.2
- [cli-meow-help](https://npm.io/package/cli-meow-help.md) ^3.1.0

## Alternatives

- [@gemini-wallet/core](https://npm.io/package/@gemini-wallet/core.md) — 515.6K weekly downloads
- [utility](https://npm.io/package/utility.md) — 416.6K weekly downloads
- [@primno/dpapi](https://npm.io/package/@primno/dpapi.md) — 7.2K weekly downloads
- [pi-readseek](https://npm.io/package/pi-readseek.md) — 3.7K weekly downloads
- [@emilia-protocol/verify](https://npm.io/package/@emilia-protocol/verify.md) — 1.1K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2023-04-13

## README

# EDCRYPT 

## nodejs cli tool to encrypt and decrypt images using xor operation

<table>
  <tbody>
  <tr>
    <td ><img src="https://user-images.githubusercontent.com/101383635/231770159-63818804-5be9-4d6b-b2e5-3ee6e6256eec.jpeg"/><br><b> Image </b></td>
        <td ><img alt="" src="https://user-images.githubusercontent.com/101383635/231770985-7b0becc3-676e-42a3-956e-669eb4037908.jpeg" width="130px;"><br><b> Encrypted image </b></td></td>
        <td ><img alt="" src="https://www.cleverfiles.com/howto/wp-content/uploads/2017/04/recover-deleted-key-300x300.png" width="130px;"><br><b> Key </b></td>
  </tr>
</tbody></table>

## Installation

```sh
npm i -g image-encrypt-decrypt
```

## Usage

```sh
edcrypt <command> [option]
```

### commands

```sh
help  #prints help info
```

### options

```sh
  -e, --encrypt              # The image to encrypt
  -d, --decrypt              # The image to decrypt
  -v, --version              # Print CLI version Default: false
  -k, --key                  # The key to use for decryption Default: false
  -i, --outputImageFileName  # The output image
  -p, --outputKeyFileName    # The output key
```

### For encrypting an image myImage.png to encryptedImage.png and saving the key to key.txt

```sh
imcrypt -e myImage.png -i encryptedImageName.png -p keyFile.txt
```

### For decrypting an image encryptedImage.png with its key key.txt to decryptedImage.png

```sh
imcrypt -d encryptedImage.png -k key.txt -i decryptedImage.png
```

---
_Source: https://npm.io/package/edcrypt-image-encrypt-decrypt · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._