How do I extract a specific file from an archive using go-unarr?

Use the a.EntryFor("filename.txt") method to target a known file, then read it with a.ReadAll(). This allows direct access without iterating through all entries, as shown in the library examples for efficient file retrieval.

Does go-unarr support password-protected or encrypted RAR files?

Support depends on the underlying unarr library, which may have limited encryption capabilities. For fully secure archives, check the unarr documentation or consider alternative libraries with broader encryption support.

go-unarr vs Go's standard archive/zip: which is better for my project?

Choose go-unarr if you need multi-format support beyond ZIP and TAR, such as RAR and 7z. For pure ZIP handling, archive/zip is native and more efficient, but go-unarr offers broader compatibility across archive types.

How can I handle large archives with go-unarr to avoid memory issues?

Use streaming access by reading entries sequentially with a.Entry() and a.Read() in chunks, rather than a.ReadAll(), to process files incrementally and reduce memory footprint, as suggested in the examples.

Is go-unarr suitable for use in containerized or serverless environments?

Yes, but the C dependency may require static linking or ensuring libunarr is available, which can increase image size. Use build tags like static to mitigate this, though it adds complexity to the build process.

How to install go-unarr with an external libunarr library?

Use the extlib build tag during installation or compilation, and set up pkg-config if needed, as detailed in the README's build tags section, to link against an existing unarr installation.

Open-Awesome

go-unarr

ZlibGov0.2.4

Go bindings for the unarr library, providing decompression support for RAR, TAR, ZIP, and 7z archives.

GitHub

310 stars48 forks0 contributors

What is go-unarr?

go-unarr is a Go library that provides bindings for the unarr decompression library, enabling Go applications to handle archive files. It supports extracting, listing, and reading from RAR, TAR, ZIP, and 7z archives, solving the need for native archive processing in Go projects.

Target Audience

Go developers who need to work with compressed archives in their applications, such as those building file management tools, backup systems, or data processing pipelines.

Value Proposition

It offers a straightforward, idiomatic Go API for archive operations, leveraging the proven unarr library for reliable decompression without requiring external tools or complex implementations.

Overview

Go bindings for unarr (decompression library for RAR, TAR, ZIP and 7z archives)

Use Cases

Best For

Extracting archive files in Go applications
Building CLI tools for archive management
Processing compressed data in backend services
Reading specific files from archives programmatically
Handling multiple archive formats (RAR, ZIP, 7z, TAR) uniformly
Integrating archive support without shelling out to external commands

Not Ideal For

Projects requiring archive creation or compression capabilities
Applications needing full support for encrypted RAR archives or latest archive format versions
Environments where minimizing external C library dependencies is critical
High-performance systems where the overhead of C bindings could impact speed compared to pure Go libraries

Pros & Cons

Pros

Multi-Format Support

Supports RAR, TAR, ZIP, and 7z archives, providing a unified interface for common decompression needs, as highlighted in the README's feature list.

Idiomatic Go API

Offers a clean, Go-like interface with simple methods like a.Entry() and a.ReadAll(), making it easy to integrate into Go applications, as shown in the library examples.

Included CLI Tool

Comes with a command-line utility, unarr, for direct archive extraction, which is installable via go install, adding convenience for developers.

Cross-Platform Builds

Leverages Go tooling for cross-compilation to multiple platforms, ensuring consistent behavior across operating systems, as mentioned in the README.

Cons

C Library Dependency

Relies on the unarr C library, requiring complex setup with build tags like extlib and pkgconfig, which can complicate deployment and increase maintenance overhead.

Decompression Only

Lacks support for creating or modifying archives, limiting functionality to read-only operations, which may not suffice for full archive management tasks.

Potential Feature Limitations

Inherits limitations from the unarr library, such as possible gaps in handling encrypted archives or newer RAR formats, which could affect reliability in edge cases.

Frequently Asked Questions

Related Projects

gopsutil

psutil for golang

Stars11,882

Forks1,678

Last commit2 days ago

gatus

Automated developer-oriented status page with alerting and incident support

Stars11,595

Forks774

Last commit5 days ago

gofakeit

Random fake data generator written in go

Stars5,372

Forks297

Last commit2 months ago

purego

A library for calling C functions from Go without Cgo

Stars3,746

Forks118

Last commit4 days ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub