# libui-download

> download libui prebuilt binary zips from github releases

Latest version **1.1.0** (published 2018-04-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install libui-download
pnpm add libui-download
yarn add libui-download
bun add libui-download
```

Provides the command `libui-download`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2018-04-30 |
| First published | 2016-06-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4 |
| Dependencies | 10 |
| Unpacked size | 11 KB |
| Known vulnerabilities | 0 (+14 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Andrea Parodi |
| Maintainers | parroit |
| Keywords | libui, libui-node, installer |

## Links

- npm: https://www.npmjs.com/package/libui-download
- Repository: https://github.com/parro-it/libui-download
- Homepage: https://github.com/parro-it/libui-download#readme
- Issues: https://github.com/parro-it/libui-download/issues
- npm.io page: https://npm.io/package/libui-download

## Dependencies (10)

- [mv](https://npm.io/package/mv.md) ^2.0.3
- [rc](https://npm.io/package/rc.md) ^1.1.2
- [tar](https://npm.io/package/tar.md) ^4.4.0
- [pify](https://npm.io/package/pify.md) ^2.3.0
- [debug](https://npm.io/package/debug.md) ^2.2.0
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.0
- [request](https://npm.io/package/request.md) ^2.85.0
- [home-path](https://npm.io/package/home-path.md) ^1.0.1
- [pinkie-promise](https://npm.io/package/pinkie-promise.md) ^2.0.1
- [regenerator-runtime](https://npm.io/package/regenerator-runtime.md) ^0.9.5

## Recent versions

- 1.1.0 (latest) — 2018-04-30
- 1.0.0 — 2018-03-06
- 0.1.1 — 2016-07-07
- 0.1.0 — 2016-07-07
- 0.0.3 — 2016-06-22
- 0.0.2 — 2016-06-22
- 0.0.1 — 2016-06-19

## README

# libui-download

[![Build Status](https://travis-ci.org/parro-it/libui-download.svg?branch=master)](https://travis-ci.org/parro-it/libui-download)

[![NPM](https://nodei.co/npm/libui-download.png)](https://nodei.co/npm/libui-download/)

downloads a libui release zip from github

used by [libui-node](https://npmjs.org/libui-node)

### usage

```plain
$ npm install --global libui-download
$ libui-download --version=0.31.1
```

```js
var download = require('libui-download');

const zipPath = await download({
	version: '0.25.1',
	arch: 'ia32',
	platform: 'win32',
	cache: './zips' // defaults to <user home directory>/.libui
});

// zipPath will be the path of the zip that it downloaded.
// if the zip was already cached it will skip
// downloading and call the cb with the cached zip path
// if it wasn't cached it will download the zip and save
// it in the cache path

```

if you don't specify `arch` or `platform` args it will use `require('os')` to get them from the current OS. specifying `version` is mandatory.

If you would like to override the mirror location, three options are available. The mirror URL is composed as `url = LIBUI_MIRROR + LIBUI_CUSTOM_DIR + '/' + LIBUI_CUSTOM_FILENAME`.

You can set the `LIBUI_MIRROR` or [`NPM_CONFIG_LIBUI_MIRROR`](https://docs.npmjs.com/misc/config#environment-variables) env or `mirror` opt variable to use a custom base URL for grabbing libui zips. The same pattern applies to `LIBUI_CUSTOM_DIR` and `LIBUI_CUSTOM_FILENAME`

```plain
## for a local mirror
LIBUI_MIRROR="https://10.1.2.105/"
LIBUI_CUSTOM_DIR="our/internal/filePath"
```

# Attribution

This is based on [electron-download](https://github.com/electron-userland/electron-download)
by @maxogden @mafintosh and @fritx. Thank you!

# License

The MIT License (MIT)

Copyright (c) 2016 parro-it

---
_Source: https://npm.io/package/libui-download · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
