SharpCompress 0.33.0

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
.NET 6.0 .NET Standard 2.0 .NET Framework 4.6.2
There is a newer version of this package available.
See the version list below for details. 
dotnet add package SharpCompress --version 0.33.0
NuGet\Install-Package SharpCompress -Version 0.33.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="SharpCompress" Version="0.33.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add SharpCompress --version 0.33.0
#r "nuget: SharpCompress, 0.33.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install SharpCompress as a Cake Addin
#addin nuget:?package=SharpCompress&version=0.33.0

// Install SharpCompress as a Cake Tool
#tool nuget:?package=SharpCompress&version=0.33.0

SharpCompress

SharpCompress is a compression library in pure C# for .NET Standard 2.0, 2.1, .NET Core 3.1 and .NET 5.0 that can unrar, un7zip, unzip, untar unbzip2, ungzip, unlzip with forward-only reading and file random access APIs. Write support for zip/tar/bzip2/gzip/lzip are implemented.

The major feature is support for non-seekable streams so large files can be processed on the fly (i.e. download stream).

GitHub Actions Build - GitHubActions

Need Help?

Post Issues on Github!

Check the Supported Formats and Basic Usage.

In general, I recommend GZip (Deflate)/BZip2 (BZip)/LZip (LZMA) as the simplicity of the formats lend to better long term archival as well as the streamability. Tar is often used in conjunction for multiple files in a single archive (e.g. .tar.gz)

Zip is okay, but it's a very hap-hazard format and the variation in headers and implementations makes it hard to get correct. Uses Deflate by default but supports a lot of compression methods.

RAR is not recommended as it's a propriatory format and the compression is closed source. Use Tar/LZip for LZMA

