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

github-download-parts

v2.1.0

Published

Download a partial folder of your Github repository.

Downloads

185

Readme

English | 简体中文

github-download-parts

npm package NPM downloads GitHub issues Build Status

It is able to download a partial of repository!

Usage

  • Download a single file
const repo = require('github-download-parts');

// download the `index.js` file to `target` folder
repo('pspgbhu/github-download-parts', 'target', 'index.js')
  .then(() => {
    console.log('download success');
  })
  .catch(() => {
    console.log('download error');
  }
  • Download a folder
const repo = require('github-download-parts');

// download all files in the `test` folder of github repository to the local `target` folder.
repo('pspgbhu/github-download-parts', 'target', 'test')
  .then(() => {
    console.log('download success');
  })
  .catch(() => {
    console.log('download error');
  });
  • Download a whole repository
const repo = require('github-download-parts');

// download the whole repository into target local folder
repo('pspgbhu/github-download-parts', 'target')
  .then(() => {
    console.log('download success');
  })
  .catch(() => {
    console.log('download error');
  });

API

repo(options [, target ,pathname])

  • options <string>

    Could input a string as the options, the format is "${username}/${repository}".

  • target <string>

    The local folder path that files will be created into.

  • pathname <string>

    A file or folder path of github repository.

Or you could use a object as the options parameter

  • options <object>
    • username <string>: The username of github.
    • repository <string>: The name of the repository.
    • repo <string>: The shorthand for username and repository, the format is "${username}/${respository}"
    • target <string>: The local folder path that files will be created into.
    • pathname <string>: A file or folder path of github repository.

CLI

Install

# Install the package
$ npm i -g github-download-parts

# Show more information about github-download-parts cli
$ repo -h

Example

  • Download a file or folder form someone github repository
$ repo -r "username/repository" -t local_folder -p target_file.js
  • Download the whole repository
$ repo -r "username/repository" -t local_folder

Options

  • -r --repo <repo>: Github repository, the format is "${username}/${repository}"

  • -t --target <dir>: The local directory that files will be created into

  • -p --pathname <path>: The file or folder path of github repository you want to download

Download Limiting

Because of Github API Rate Limiting, every IP only be allowed 60 requests per hour, So every IP just only could download 60 times per hour.

Know More About Github Rate Limiting