Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/frederickgeek8/unipkg
Multi-platform implementation of dpkg
https://github.com/frederickgeek8/unipkg
cli debian dpkg multi-platform
Last synced: 10 days ago
JSON representation
Multi-platform implementation of dpkg
- Host: GitHub
- URL: https://github.com/frederickgeek8/unipkg
- Owner: FrederickGeek8
- License: lgpl-3.0
- Created: 2018-05-25T02:48:28.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-22T05:27:40.000Z (5 months ago)
- Last Synced: 2024-10-20T09:15:02.622Z (17 days ago)
- Topics: cli, debian, dpkg, multi-platform
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/unipkg
- Size: 255 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# unipkg
[](https://www.npmjs.com/package/unipkg)
Multi-platform implementation of dpkg (in Javascript) with a programming and
command-line interface.
## Requirements
This project has been tested (via our Jest tests) on Node v18.20.3 and v20.15.0.
The project depends on `fs-extra`, `klaw`, `tmp`, `tar`, all of which should be
installed by NPM or Yarn when installing the package. This should *in theory* run
on Windows, macOS, and Linux.
## Installation
`unipkg` can be installed by either NPM or Yarn, however, for the average user
`unipkg` can be globally installed (meaning the `unipkg` binaries and libraries
are in your path) by running
```bash
npm install -g unipkg
```
or, of course, locally by running
```bash
npm install unipkg
```
## Usage
`unipkg` has both a interface for Node.js as well as a command-line interface.
The command line usage is as follows:
```bash
Usage: unipkg [options] [command]
Options:
-V, --version output the version number
-h, --help output usage information
Commands:
scan|s
Implementation of the dpkg-scanpackages -m command.
is the directory to be scanned for Debian packages (.deb files).
these will be added to a Packages index file which will be output in the current
directory.
build|b []
Implementation of the dpkg-deb -b command.
is the well structured package folder which should
contain both the DEBIAN folder and the data of the package.
[] is the optional output filename and path of the resulting Debian
format archive. It defaults to outputting a deb file in the current working
directory using the standard Debian name scheme.
```
The following is boilerplate code for the Node.js interface. The Node.js interface
has the same usage and parameters as the CLI. Each function will return a Promise.
```node
const dpkg = require("unipkg");
const pkg = "path/to/repo/deb/root";
const repo = "path/to/repo"
dpkg.build(pkg).then(
path => {
console.log(`The Debian package ${path} has been successfully written.`);
},
err => {
console.error(`Error: ${err}`);
}
);
dpkg.scan(repo).then(
path => {
console.log(`Your repository has been successfully created.`);
},
err => {
console.error(`Error: ${err}`);
}
)
```
## Contributing
Feel free to submit issues or pull requests to the repository. Before contributing,
please read our [Contributing Guide](CONTRIBUTING.md).
## Related Readings
* [Overview of `control` file fields](http://www.sosst.sk/doc/debian-policy/policy.html/ch-controlfields.html)
* [Debian Maintainer's Guide](https://www.debian.org/doc/manuals/maint-guide/index.en.html)
* [Environment Variable Definition](http://pubs.opengroup.org/onlinepubs/000095399/basedefs/xbd_chap08.html)
* [`ar` File Format](https://en.wikipedia.org/wiki/Ar_%28Unix%29#File_format_details)
## Related Software
Despite my best efforts to initially find alternative software before beginning
development of this project, before publishing I found several alterative to this
package. Honestly, if I had found these before probably would not have persued
writing my own library for this.
1. [debpkg](https://github.com/xor-gate/debpkg) by xor-gate is a is a pure Go
library to create Debian packages. It has zero dependencies to Debian. It is
able to generate packages from Mac OS X, *BSD and Windows.
2. [dpkg-build](https://github.com/wr1241/dpkg-build) by wr1241 seems to be a
largely non-active repository, however, it provides much of the same functionality
of this library's API (sans CLI).