gitlab-download

Node.js - gitlab-download

Easily download Gitlab repos without any external dependencies such as Git, Tar, Unzip, etc.

Installation

npm install gitlab-download

Usage

instanciate new GitlabDownload(gitlabUrl, token)

Instanciate gitlab-download

var GitlabDownload = require('gitlab-download').default;
var gitlab = new GitlabDownload('https://mysgitlab.com', 'aze12233zae');

• gitlabUrl:
  • a Github URL string such as https://mysgitlab.com
• token: You private token.

download(params)

Downloads the latest copy of some Gitlab reference (branch, tag, or commit), or the master branch by default.

• params: Object of param:
  • remote: path of project (sample:eyolas/gitlab-download) (required)
  • dest: The output directory.
  • ref: Gitlab reference (branch, tag, or commit). Default : master
  • downloadOptions: Options for download api

Returns both a Promise<Buffer> and a Duplex stream with additional events.

Example:

var GitlabDownload = require('gitlab-download');
var gitlab = new GitlabDownload('https://mysgitlab.com', 'aze12233zae');
gitlab.download({remote: 'eyolas/gitlab-download'});

License

(WTFPL License)