Skip to main content

Command-line access to GitHub via github3.py

Project description

github-cli

Build Status

This tool provides partial itneraction with GitHub and its API from the command line. This tool is far from complete or comprehensive.

Dependencies

Current Usage

If you would like command completion, look in the completion directory for your shell of choice. If you don’t see one for your shell, feel free to send a pull request adding one! Note: The current bash completion is imperfect so feel free to improve on it and send pull requests.

To get a comprehensive look at the following commands, use their help pages like below.

help

$ gh help
# Alternatively gh -h
$ gh help follow
$ gh help fork
$ gh help gists
$ gh help issues
$ gh help my
$ gh help pulls
$ gh help repos
$ gh help unfollow

follow

$ gh follow kennethreitz
$ gh follow sigmavirus24

fork

$ gh fork kennethreitz/requests
$ gh fork sigmavirus24/github3.py
$ gh fork sigmavirus24/github-cli

gists

$ gh gists
$ gh gists -u sigmavirus24
$ gh gists create -d "Public gist" file1.rb file2.rb file3.rb
$ gh gists create -p -d "Private gist" file1.py file2.py file3.py

issues

$ cd path/to/repo/on/GitHub
$ gh issues
$ gh sigmavirus24/github3.py issues
$ gh sigmavirus24/github3.py issues 48
$ gh issues 48 close
$ gh issues 48 reopen
$ gh issues 48 comment
$ gh issues 48 comments

my

$ gh my notifications
$ gh my dashboard
$ gh my issues
$ gh my stars
$ gh my profile

pulls

$ cd path/to/repo/on/GitHub
$ gh pulls
$ gh pulls 48 merge
$ gh pulls 48 close
$ gh pulls 48 comments
$ gh pulls create -h
$ gh pulls create -t "Pull Request Title" kennethreitz:master develop

repos

$ gh repos
$ gh repos create new_repo
$ gh repos -o orgname create new_repo

unfollow

$ gh unfollow sigmavirus24

License

GPLv3

0.1.0 xxxx-xx-xx

First version includes the ability to:

  • follow/unfollow a user

  • create a gist

  • (create/close/reopen/comment on/list comments on) an issue

  • create/list/fork repositories

  • print out your dashboard, notifications, stars, and issues

  • (create/close/reopen/merge) pull requests

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gh-cli-0.1.b.tar.gz (25.6 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page