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 Promises. 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

update ⇒ Promise

Update package lists (update)

| Param | Type | Description | | --- | --- | --- | | [opts] | Array | Object | Command-line options |

upgrade ⇒ Promise

Upgrade package(s) (upgrade)

| Param | Type | Description | | --- | --- | --- | | pkg | String | Array.<String> | Package(s) | | [opts] | Array | Object | Command-line options |

install ⇒ Promise

Install package(s) (install)

| Param | Type | Description | | --- | --- | --- | | pkg | String | Array.<String> | Package(s) | | [opts] | Array | Object | Command-line options |

configure ⇒ Promise

Configure package(s) (configure)

| Param | Type | Description | | --- | --- | --- | | pkg | String | Array.<String> | Package(s) | | [opts] | Array | Object | Command-line options |

remove ⇒ Promise

Remove package(s) (remove)

| Param | Type | Description | | --- | --- | --- | | pkg | String | Array.<String> | Package(s) | | [opts] | Array | Object | Command-line options |

flag ⇒ Promise

Flag package(s) (flag)

| Param | Type | Description | | --- | --- | --- | | flag | String | Flag | | pkg | String | Array.<String> | Package(s) | | [opts] | Array | Object | Command-line options |

list ⇒ Promise

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 |

listPackages ⇒ Promise

Lists available packages (list)

| Param | Type | Description | | --- | --- | --- | | [pkg] | String | Array.<String> | Package name(s) | | [opts] | Array | Object | Command-line options |

listPackages ⇒ Promise

Lists installed packages (list)

| Param | Type | Description | | --- | --- | --- | | [opts] | Array | Object | Command-line options |

listPackages ⇒ Promise

Lists upgradable packages (list)

| Param | Type | Description | | --- | --- | --- | | [opts] | Array | Object | Command-line options |

changedConffiles ⇒ Promise

Lists changed config files (list-changed-conffiles)

| Param | Type | Description | | --- | --- | --- | | [opts] | Array | Object | Command-line options |

files ⇒ Promise

Shows package files (files)

| Param | Type | Description | | --- | --- | --- | | pkg | String | Array.<String> | Package name(s) | | [opts] | Array | Object | Command-line options |

status ⇒ Promise

Find package providing given file

| Param | Type | Description | | --- | --- | --- | | q | String | Query | | [opts] | Array | Object | Command-line options |

info ⇒ Promise

Shows package info (info)

| Param | Type | Description | | --- | --- | --- | | pkg | String | Array.<String> | Package name(s) | | [opts] | Array | Object | Command-line options |

status ⇒ Promise

Shows package status(es) (status)

| Param | Type | Description | | --- | --- | --- | | [pkg] | String | Array.<String> | Package name(s) | | [opts] | Array | Object | Command-line options |

find ⇒ Promise

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