git-file-downloader
v1.4.0
Published
Git File Downloader is a CLI tool to download a raw file from Github or Gitlab.
Downloads
68
Readme
Git File Downloader
Git File Downloader is a CLI tool to download a raw file from Github or Gitlab.
Install
$ npm i -g git-file-downloader
Usage
Usage: gfd [options] <repository> <file>
Or
Usage: git-file-downloader [options] <repository> <file>
Download a raw file from Github or Gitlab
Options:
-h, --help output usage information
-V, --version output the version number
-p, --provider <provider> Set git provider. Supported providers: "github", "gitlab".
-o, --output <path> Set the output directory. Default to current location.
-k, --keep-original-path Option to keep original path inside output directory. By default, it will place the single file inside output directory.
-b, --branch <path> Set the branch name. Default to "master".
--github-basic-username <username> Set Github Basic Auth Username.
--github-basic-password <password> Set Github Basic Auth Password.
--github-oauth-token <token> Set Github OAuth2 Token.
--gitlab-private-token <token> Set Gitlab Private Token.
Examples
Download a file from a public github repository
$ gfd L0gIn/devops-toolbox examples/nodejs-serverless.dotbox.json
Download a file from a public gitlab repository
$ gfd -p gitlab L0gIn/git-file-downloader README.md
Use this package in your own project
$ npm i --save git-file-downloader
# Or
$ yarn add git-file-downloader
const GitFileDownloader = require('git-file-downloader');
const downloader = new GitFileDownloader({
provider: 'gitlab',
repository: 'L0gIn/git-file-downloader',
branch: 'master',
file: 'README.md',
output: '.'
});
downloader.run().catch(err => {
console.error(err);
process.exitCode = 1;
});
More usages in test/git-file-downloader.test.js
.