https://github.com/pierrec/lz4
LZ4 compression and decompression in pure Go
https://github.com/pierrec/lz4
go golang lz4 lz4-frame
Last synced: 3 days ago
JSON representation
LZ4 compression and decompression in pure Go
- Host: GitHub
- URL: https://github.com/pierrec/lz4
- Owner: pierrec
- License: bsd-3-clause
- Created: 2015-03-14T17:21:06.000Z (about 10 years ago)
- Default Branch: v4
- Last Pushed: 2025-04-11T07:15:28.000Z (4 days ago)
- Last Synced: 2025-04-11T08:05:16.996Z (4 days ago)
- Topics: go, golang, lz4, lz4-frame
- Language: Go
- Size: 65.6 MB
- Stars: 913
- Watchers: 27
- Forks: 145
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- my-awesome - pierrec/lz4 - frame pushed_at:2025-03 star:0.9k fork:0.1k LZ4 compression and decompression in pure Go (Go)
- awesome-go-perf - pierrec/lz4 - LZ4 compression and decompression in pure Go. (Compression)
- awesome-golang-repositories - lz4
README
# lz4 : LZ4 compression in pure Go
[](https://pkg.go.dev/github.com/pierrec/lz4/v4)
[](https://github.com/pierrec/lz4/actions)
[](https://goreportcard.com/report/github.com/pierrec/lz4)
[](https://github.com/pierrec/lz4/tags)
## Overview
This package provides a streaming interface to [LZ4 data streams](http://fastcompression.blogspot.fr/2013/04/lz4-streaming-format-final.html) as well as low level compress and uncompress functions for LZ4 data blocks.
The implementation is based on the reference C [one](https://github.com/lz4/lz4).
## Install
Assuming you have the go toolchain installed:
```
go get github.com/pierrec/lz4/v4
```
There is a command line interface tool to compress and decompress LZ4 files.
```
go install github.com/pierrec/lz4/v4/cmd/lz4c@latest
```
Usage
```
Usage of lz4c:
-version
print the program version
Subcommands:
Compress the given files or from stdin to stdout.
compress [arguments] [ ...]
-bc
enable block checksum
-l int
compression level (0=fastest)
-sc
disable stream checksum
-size string
block max size [64K,256K,1M,4M] (default "4M")
Uncompress the given files or from stdin to stdout.
uncompress [arguments] [ ...]
```
## Example
```
// Compress and uncompress an input string.
s := "hello world"
r := strings.NewReader(s)
// The pipe will uncompress the data from the writer.
pr, pw := io.Pipe()
zw := lz4.NewWriter(pw)
zr := lz4.NewReader(pr)
go func() {
// Compress the input string.
_, _ = io.Copy(zw, r)
_ = zw.Close() // Make sure the writer is closed
_ = pw.Close() // Terminate the pipe
}()
_, _ = io.Copy(os.Stdout, zr)
// Output:
// hello world
```
## Contributing
Contributions are very welcome for bug fixing, performance improvements...!
- Open an issue with a proper description
- Send a pull request with appropriate test case(s)
## Contributors
Thanks to all [contributors](https://github.com/pierrec/lz4/graphs/contributors) so far!
Special thanks to [@Zariel](https://github.com/Zariel) for his asm implementation of the decoder.
Special thanks to [@greatroar](https://github.com/greatroar) for his work on the asm implementations of the decoder for amd64 and arm64.
Special thanks to [@klauspost](https://github.com/klauspost) for his work on optimizing the code.