Home

Awesome

get-file NPM version NPM monthly downloads NPM total downloads Linux Build Status

CLI to get a single file from Github repository.

CLI

CLI installation

Install globally with npm

$ npm install --global get-file

CLI usage

Specify the repo and filename:

get-file assemble/assemble README.md

List files

See a list of files for a repo before downloading one:

get-file --list assemble/assemble

API

API installation

Install with npm:

$ npm install get-file

API usage

get

Get an individual file and return a stream in the callback.

Params

Example

var get = require('get-file');
get('jonschlinkert/get-file', 'package.json', function(err, res) {
  if (err) return console.error(err);
  var file = fs.createWriteStream('package.json');
  res.pipe(file);
});

.files

List the files in a given repository.

Params

Example

var get = require('get-file');
get.files('jonschlinkert/get-file', function(err, files) {
  if (err) return console.error(err);
  console.log(files);
});

Release history

v1.0.0 - MAJOR BREAKING CHANGES

About

Related projects

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.


This file was generated by verb-generate-readme, v0.6.0, on May 31, 2017.