https://github.com/yanivzalach/basic_encryption_cli_tool
RustyCipher - Encrypting and Decrypting files using the Rust programming language.
https://github.com/yanivzalach/basic_encryption_cli_tool
cli decryption educational encryption linux macos rust wsl wsl2
Last synced: 3 months ago
JSON representation
RustyCipher - Encrypting and Decrypting files using the Rust programming language.
- Host: GitHub
- URL: https://github.com/yanivzalach/basic_encryption_cli_tool
- Owner: YanivZalach
- License: mit
- Created: 2023-09-28T16:48:53.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-12T11:48:12.000Z (over 2 years ago)
- Last Synced: 2024-01-27T06:00:57.442Z (over 2 years ago)
- Topics: cli, decryption, educational, encryption, linux, macos, rust, wsl, wsl2
- Language: Rust
- Homepage:
- Size: 6.84 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RustyCipher 📜🔒
RustyCipher is a basic encryption and decryption CLI tool written in Rust. It allows you to encrypt and decrypt text files using a custom and basic encryption algorithm. 🤖🔐
## Features
- ✨ Simple and easy-to-use interface
- 🔑 Custom encryption and decryption algorithm
- 📂 Supports text file encryption and decryption
## Usage
### Installation
1. Make sure you have Rust and Cargo installed. If not, you can download them from [here](https://www.rust-lang.org/).
2. Clone this repository:
```shell
git clone https://github.com/YanivZalach/Basic_Encryption_CLI_Tool.git ~/Documents/RustyCipher
```
3. Change directory to the project folder:
```shell
cd RustyCipher
```
4. Build the project:
```shell
cargo build --release
```
### Encrypt a File
To encrypt a text file, run the following command (for decryption change the `-e` to `-d`):
```shell
~/Documents/RustyCipher/target/release/rustycipher -e input.txt key
```
**For more information run:**
```shell
~/Documents/RustyCipher/target/release/rustycipher -h
```
### For Esey of use
Add the following line to your `~/.bashrc`/`~/.zshrc`/`~/.config/fish/config.fish`:
```shell
alias rustycipher='$HOME/Documents/RustyCipher/target/release/rustycipher'
```
Now, you can use RustyCipher simply by typing `rustycipher` in your terminal!
```shell
rustycipher
```
## ⚠️ Disclaimer
RustyCipher is designed for educational and basic encryption purposes only. It uses a basic encryption algorithm that may not provide strong security. It should not be used for encrypting sensitive or critical data. For serious security needs, consider using established encryption tools and libraries.
Please exercise caution and avoid using RustyCipher for applications requiring high-security standards.