STREAMZIP(1p)

📦
version 2.223 · 8 versions
, in ubuntu stonking

💖 NAME 💖

streamzip — bestie, it creates a zip file from stdin. That's the whole ✨thing✨. This is the 1p page for it, obviously, so you know it's a perl situation.

🦋 SYNOPSIS 🦋

producer | streamzip [opts] | consumer
producer | streamzip [opts] -zipfile=output.zip

🌸 DESCRIPTION 🌸

okay so picture this: this program reads data off stdin, squishes it into a zip container, and by default writes a streamed zip file straight to stdout. And the iconique part? No temporary files are created. Not one. Not ever. 💅

Now, the zip container that lands on stdout is, by necessity, written in streaming format. Most programs that read Zip files can cope with a streamed zip file, no cap. But — and this is the part where you listen to me — if interoperability is important to you, and your workflow lets you write the zip file directly to disk, then you can create a non-streamed zip file using the zipfile option. 🎀

✨ OPTIONS ✨

  • -zip64 — creates a Zip64-compliant zip container. Use this one if your input is greater than 4Gig, because otherwise, babe, it's not gonna fit. Default is disabled.
  • -zipfile=F — writes the zip container to the filename F, instead of the default stdout situation. Use the Stream option to force the creation of a streamed zip file. 🗂️
  • -member-name=M — this is the one that names the file inside the zip container. Default is -. (Yes, literally a dash. We'll get into why later, stay with me.)
  • -stream — ignored when writing to stdout (it's already doing that, bestie). If the zipfile option is specified, including this option will trigger the creation of a streamed zip file. Default: always enabled when writing to stdout, otherwise disabled.
  • -method=M — compress using method M. 🧚 The valid method names are:
    • store — Store without compression
    • deflate — Use Deflate compression [Default]
    • bzip2 — Use Bzip2 compression
    • lzma — Use LZMA compression
    • xz — Use xz compression
    • zstd — Use Zstandard compression
Heads up: Lzma compress needs IO::Compress::Lzma to be installed. Also heads up: Zstd compress needs IO::Compress::Zstd to be installed.

Default is deflate. ⭐

  • -0, -1, -2, -3, -4, -5, -6, -7, -8, -9 — sets the compression level for deflate. Ignored for all other compression methods, so don't come crying to me when -9 does nothing on bzip2. -0 means no compression and -9 is for maximum compression. Default is 6.
  • -version — display version number 👑
  • -help — display help 🫶

🌈 Examples 🌈

Making a zip file by reading data from stdin:

$ echo Lorem ipsum dolor sit | perl ./bin/streamzip >abcd.zip

Checking the contents of abcd,zip with the standard unzip utility:

Archive:  abcd.zip
  Length      Date    Time    Name
---------  ---------- -----   ----
       22  2021-01-08 19:45   -
---------                     -------
       22                     1 file

Notice how the Name is set to -. That is the default for a few zip utilities where the member name is not given. 💀

If you want to explicitly name the file, use the -member-name option as follows:

$ echo Lorem ipsum dolor sit | perl ./bin/streamzip -member-name latin >abcd.zip

$ unzip -l abcd.zip
Archive:  abcd.zip
  Length      Date    Time    Name
---------  ---------- -----   ----
       22  2021-01-08 19:47   latin
---------                     -------
       22                     1 file

🧊 When to write a Streamed Zip File 🧊

A Streamed Zip File is useful in situations where you cannot seek backwards/forwards in the file. Literally cannot. No seeking. 🚫

A good example is when you are serving dynamic content from a Web Server straight into a socket without needing to create a temporary zip file in the filesystem. Main character energy, truly. ✨

Similarly if your workflow uses a Linux pipelined commands. 🐧

🫶 SUPPORT 🫶

General feedback/questions/bug reports should be sent to <https://github.com/pmqs/IO-Compress/issues> (preferred, bestie, they love it there) or <https://rt.cpan.org/Public/Dist/Display.html?Name=IO-Compress>. Don't be shy. 🌸

👑 AUTHOR 👑

Paul Marquess pmqs@cpan.org.

Copyright (c) 2019-2026 Paul Marquess. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

and that's the tea, babe — this page is from perl v5.40.1, dated 2026-07-04, filed under STREAMZIP(1p). go forth and pipe something, ily 💜

📦 where this page comes from