node-opkg
A simple command-line wrapper around the openwrt opkg
package manager.
Allows to usage with a Node API.
Information: https://wiki.openwrt.org/doc/techref/opkg
Installation
Available as npm module:
npm install node-opkg
Usage
All methods return Promise
s. Command line options can be defined in the following ways:
{forceDepends: null, V: 4}
[--force-depends, -V4]
You can also get the output streams via the options argument:
{
forceDepends: null,
_stdout: (stdout) => {},
_stderr: (stderr) => {}
}
Functions
Promise
update ⇒ Update package lists (update
)
Param | Type | Description |
---|---|---|
[opts] | Array | Object |
Command-line options |
Promise
upgrade ⇒ Upgrade package(s) (upgrade
)
Param | Type | Description |
---|---|---|
pkg | String | Array.<String> |
Package(s) |
[opts] | Array | Object |
Command-line options |
Promise
install ⇒ Install package(s) (install
)
Param | Type | Description |
---|---|---|
pkg | String | Array.<String> |
Package(s) |
[opts] | Array | Object |
Command-line options |
Promise
configure ⇒ Configure package(s) (configure
)
Param | Type | Description |
---|---|---|
pkg | String | Array.<String> |
Package(s) |
[opts] | Array | Object |
Command-line options |
Promise
remove ⇒ Remove package(s) (remove
)
Param | Type | Description |
---|---|---|
pkg | String | Array.<String> |
Package(s) |
[opts] | Array | Object |
Command-line options |
Promise
flag ⇒ Flag package(s) (flag
)
Param | Type | Description |
---|---|---|
flag | String |
Flag |
pkg | String | Array.<String> |
Package(s) |
[opts] | Array | Object |
Command-line options |
Promise
list ⇒ Lists packages (list
)
Param | Type | Description |
---|---|---|
list | String |
List type ('available', 'installed', 'upgradable') |
[pkg] | String | Array.<String> |
Argument for 'available' |
[opts] | Array | Object |
Command-line options |
Promise
listPackages ⇒ Lists available packages (list
)
Param | Type | Description |
---|---|---|
[pkg] | String | Array.<String> |
Package name(s) |
[opts] | Array | Object |
Command-line options |
Promise
listPackages ⇒ Lists installed packages (list
)
Param | Type | Description |
---|---|---|
[opts] | Array | Object |
Command-line options |
Promise
listPackages ⇒ Lists upgradable packages (list
)
Param | Type | Description |
---|---|---|
[opts] | Array | Object |
Command-line options |
Promise
changedConffiles ⇒ Lists changed config files (list-changed-conffiles
)
Param | Type | Description |
---|---|---|
[opts] | Array | Object |
Command-line options |
Promise
files ⇒ Shows package files (files
)
Param | Type | Description |
---|---|---|
pkg | String | Array.<String> |
Package name(s) |
[opts] | Array | Object |
Command-line options |
Promise
status ⇒ Find package providing given file
Param | Type | Description |
---|---|---|
q | String |
Query |
[opts] | Array | Object |
Command-line options |
Promise
info ⇒ Shows package info (info
)
Param | Type | Description |
---|---|---|
pkg | String | Array.<String> |
Package name(s) |
[opts] | Array | Object |
Command-line options |
Promise
status ⇒ Shows package status(es) (status
)
Param | Type | Description |
---|---|---|
[pkg] | String | Array.<String> |
Package name(s) |
[opts] | Array | Object |
Command-line options |
Promise
find ⇒ Finds a package by query string
Param | Type | Description |
---|---|---|
q | String |
Query string |
setExecPath
Sets the opkg
executable path
Param | Type | Description |
---|---|---|
path | String |
Path to executable |
Changelog
- 0.5.0 - Initial release