cligh - Command-line Interface to GitHub

This is a simple command-line interface to the facilities of GitHub. It is written by Christopher Brannon [email protected]. The current version is 0.3, released July 23, 2016. It is by no means feature-complete. A friend and I consider it useful, but others may not.

Obtaining

Obtain the current stable version using this link: http://the-brannons.com/software/cligh-0.3.tar.gz. You can verify the integrity of the file using the gpg signature.

Installation

This program is written in Python 3.x. There is no backward compatibility with 2.x, since 3.x is the future.

cligh requires the PyGithub package. The homepage for PyGithub is https://github.com/jacquev6/PyGithub. It can also be installed using pip install PyGithub.

The final dependency is PyXDG. Get it from http://freedesktop.org/Software/pyxdg, or install it using pip install pyxdg.

Once the dependencies are installed, type ./setup.py install in the cligh source directory, in order to install the script and its helper modules.

Setup

Run the following command to configure cligh:

cligh configure

The program will prompt you for a username and password. It then creates an authorization using the Github API. cligh never stores your password. Instead, it stores the token associated with the authorization that it created. It uses this token to authenticate to Github.

Usage

Usage is straightforward, and the program provides informative help messages. Simply type cligh -h at a shell prompt, to see the introductory help message.

Development

The source for this project is managed by git. If you wish to contribute, or if you simply wish to use the unpublished "development" sources, clone it using a command such as the following:

git clone https://github.com/CMB/cligh.git

Patches are most appreciated. Please send them to [email protected].

Sunset

Cligh is no longer under active maintenance. It works. I'll likely fix it if it breaks, but there are no guarantees. Apparently some people still find the tool useful; it has features that other clients don't. If I do anything else with this, it'll be to add 2FA support.