Code Monkey home page Code Monkey logo

gitlab-download's Introduction

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-dowload

var GitlabDownload = require('gitlab-dowload');
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. Uses the current working directory if nothing is specified.
    • ref: Gitlab reference (branch, tag, or commit). Default : master
    • downloadOptions: Options for download api

Returns a GithubDownloader object that emits events on dir, file, and end.

Example:

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

License

(WTFPL License)

gitlab-download's People

Contributors

eyolas avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.