Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

harshasrinivas/cli-github

Open more actions menu

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

cli-github

A Command-Line Python Application to display Github from the CLI ! License

Version Downloads
PyPI version PyPi downloads

gif

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=<your-token-with-quotes>

Github Token as Permanent Environment Variable

$ echo "export GITHUB_TOKEN=<your-token-with-quotes>" | 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 = <your-token-with-quotes>/" > cli_github/mains.py


Options

-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 : Display the list of a user's repositories from the username/URL, along with the number of stargazers

DEMO : Display all the folders and files within a repository recursively from the repository URL, along with their sizes

DEMO : To get the RAW version of the readme file of a repository from the repository URL

DEMO : To get the list of releases from the user's repository URL

DEMO : Download the tarball from the user's repository URL

DEMO : Download the zipball from the user's repository URL

DEMO : Show the contents of a given file/folder

DEMO : 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

About

Github within the CLI 💻

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 6

Morty Proxy This is a proxified and sanitized view of the page, visit original site.