An open API service indexing awesome lists of open source software.

https://github.com/joeattardi/tarjs

Command-line tar utility
https://github.com/joeattardi/tarjs

javascript nodejs tar tarball

Last synced: 7 months ago
JSON representation

Command-line tar utility

Awesome Lists containing this project

README

          

# tarjs

[![npm version](https://badge.fury.io/js/tarjs-cli.svg)](https://badge.fury.io/js/tarjs-cli)

Command-line tar utility

# Installation

npm install -g tarjs-cli

# Usage

tarjs [options] [files]

Multiple input files and directories can be specified.

# Options

## `-c, --create`

Creates a new tar archive. When this option is specified, the following options are required:

- The output file name (`-f`)
- One or more input files or directories, specified after the options

## `-t, --list`

Lists the contents of a tar archive. When this option is specified, the input file name (`-f`) is required.

## `-x, --extract`

Extracts the contents of a tar archive. When this option is specified, the input file name (`-f`) is required.

## `-v, --verbose`

Shows additional output.

## `-q, --quiet`

Shows minimal output. This is useful for using `tarjs` in scripts.

## `--exclude [pattern]`

Excludes files and directories that match the given pattern from the tar archive.

## `--portable`

Creates a tar archive without system-specific metadata. This allows you to create a tar file with the same checksum on different computers. This will omit all system-specific metadata *except* modification time. If you want to omit the modification time of all entries as well, specify the `--no-mtime` option.

## `--no-mtime`

Creates a tar archive without modification times on the entries. Usually used in conjunction with `--portable` to generate deterministic archives.

## `-f, --file [filename]`

The file to operate on.

When creating (`-c`), this is the name of the output file. It will be overwritten if it already exists.

When listing (`-t`), this is the name of the input file.

## `-C, --change [directory]`

When creating (`-c`), this is the directory to change into before adding the files to the tar archive. This can also be thought of as the base directory for the specified files and directories.

When extracting (`-x`), this is the directory to change into before extracing files from the tar archive. Note that this directory must exist before invoking `tarjs`.