npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

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

NPM Badge build status coverage report Codacy Badge JsDoc report Plato report

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.