https://github.com/kanasimi/gh-updater
GitHub repository auto-updater using 7zip or unzip
https://github.com/kanasimi/gh-updater
auto-updater github updater updater-script
Last synced: about 2 months ago
JSON representation
GitHub repository auto-updater using 7zip or unzip
- Host: GitHub
- URL: https://github.com/kanasimi/gh-updater
- Owner: kanasimi
- Created: 2018-09-08T08:38:51.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-05-16T21:12:36.000Z (about 4 years ago)
- Last Synced: 2025-03-13T02:08:49.805Z (2 months ago)
- Topics: auto-updater, github, updater, updater-script
- Language: JavaScript
- Size: 66.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/gh-updater)
[](https://www.npmjs.com/package/gh-updater)
[](https://travis-ci.com/kanasimi/gh-updater)
[](https://codecov.io/gh/kanasimi/gh-updater)
[](https://snyk.io/test/github/kanasimi/gh-updater?targetFile=package.json)
[](https://codebeat.co/projects/github-com-kanasimi-gh-updater-master)
[](https://app.codacy.com/app/kanasimi/gh-updater?utm_source=github.com&utm_medium=referral&utm_content=kanasimi/gh-updater&utm_campaign=Badge_Grade_Settings)
[](https://deepscan.io/dashboard#view=project&tid=4788&pid=6556&bid=55215)
# GitHub repository auto-updater
The project aims to develop a GitHub repository auto-updater tool using 7-Zip or unzip.
## Installation
1. Install [node.js](https://nodejs.org/). For windows, please also install [7-Zip](https://www.7-zip.org/) 18.01+.
2. Install gh-updater via npm:
```bash
npm i gh-updater
```
## Usage
Here lists the usage of this tool.
### As CLI update tool
If installed as `node_modules/.bin/gh-updater`:
```bash
node_modules/.bin/gh-updater user/repository-branch [target_directory]
```
Or under Windows:
```bat
node_modules\.bin\gh-updater user/repository-branch [target_directory]
```
The commands above will extract `user/repository-branch` in default target directory: `repository-branch/`
e.g.,
```bash
# install into gh-updater-master/
node_modules/.bin/gh-updater kanasimi/gh-updater-master
# install into **current directory**
node_modules/.bin/gh-updater kanasimi/gh-updater-master .
```
Testing `GitHub.updater.node.js`:
```bash
node GitHub.updater.node.js user/repository-branch [target_directory]
```
### As node.js module
```javascript
const updater = require('gh-updater');
// to check version
updater.check_version('kanasimi/gh-updater-master', version_data => console.log(version_data) );
// to update
updater.update('kanasimi/gh-updater-master', '.');
```
## OS support
| Platform | support |
| --- | --- |
| Windows | ✔️ |
| macOS | ✔️ |
| UNIX, Linux | ✔️ |
## Requires
In UNIX or macOS, thie update tool will use unzip to extract files.
In Windows, the client must install [7-Zip](https://en.wikipedia.org/wiki/7-Zip) first.
## Note
The update tool checks the latest commits of GitHub repository, NOT releases or npm package.
## Contact 聯絡我們
Contact us at [GitHub](https://github.com/kanasimi/gh-updater/issues).
[](http://lyrics.meicho.com.tw/)