get-file

get-file

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

• repo {String}: Repository to get file from.
• filename {String}: file to get.
• cb {Function}: Callback function that takes err and res arguments.

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

• repo {String}: Repository to get list of files.
• cb {Function}: Function that takes err and files arguments

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

• the main export is now a function
• .listFiles was renamed to .files

About

Related projects

• gists: Methods for working with the GitHub Gist API. Node.js/JavaScript | homepage
• github-base: JavaScript wrapper that greatly simplifies working with GitHub's API. | homepage
• github-contributors: Generate a markdown or JSON list of contributors for a project using the GitHub API. | homepage

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

• github/jonschlinkert
• twitter/jonschlinkert

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.