Giter Club home page Giter Club logo

cow-encryptor's Introduction

Cow-encryptor

Encrypt your files in cow language ๐Ÿฎ

Installation ๐Ÿ“ฆ

Arch Linux ๐Ÿง

cow-encryptor is in the AUR

yay -S cow-encryptor

Other ๐ŸชŸ๐Ÿง

With make - Linux ๐Ÿง

Build with make

# ๐Ÿ“‚ cow-encryptor/
make

Copy the binary to bin folder

# ๐Ÿ“‚ cow-encryptor/
make install

Build from source - Linux ๐Ÿง & Windows ๐ŸชŸ

Clone this repo

git clone https://github.com/SkwalExe/cow-encryptor.git

build with cargo

# ๐Ÿ“‚ cow-encryptor/
cargo build --release

[ LINUX ONLY ] : Move the binary

# ๐Ÿ“‚ cow-encryptor/
sudo cp target/release/cow-encryptor /usr/bin/cow-encryptor

On windows the executable will be target\release\cow-encryptor.exe you can move it wherever you want.

Usage ๐Ÿ“

--overwrite

Folder content :

If you try

cow-encryptor secret.txt

You will get the following error :

Because a destination file already exists.

Use the --overwrite flag to overwrite the destination file.

--encrypt

Enter encryption mode, the specified file will be encrypted.

Original file :

cow-encryptor --encrypt secret.txt

Result :

Encryption mode will be used by default if the file doens't have the .cow extension.

--decrypt

Enter decription mode, the specified file will be decrypted.

Encrypted file :

cow-encryptor [--decrypt] secret.txt.cow

The decryption mode will automatically be used if the file ends with .cow

--print

With this option, the encrypted/decrypted file will be printed to the standard output instead if saving it to a file.

Docker ๐Ÿณ

Run the latest version

docker run --rm -it ghcr.io/skwalexe/cow-encryptor:main

Test your changes ๐Ÿšง

Build ๐Ÿ› ๏ธ

# ๐Ÿ“‚ cow-encryptor/
docker build -t cow-encryptor .

Run ๐Ÿƒ

docker run --rm -it cow-encryptor [OPTIONS]

Uninstall ๐Ÿ—‘

With make

Run make uninstall

# ๐Ÿ“‚ cow-encryptor/
make uninstall

removing the binary

sudo rm /usr/bin/cow-encryptor

Setting up development environment

For this project, I recommend Visual Studio Code.

You'll need to install the rust extension

ext install rust-lang.rust

contributing

Start by forking this repository.

Then clone your fork to your local machine.

git clone https://github.com/your-username/cow-encryptor.git

Create a new branch

git checkout -b super-cool-feature

Then edit the source code in the ๐Ÿ“‚/src/ folder.

Once you're done, commit your changes and push them to the remote repository.

git add --all
git commit -m "Add super-cool-feature"
git push origin super-cool-feature

Then, open a pull request on GitHub from your fork.

final

If you have any problem, don't hesitate to open an issue

cow-encryptor's People

Contributors

imgbot[bot] avatar skwalexe avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

suspendedcodes

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.