tar

Creating a tarball

This feature allows you to create a tarball. The example code demonstrates how to create a gzipped tarball named 'my-tarball.tgz' that contains 'file1.js' and 'file2.txt'.

const tar = require('tar');
tar.c(
  {
    gzip: true,
    file: 'my-tarball.tgz'
  },
  ['file1.js', 'file2.txt']
).then(_ => console.log('Tarball has been created.'));

Extracting a tarball

This feature allows you to extract files from a tarball. The example code demonstrates how to extract 'my-tarball.tgz' into the directory 'some/dir'.

const tar = require('tar');
tar.x(
  {
    file: 'my-tarball.tgz',
    C: 'some/dir'
  }
).then(_ => console.log('Tarball has been extracted.'));

Listing contents of a tarball

This feature allows you to list the contents of a tarball. The example code demonstrates how to list the paths of all files and directories in 'my-tarball.tgz'.

const tar = require('tar');
tar.t(
  {
    file: 'my-tarball.tgz',
    onentry: entry => console.log(entry.path)
  }
).then(_ => console.log('Contents have been listed.'));

Updating a tarball

This feature allows you to update a tarball by adding new files. The example code demonstrates how to add 'newfile.txt' to the existing 'my-tarball.tgz'.

const tar = require('tar');
tar.u(
  {
    file: 'my-tarball.tgz'
  },
  ['newfile.txt']
).then(_ => console.log('Tarball has been updated.'));