node package manager
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

github-trees

github-trees NPM version NPM monthly downloads NPM total downloads

Get a tree from a GitHub repository.

Follow this project's author, Jon Schlinkert, for updates on this project and others.

Install

Install with npm:

$ npm install --save github-trees

Usage

See github-base for documentation for all options and authentication choices.

var tree = require('github-trees');
var opts = {
  username: 'YOUR_USERNAME',
  password: 'YOUR_PASSWORD'
};
 
tree('breakdance/breakdance', opts)
  .then(function(res) {
    console.log(res);
  })

Get a Tree Recursively

var tree = require('github-trees');
var opts = {
  recursive: true,
  username: 'YOUR_USERNAME',
  password: 'YOUR_PASSWORD'
};
 
tree('breakdance/breakdance', opts)
  .then(function(res) {
    console.log(res);
  })

About

Related projects

You might also be interested in these projects:

  • get-file: CLI to get a single file from Github repository. | homepage
  • 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
  • repos: Pull down a list of GitHub repositories for the specified user or org, and save… more | homepage
  • topics: Get and update GitHub repository topics. | homepage

Contributing

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

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

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 August 21, 2017.