finnp/cpio-stream

streaming cpio parser and packer

cpio-stream

cpio-stream is a streaming cpio packer. It is basically the cpio version on tar-stream.

Support

Extraction

• odc / old character
• newc / new character
• crc / new crc note: checksum will not be tested nor rejected!

Packing

• odc / old character

Mostly following the libarchive documentation documentation. Feel free to create pull requests to add additional format support!

Packing

var cpio = require('cpio-stream')
var pack = cpio.pack()

pack.entry({name: 'my-test.txt'}, 'hello, world\n')

var entry = pack.entry({'my-stream-test.txt', size: 11}, function (err) {
  // stream was added
  // no more entries
  pack.finalize()
})

entry.write('hello')
entry.write(' world')
entry.end()

// pipe the archive somewhere
pack.pipe(process.stdout)

Extracting

var extract = cpio.extract()

extract.on('entry', function (header, stream, callback) {
  stream.on('end', function () {
    callback()
  })

  stream.resume() // auto drain
})

extract.on('finish', function () {
  // all entries read
})

pack.pipe(extract)

License

MIT, with some of the code taken from the tar-stream module by @mafintosh

cpio-stream's Issues

newc format

Is there's a posibility to add support for the newc format? Is the one used on the Linux kernel initramfs... It would be useful for NodeOS.

More than 2 files is currently broken with node 14 see PR for fix

Sparse file support

It appears that your streaming cpio parser does not support sparse files. Am I mistaken?

If it helps, GNU tar implements sparse support using:
http://git.savannah.gnu.org/cgit/tar.git/tree/src/sparse.c?id=63f2e969ddc162da7ae49a955bba9c6a2a0e77dc#n354

My question is relevant to this:
http://stackoverflow.com/questions/40166300/cross-platform-sparse-file-compression-with-nodejs