Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sidzred/fequip
A command line file equip tool.
https://github.com/sidzred/fequip
compression encryption filesystem
Last synced: 19 days ago
JSON representation
A command line file equip tool.
- Host: GitHub
- URL: https://github.com/sidzred/fequip
- Owner: SidZRed
- License: mit
- Created: 2024-07-09T08:09:05.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-08-01T04:38:51.000Z (6 months ago)
- Last Synced: 2024-08-01T06:45:25.935Z (6 months ago)
- Topics: compression, encryption, filesystem
- Language: C++
- Homepage: https://sidzred.github.io/fequip/
- Size: 95.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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)
```bash
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:
```bash
fequip -command -type
```
For help in using the tool, run:
```bash
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
```bash
fequip -compress huffman
```
Produces `.cmp` and `.map`.
### Encryption
```bash
fequip -encrypt cipher
```
Produces `.enc` and `.key`.
### Decryption
```bash
fequip -decrypt cipher .enc .key
```
Produces `.dec`.
## License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/SidZRed/fequip/blob/main/LICENSE) file for details.
## Credits
- Developed by [SidZRed](https://github.com/SidZRed)
New updates on this tool are to be released. Any new algorithms/ methods for the above are most welcome!
---