githubls

githubls is a simple command line utility tool, written as part of a Github backup script. The purpose of the tool is to provide a list of repositories of a given user. Furthermore, the tool has the ability to provide clone URLs which are directly usable - even for private repositories - without furhter setup except a git command line tool.

The tool is build with node and pkg for packaging the app for the different platforms.

Usage

To retrieve a list of repositories, you have to define which user is retreiving the repositories and a corresponding access token.

If not provided, the tool will tell you what’s missing.

Simple Output

> ./githubls-linux
Optionen:
      --version   Version anzeigen                                     [boolean]
  -u, --user      Github user name                                [erforderlich]
  -t, --token     Access Token of Github required for REST API    [erforderlich]
  -p, --password  Password of Github user
      --help      Hilfe anzeigen                                       [boolean]

Fehlende Argumente: user, token
User and token are required

Building

The script is very simple and only pulls in two dependencies for the command line args parsing and a HTTP network client library.

These are the simple steps to get the tool for local development up and running:

Initial Checkout

> git clone https://github.com/schlingel/githubls.git

After the initial checkout, you have to install the dependencies.

Install Dependencies

> npm i

Node you’re ready to start development. You may test if the tool is working by invoking node index.js. When you’re ready, you may package the app.

Package app

> npm run package