A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://www.npmjs.com/package/github-stats below:

github-stats - npm

$ github-stats

Visualize stats about GitHub users and projects in your terminal.

This project is under the git-stats umbrella. git-stats tracks your local commits and the visualization is similar. ❇️

github-profile-languages provides the same pie chart visualization, but in browser (for users and repositories).

☁️ Installation

You can install the package globally and use it as command line tool:

npm install --global github-stats

 

yarn global add github-stats

Then, run github-stats --help and see what the CLI tool can do.

$ github-stats --help
Usage: github-stats [options]

Options:
  -u, --user <user>        The GitHub user to get stats about.
  -r, --repo <repository>  The full repository name.
  -n, --no-ansi            Disable ansi styles.
  -l, --light              Use the light theme.
  -c, --calendar           Show the calendar.
  --us, --user-stats       Display user stats.
  --rs, --repo-stats       Display repository stats.
  --ah, --alt-host <host>  Alternate Github host.
  -t, --token <token>      GitHub access token to access private resources or
                           to increase the rate limit.
  -h, --help               Displays this help.
  -v, --version            Displays version information.

Examples:
  gh-stats -u IonicaBizau -r gh-stats --us --rs -c # Show everything
  gh-stats -u IonicaBizau # Show the calendar
  gh-stats -r IonicaBizau/git-stats --alt-host https://github.myhost.com/api/v3/ # Repository stats from hosted Github

Documentation can be found at https://github.com/IonicaBizau/gh-stats
📋 Example

Here is an example how to use this package as library. To install it locally, as library, you can use npm install github-stats (or yarn add github-stats):

var GitHubStats = require("github-stats");

 

var stats = new GitHubStats({

 

    

    theme: "LIGHT"

 

    

  , repo: "hubber-memory-game"

  , user: "alysonla"

 

    

  , s_repo: true

  , s_user: true

  , cal: true

 

    

  , token: "an optional token"

});

 

stats.toString(function (err, output, warns) {

    console.log(err || output);

});

❓ Get Help

There are few ways to get help:

  1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
  2. For bug reports and feature requests, open issues. 🐛
  3. For direct and quick help, you can use Codementor. 🚀
📝 Documentation

For full API reference, see the DOCUMENTATION.md file.

😋 How to contribute

Have an idea? Found a bug? See how to contribute.

💖 Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

Thanks! ❤️

📜 License

MIT © Ionică Bizău


RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4