Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ericjiang97/fetch-github-profile

Fetching GitHub Profile into Your Terminal
https://github.com/ericjiang97/fetch-github-profile

Last synced: 15 days ago
JSON representation

Fetching GitHub Profile into Your Terminal

Awesome Lists containing this project

README

        

# fetch-github-profile

Fetching a GitHub Profile Card directly into Your Terminal

[![npm version](https://badge.fury.io/js/fetch-github-profile.svg)](https://github.com/lorderikir/fetch-github-profile)

![](./images/demo.gif)

# Package Usage

## Installation

To install this run

```bash
npm install fetch-github-profile -g

yarn global add fetch-github-profile
```

## Running

To run simply type `fetch-github-profile`, you can also pass in a username argument with the `--user=""` flag.

## Flags

| Flag | Description |
| -------------------------------------- | ------------------------------ |
| `-v` or `--version` | Returns current version |
| `-r` or `--repos` | Lists top 5 most starred repos |
| `-u=` or `--user=` | Provide a user in |

## Developing

Simply clone this repository and use `yarn develop` or `npm run develop` to test it out. You may need to pass arguments in.

# LICENSE

This is licensed under `MIT`