Skip to content

Latest commit

 

History

History
105 lines (67 loc) · 2.3 KB

ReadMe.md

File metadata and controls

105 lines (67 loc) · 2.3 KB

🦀 Cryptlocker

Cryptlocker is a powerful and easy-to-use command-line tool for encrypting and decrypting files and folders. It ensures your sensitive data remains secure with robust encryption methods. Perfect for safeguarding personal and professional information.

🚀 Examples of Usage

Here are some examples of how to use the cryptlocker command:

  1. Encrypt a file:
cryptlocker lock /path/to/your/file.txt
  1. Encrypt a folder:
cryptlocker lock /path/to/your/folder
  1. Decrypt a file:
cryptlocker unlock /path/to/your/file.txt
  1. Decrypt a folder:
cryptlocker unlock /path/to/your/folder.zip.cryptic

📦 Installation Instructions

Windows

  1. Open a Command Prompt with administrative privileges.
  2. Run the following command to install cryptlocker:
powershell -Command "Invoke-WebRequest -Uri https://raw.githubusercontent.com/ArunVenkata/cryptlocker/master/scripts/install.bat -OutFile install.bat; Start-Process -FilePath install.bat -Wait"

Linux/MacOS

  1. Open a terminal.

  2. Run the following command to install cryptlocker

curl -sSL https://raw.githubusercontent.com/ArunVenkata/cryptlocker/master/scripts/install.sh | sh

Note: To uninstall, Replace the word install with uninstall in the above commands.

🖥️ Install from Source

  1. Clone the repository:
git clone https://github.com/ArunVenkata/cryplocker.git
cd cryptlocker

  1. Ensure you have Rust installed on your machine.

  2. Build the project:

cargo build --release
  1. Run the tool:
./target/release/cryptlocker help

Run cryptlocker help for more information on the supported parameters.

🤝 Contributing Guidelines

If you would like to contribute to the project, please follow these guidelines:

  1. Fork the repository and create your feature branch:
git checkout -b feature/new-feature
  1. Commit your changes:
git commit -m "Add some feature"
  1. Push to the branch:
git push origin feature/new-feature
  1. Open a pull request and describe your changes.

🎉 License

This project is licensed under the MIT License. See the LICENSE file for details.