zimfw/archive

Provides functions for easy archive manipulation.

archive

Provides archive, unarchive and lsarchive functions for easy archive manipulation based on file extensions.

Don't remember the complete tar command to compress, uncompress or list the contents of an archive? Use archive myarchive.tar.gz /path/to/be/archived to compress, unarchive myarchive.tar.gz to uncompress or lsarchive myarchive.tar.gz to list, for example, and the respective functions will take care of the underlying command for you. They also work with the other archive extensions listed below.

Suffix aliases are also provided so files can be directly uncompressed.

This module will make use of pbzip2 and pigz if available to make use of all available CPU cores.

Functions

Name	Usage
archive compresses files into an archive.	archive <archive_name.ext> <file>...
unarchive uncompresses from archives.	unarchive <archive_name.ext>...
lsarchive lists the contents of archives.	lsarchive <archive_name.ext>...

Archive extensions

Extensions	Required commands
.7z, .001	7za
.rar	unrar or rar
.tar.bz, .tar.bz2, .tbz, .tbz2	tar
.tar.gz, .tgz	tar
.tar.lzma, .tlz	tar with lzma support or with lzcat
.tar.xz, .txz	tar with xz support or with xzcat
.tar.zst, .tzst	tar with unzstd
.tar	tar
.zip	unzip
.bz, .bz2	pbunzip2 or bunzip2
.gz	unpigz or gunzip
.lzma	unzlma
.xz	unxz
.zst	zstd
.Z	uncompress

archive's Issues

maybe some explanation about what `archive` does

Is your feature request related to a problem? Please describe.

Hello guys, I'm new to lots of things about Unix
When I first looked at this module I thought it was about compressing but with the name archive.
So I started playing and it took me to a website that apparently archives files on a web database. I haven't read the about on this website, but I'd suggest a bit of explanation about what archive is, this may help beginners to want to install it.

[EDIT] Its late in the night I tried the archive in a new environment and it work good, I need to test, but I'm almost pretty sure is that the plugin web-search of ohmyzsh is in conflict with archive. I will do more tests tomorrow to open a bug

Describe the solution you'd like

Some tl;dr on this page, or some --help on the command

Describe alternatives you've considered

A hyperlink to the website of archive where explains how it works

Additional context

No response

Unarchive output directory

Would it be valuable to add option to specify output directory? I just had a situation where I did unarchive archive.zip and got extracted files spread all over the current directory.

Currently I have to first move the archive into destination directory so something like unarchive archive.zip -o output_dir might be preferable

is it possible to add autocomplete for archives?

Prezto already has auto complete so probably we need to bring them here.