Giter Club home page Giter Club logo

rpm-extract's Introduction

rpmExtract

npm Build Status Code Climate Coverage Status

This module lets you programmatically extract files from an rpm package.

Note: This module doesn't run rpm install, nor it lets you do so programmatically. This is a simple utility to extract files from an rpm package.

Why not use rpm2cpio?

rpm2cpio is CLI tool to extract RPM packages on *nix distributions. Its an excellent and powerful tool to work in shell, but creating a script that works cross platform, is not so trivial. Furthermore, there is no interaction with file system (other than initial reading of the rpm), which makes this implementation faster than spawning child processes and doing file I/O.

Install

$ npm install rpm-extract

Usage

const rpmExtract = require('rpm-extract')

rpmExtract('path/to/file.rpm')
    .then(function(files) {
      // do something array of files
    })
    .catch(function(err){
      // handle errors
    })

API

file object

The file object contains the metadata as well as contents of the file. It includes:

Property Type Description
data Buffer File's contents, in a NodeJS buffer instance.
mode string Unix file permissions or modes.
mtime string Last modification time
path string File path as was specified while creating the package.
type string Unix file type.
linkname string Symbolic Link name, if the file is a link.

error object

error object is an instance of standard Node JS Error

Currently, the module throws 2 known errors

  • Not a valid rpm. - if the file is not an rpm package
  • Only gzip compressed cpio archives are supported. - if the rpm was created from anything other than a .tar.gz archive.

Tests

$ npm install
$ npm test

Caveats

This module only supports rpm files created with GZip compression, since gzip is the most common format that works across different OS/platforms. If you have a need for other compression formats such xz, bzip2 etc. create an issue or better, send a Pull Request.

References

License

ISC

Released 2016 by Hrusikesh Panda @ Dow Jones

rpm-extract's People

Contributors

mrchief avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

Forkers

tlhconsulting

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.