Skip to content

SidZRed/fequip

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

fequip - File Equip tool

fequip is a command line tool designed for equipping files to enhance their storage and transfer capabilities. It includes methods for file compression using Huffman encoding and LZW, as well as file encryption and decryption. Files processed with fequip are stored with unique extensions for easy identification. The command line tool is implemented in C++ for better performance and security.

Installation

Debian-based systems (using apt)

sudo apt update
sudo apt install fequip

This has been implemented by maintaining a personal repository which requires an up and running server. So if in any case, there is any difficulty in operating the server, please drop an issue in the same repository and it should be fixed soon. This is because the remote repository is being hosted on apache-2 server.

This can also be resolved by locally downloading the .deb file and building the projects locally. This is available in local_setup directory.

Usage

General usage:

fequip -command -type <input_file>

For help in using the tool, run:

fequip -help

Commands

A few commands are available for equipping on the files :

  • compress: Compresses the input file using specified compression algorithm.
  • encrypt: Encrypts the input file using specified encryption cipher.
  • decrypt: Decrypts the encrypted input file using specified decryption cipher.

Types

  • -compress: Specify compression algorithm (-huffman or -lzw).
  • -encrypt: An encryption cipher is used ( -cipher)

Examples

Compression

fequip -compress huffman <input_file>

Produces <input_file>.cmp and <input_file>.map.

Encryption

fequip -encrypt cipher <input_file>

Produces <input_file>.enc and <input_file>.key.

Decryption

fequip -decrypt cipher <input_file>.enc <input_file>.key

Produces <input_file>.dec.

License

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

Credits

New updates on this tool are to be released. Any new algorithms/ methods for the above are most welcome!