Skip to content

A CLI that encrypts and decrypts png, jpg, jpeg images to a gibberish image and provides you the key to unlock it later so that you have the complete control of your images.

License

Notifications You must be signed in to change notification settings

0xsarwagya/scramblify

Repository files navigation

Scramblify

Scramblify Logo

An open-source TypeScript CLI that securely encrypts and decrypts PNG, JPG, and JPEG images into gibberish. Protect your images with a unique key that you control.
Explore the documentation »

NPM Version Issues Stars License


🚀 Features

  • Secure Encryption: Converts your images into unreadable gibberish while maintaining their format (PNG, JPG, JPEG).
  • Key-Based Unlocking: Generate a unique key during encryption that’s required for decryption.
  • User-Friendly CLI: Easy-to-use command-line interface built with TypeScript.
  • Customizable Output: Supports input and output file paths for flexible usage.
  • Open-Source: Free to use, modify, and contribute to.

📦 Installation

To install Scramblify, make sure you have Node.js installed on your system.

npm install -g scramblify

🛠 Usage

Encrypt an Image

To encrypt an image and generate a scrambled file:

scramblify encrypt scramblify encrypt --input <input_file_path> --output <output_file_path> --password <password>

Example:

scramblify encrypt --input <input_file_path> --output <output_file_path> --password <password>

Decrypt an Image

To decrypt a scrambled file back to its original format:

scramblify decrypt --input <input_file_path> --output <output_file_path> --password <password>

Example:

scramblify decrypt  --input <input_file_path> --output <output_file_path> --password <password>

📖 Documentation

For full usage instructions and advanced configurations, visit the official documentation.


🤝 Contributing

We welcome contributions from the community! To get started, check out our contributing guidelines.

Development Setup

  1. Clone the repository:
    git clone https://github.com/0xsarwagya/scramblify.git
  2. Install dependencies:
    npm install
  3. Run the CLI locally:
    npm run build && npx .

🎉 Top Contributors

A big thank you to everyone who has contributed to this project!

Made with Contrib.rocks.


🛡 License

This project is licensed under the MIT License.


💬 Support

If you have any questions, feel free to open an issue or reach out to the maintainers.


📢 Stay Connected

About

A CLI that encrypts and decrypts png, jpg, jpeg images to a gibberish image and provides you the key to unlock it later so that you have the complete control of your images.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published