https://github.com/harshasrinivas/cli-github
Github within the CLI :computer:
https://github.com/harshasrinivas/cli-github
Last synced: 5 days ago
JSON representation
Github within the CLI :computer:
- Host: GitHub
- URL: https://github.com/harshasrinivas/cli-github
- Owner: harshasrinivas
- License: gpl-3.0
- Created: 2015-06-26T18:39:37.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-04-18T09:34:13.000Z (almost 9 years ago)
- Last Synced: 2026-01-05T12:40:51.436Z (14 days ago)
- Language: Python
- Homepage:
- Size: 996 KB
- Stars: 174
- Watchers: 7
- Forks: 17
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-github - cli-github - Github made pretty, within the command line. (Tips, tricks, tools, and add-ons for GitHub power users)
README
# `cli-github`
**A Command-Line Python Application to display Github from the CLI !** 
| Version | Downloads |
| -------- | --------- |
| [](http://badge.fury.io/py/cli_github) | [](https://pypi.python.org/pypi/cli-github)
# Installation
## Using `pip`
`pip install cli-github`
## Get the latest build from the Source
* Clone the repo `git clone https://github.com/harshasrinivas/cli-github.git`
* Run `python setup.py install`
## Building debian package
* Clone the repo.
* Execute `bash build_deb/build_deb.sh`
## Dependencies
* prettytable `pip install prettytable`
* future `pip install future`
* python-dateutil `pip install python-dateutil`
# Setting Up
**Github Token as Temporary Environment Variable**
`$ GITHUB_TOKEN=`
**Github Token as Permanent Environment Variable**
`$ echo "export GITHUB_TOKEN=" | sudo tee -a /etc/environment`
**Without saving your Environment Variable**
`$ cat cli_github/mains.py | sed -e "s/API_TOKEN = os.environ.get('GITHUB_TOKEN')/API_TOKEN = /" > cli_github/mains.py`
# Options
```sh
-h, --help show this help message and exit
-n URL, --url URL
Get repos from the user profile URL/USERNAME
-r RECURSIVE, --recursive RECURSIVE
Get the file structure from the repo link URL
-R README, --readme README
Get the raw version of the repository readme file from repo link URL
-re RELEASES, --releases RELEASES
Get the list of releases from repo link
-dt TARBALL, --tarball TARBALL
Download the tarball from repo link
-dz ZIPBALL, --zipball ZIPBALL
Download the zipball from repo link
-op OPENFILE, --openfile OPENFILE
Show the contents of the given file in a repo
-f FOLLOWERS, --followers FOLLOWERS
Get followers of the user
-fo FOLLOWING, --following FOLLOWING
Get people following the user
-c CONTRIBUTORS, --contributors CONTRIBUTORS
Get contributors of a repo
```
# Usage
Display the list of a user's repositories from the username/URL, along with the number of stargazers
`$ cli-github -n harshasrinivas`
Display all the files and folders within a repository recursively from the repository URL, along with their sizes
`$ cli-github -r harshasrinivas/cli-github`
Get the RAW version of the readme file of a repository from the repository URL
`$ cli-github -R harshasrinivas/cli-github`
Get the list of releases from the user's repo link
`$ cli-github -re harshasrinivas/cli-github`
Download the tarball of the any repo
`$ cli-github -dt harshasrinivas/cli-github`
Download the zipball of the any repo
`$ cli-github -dz harshasrinivas/cli-github`
List the contents of the given folder
`$ cli-github -op harshasrinivas/cli-github/setup.py`
Get the list of followers of the user
`$ cli-github -f harshasrinivas`
Get the list of people following the user
`$ cli-github -fo harshasrinivas`
Get the contributors of a repo
`$ cli-github -fo harshasrinivas/cli-github`
# Live Demo
[**DEMO**](http://showterm.io/aaa79dee63aad0695e304#fast) : Display the list of a user's repositories from the username/URL, along with the number of stargazers
[**DEMO**](http://showterm.io/99e16e6ae35727999eb23#fast) : Display all the folders and files within a repository recursively from the repository URL, along with their sizes
[**DEMO**](http://showterm.io/820b37fab14c7ed4cf7ff#fast) : To get the RAW version of the readme file of a repository from the repository URL
[**DEMO**](http://showterm.io/24a6ceec356bb672ec24f#fast) : To get the list of releases from the user's repository URL
[**DEMO**](http://showterm.io/bb2245e764781b11b1b78#fast) : Download the tarball from the user's repository URL
[**DEMO**](http://showterm.io/910e8e424f28cfe3b4a22#fast) : Download the zipball from the user's repository URL
[**DEMO**](http://showterm.io/4dcfaca8c50f912e3c609#fast) : Show the contents of a given file/folder
[**DEMO**](http://showterm.io/9bfd25a48074fb2ca8211#fast) : List the followers of a user
# Contribute
If you want to add features, improve them, or report issues, feel free to send a pull request.
# Contributors
* [SanketDG](https://github.com/SanketDG)
* [Pratik151](https://github.com/Pratik151)