A transparent discovery signal based on current public GitHub metadata.
Recent activity35% weight
72
Community adoption25% weight
7
Maintenance state20% weight
100
License clarity10% weight
100
Project information10% weight
75
This score does not audit code, security, maintainers, documentation quality, or suitability. Verify the repository and its current documentation before adoption.
README preview
About The Project
A high-performance, standalone command-line file compression utility written in Kotlin. The project leverages the Canonical Huffman Coding algorithm to achieve lossless binary data compression.
Built With
Technical Architecture & Core Components
The system is engineered using a highly decoupled architecture split into two discrete functional boundaries:
Acts as the external CLI wrapper interface. It isolates the engine from underlying storage constraints by validating file paths, evaluating action mode flags, and translating exceptions into user-friendly diagnostic logs. It initializes high-performance, buffered pipelines on stream primitives.
2. Core Transformation Library (HuffmanLib.kt)
An encapsulated module containing the compression engine and internal structures. All helper nodes, encoders, and code managers are marked private to safeguard module states.
Compression Lifecycle: Streams data bytes (\rightarrow) evaluates exact frequencies (\rightarrow) generates an optimal immutable tree via a PriorityQueue (\rightarrow) derives standardized code lengths (\rightarrow) streams a optimized bit-header followed by byte-packed tokens using a custom BitWriter.
Decompression Lifecycle: Restores the 32-bit source size token (\rightarrow) rebuilds the symbol-to-length metadata map (\rightarrow) reconstructs a fast, mutable traversal pointer-tree (\rightarrow) routes sequential bits via BitReader until hitting character leaves.
Getting Started
To set up a local copy of this archiver up and running, follow these simple installation and build steps.
Prerequisites
This application runs on the Java Virtual Machine. You only need a Java Development Kit (JDK) installed on your machine.
JDK 17 or higher (Recommended: Eclipse Temurin OpenJDK)
You can check your current Java version in your terminal using:
This project operates as a CLI application. Since it compiles natively to the JVM, you can interact with it using the built-in Gradle task manager to pipe files through the archiver.
1. File Archiving & Compression (-a / --archive)
To compress your raw source files into an optimized binary format, use the -a or --archive flag. Pass your source file path followed by the destination path:
To extract an archive back into its exact original format, use the -u or --unarchive flag:
./gradlew run --args="-u document.huff recovered.txt"
3. Integrity Validation
You can confirm that the decompression cycle was perfectly lossless by running a file diff. If the data blocks match identically, the command returns zero terminal output:
diff text.txt recovered.txt
4. Accessing the Syntax Guidelines (-h / --help)
If you forget the syntax parameters, trigger the help driver menu:
./gradlew run --args="-h"
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
Fork the Project
Create your Feature Branch (git checkout -b feature/AmazingFeature)
Commit your Changes (git commit -m 'Add some AmazingFeature')
Push to the Branch (git push origin feature/AmazingFeature)
Open a Pull Request
Top contributors:
License
Distributed under the MIT License. See LICENSE.txt for more information.