7Zip and XZ both are overly complicated. 7Zip does not support streamable formats. XZ has known holes explained here: (http://www.nongnu.org/lzip/xz_inadequate.html) Use Tar/LZip for LZMA compression instead.

A Simple Request

Hi everyone. I hope you're using SharpCompress and finding it useful. Please give me feedback on what you'd like to see changed especially as far as usability goes. New feature suggestions are always welcome as well. I would also like to know what projects SharpCompress is being used in. I like seeing how it is used to give me ideas for future versions. Thanks!

Please do not email me directly to ask for help. If you think there is a real issue, please report it here.

Want to contribute?

I'm always looking for help or ideas. Please submit code or email with ideas. Unfortunately, just letting me know you'd like to help is not enough because I really have no overall plan of what needs to be done. I'll definitely accept code submissions and add you as a member of the project!

TODOs (always lots)

  • RAR 5 decryption support
  • 7Zip writing
  • Zip64 (Need writing and extend Reading)
  • Multi-volume Zip support.

Version Log

Version 0.18

Version 0.17.1

Version 0.17.0

Version 0.16.2

Version 0.16.1

Version 0.16.0

Version 0.15.2

  • Fix invalid headers - fixes an issue creating large-ish zip archives that was introduced with zip64 reading.

Version 0.15.1

Version 0.15.0

Version 0.14.1

Version 0.14.0

Version 0.13.1

Version 0.13.0

  • Breaking change: Big refactor of Options on API.
  • 7Zip supports Deflate

Version 0.12.4

Version 0.12.3

Version 0.12.2

  • Support Profile 259 again

Version 0.12.1

  • Support Silverlight 5

Version 0.12.0

  • .NET Core RTM!
  • Bug fix for Tar long paths

Version 0.11.6

  • Bug fix for global header in Tar
  • Writers now have a leaveOpen bool overload. They won't close streams if not-requested to.

Version 0.11.5

  • Bug fix in Skip method

Version 0.11.4

  • SharpCompress is now endian neutral (matters for Mono platforms)
  • Fix for Inflate (need to change implementation)
  • Fixes for RAR detection

Version 0.11.1

  • Added Cancel on IReader
  • Removed .NET 2.0 support and LinqBridge dependency

Version 0.11

  • Been over a year, contains mainly fixes from contributors!
  • Possible breaking change: ArchiveEncoding is UTF8 by default now.
  • TAR supports writing long names using longlink
  • RAR Protect Header added

Version 0.10.3

  • Finally fixed Disposal issue when creating a new archive with the Archive API

Version 0.10.2

  • Fixed Rar Header reading for invalid extended time headers.
  • Windows Store assembly is now strong named
  • Known issues with Long Tar names being worked on
  • Updated to VS2013
  • Portable targets SL5 and Windows Phone 8 (up from SL4 and WP7)

Version 0.10.1

  • Fixed 7Zip extraction performance problem

Version 0.10:

  • Added support for RAR Decryption (thanks to https://github.com/hrasyid)
  • Embedded some BouncyCastle crypto classes to allow RAR Decryption and Winzip AES Decryption in Portable and Windows Store DLLs
  • Built in Release (I think)

XZ implementation based on: https://github.com/sambott/XZ.NET by @sambott

XZ BCJ filters support contributed by Louis-Michel Bergeron, on behalf of aDolus Technology Inc. - 2022

7Zip implementation based on: https://code.google.com/p/managed-lzma/

LICENSE Copyright (c) 2000 - 2011 The Legion Of The Bouncy Castle (http://www.bouncycastle.org)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (249)

Showing the top 5 NuGet packages that depend on SharpCompress:

Package Downloads
MongoDB.Driver.Core The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Core Component of the Official MongoDB .NET Driver.
Ductus.FluentDocker

Library to manage docker-machine, docker-compose, and docker containers for windows / mac or native linux using netcore or full framework.
squirrel.windows

An installation and update framework for Windows applications
SanteDB.Core.Api

SanteDB Core API services and functions
MongoDB.Driver.Core.signed

(Unofficial) Signed Core Component of the MongoDB .NET Driver. The containing assembly was generated by signing the officially published MongoDB.Driver.Core.dll.

GitHub repositories (114)

Showing the top 5 popular GitHub repositories that depend on SharpCompress:

Repository Stars
microsoft/PowerToys
Windows system utilities to maximize productivity
QL-Win/QuickLook
Bring macOS “Quick Look” feature to Windows
ppy/osu
rhythm is just a *click* away!
duplicati/duplicati
Store securely encrypted backups in the cloud!
ServiceStack/ServiceStack
Thoughtfully architected, obscenely fast, thoroughly enjoyable web services for all
Version Downloads Last updated
0.36.0 344,000 1/15/2024
0.35.0 106,903 12/18/2023
0.34.2 224,725 11/15/2023
0.34.1 298,111 10/2/2023
0.34.0 116,493 9/18/2023
0.33.0 1,256,773 3/21/2023
0.32.2 2,143,862 7/29/2022
0.32.1 430,696 6/20/2022
0.32.0 31,629 6/13/2022
0.31.0 1,282,762 3/30/2022
0.30.1 56,614,303 11/22/2021
0.30.0 2,289,976 10/2/2021
0.29.0 3,187,675 9/12/2021
0.28.3 910,630 6/4/2021
0.28.2 518,526 4/25/2021
0.28.1 660,254 2/18/2021
0.28.0 19,782 2/14/2021
0.27.1 179,285 1/13/2021
0.27.0 25,782 1/11/2021
0.26.0 1,117,674 7/26/2020
0.25.1 407,589 5/22/2020
0.25.0 617,020 4/3/2020
0.24.0 2,235,097 8/20/2019
0.23.0 78,428,674 2/27/2019
0.22.0 804,742 7/9/2018
0.21.1 75,975 5/15/2018
0.21.0 28,917 5/9/2018
0.20.0 114,555 3/24/2018
0.19.2 112,390 12/16/2017
0.19.1 5,130 12/15/2017
0.19.0 7,542 12/12/2017
0.18.2 453,413 9/22/2017
0.18.1 45,819 8/17/2017
0.18.0 39,522 7/19/2017
0.17.1 1,175,820 6/9/2017
0.17.0 13,606 6/1/2017
0.16.2 9,439 5/31/2017
0.16.1 41,990 5/23/2017
0.16.0 6,012 5/22/2017
0.15.2 365,494 3/9/2017
0.15.1 103,374 1/26/2017
0.15.0 6,224 1/24/2017
0.14.1 32,065 11/30/2016
0.14.0 31,657 10/14/2016
0.13.1 17,376 10/3/2016
0.13.0 6,559 9/29/2016
0.12.4 32,474 8/12/2016
0.12.3 25,270 7/22/2016
0.12.2 4,186 7/18/2016
0.12.1 4,392 7/13/2016
0.12.0 4,279 7/13/2016
0.11.6 292,243 4/7/2016
0.11.5 123,436 2/14/2016
0.11.4 7,989 2/7/2016
0.11.3 11,027 12/28/2015
0.11.2 31,765 12/1/2015
0.11.1 48,092 7/27/2015
0.11.0 5,951 6/12/2015
0.10.3 51,277 12/15/2013
0.10.2 123,143 11/23/2013
0.10.1.3 33,335 8/14/2013
0.10.1.1 3,993 8/13/2013
0.10.1 4,212 8/11/2013
0.10.0 4,674 7/27/2013
0.9.0 7,875 5/4/2013
0.8.2 17,665 12/11/2012
0.8.1 7,892 5/15/2012
0.8.0 15,059 2/27/2012
0.7.0 4,645 11/16/2011
0.6.0 4,314 9/22/2011
0.5.0 4,237 7/6/2011
0.4.0 4,187 6/22/2011
0.3.0 4,142 5/27/2011
0.2.0 15,236 5/12/2011