# SweeCrypt-rs
A basic and fun cipher module for everyone. It converts regular text into symbols on a keyboard, kind of like a cipher. This is only for fun, using this module for cybersecurity is NOT ADVISED
This is a port of [SweeCrypt-py](https://git.swee.codes/swee/SweeCrypt-py) to Rust.
# Install
## CLI
```shell-session
$ cargo install sweecrypt
```
Help page:
```shell-session
$ sweecrypt --help
SweeCrypt-rs v1.1.4 - https://git.swee.codes/swee/SweeCrypt-rs
An easy and fun encryption module and app
Copyright 2024-2025 Swee
This software is licensed with MIT license
Usage: sweecrypt [encrypt|decrypt] (-s <n>) <msg>
Commands
encrypt <str> Encodes a message
decrypt <str> Decodes a message
Flags
--help Shows this message
--shift <int> Specifies a database shift
```
## Module
```shell-session
$ cargo add sweecrypt
```
```toml
[dependencies]
sweecrypt = "1.1.4"
```
# Examples
## Encrypt
```rust
using sweecrypt::encode;
fn main() {
println!("{}", encode("hello, world!", 0));
}
```
```shell-session
$ sweecrypt encrypt "hello, world!"
!?~~(:,}(>~/a
```
## Decrypt
```rust
using sweecrypt::decode;
fn main() {
println!("{}", decode("!?~~(:,}(>~/a", 0));
}
```
```shell-session
$ sweecrypt decrypt '!?~~(:,}(>~/a'
hello, world!
```
## Shifting DB
```rust
using sweecrypt::{decode,encode};
fn main() {
let encoded = encode("hello, world!", 3);
println!("{}", encoded);
println!("{}", decode(encoded, 3)); // Correct output
println!("{}", decode(encoded, 0)); // Wrong output
}
```
```shell-session
$ sweecrypt encrypt --shift 3 "hello, world"
\!((>ba_>](#
$ sweecrypt decrypt --shift 3 "\!((>ba_>](#"
hello, world
```
It will output a nonsense string if shifted incorrectly.
```shell-session
$ sweecrypt decrypt "\!((>ba_>](#"
khoor?!zruog
```