nyraxle / gisthrower

NodeJS CLI to manipulate gists

![codecov] (https://codecov.io/gh/nyraxle/gisthrower/branch/master/graph/badge.svg)

Gisthrower - A minimalist CLI to manage gists

Manage your gists from command line using Personal access tokens from GitHub

---

Install

$ npm install -g gisthrower

Usage

Usage: gisthrower [command] <parameter> {OPTIONS} <parameters>

Standard Options:
    --version, -v                    Get versions of package
       --help, -h                    Get CLI help
       --auth, -a  <user>:<token>    Save personal access token and username

Commands:
             list                    List gists
             gist  <id>              Get details from a single gist based on his <id>

List command:

List
Usage:
                    list  {OPTIONS}

Options:
               --all, -a                           List all gists from current saved user/token
           --starred, -s                           List only starred gists
         --from-user, -f     <username>            List all public gists from specific user
              --rage, -r     <from>-<to>           List all gists in a given rage (index list based)

Gist
Usage:
                    gist     <id>                  Get details from a single gist

Options:
    --download-files, -d     <destination>         Download all files from a gist to a given destination folder
             --clone, -c     <destination>         Clone your gist repository to a given repository
              --more, -m                           Get detailed informations about referenced gist
              --open, -o     [browser]             Open the gist in specified browser (default if browser isn't specified)

Development

$ npm link          # create the symlink to gisthrower command to your working folder
$ gulp test:mocha   # run mocha tests
$ gulp lint         # lint the code using avaiable es6 features*
$ npm test          # run codecoverage

Test User Environment process.env

• TEST_USER: valid github user
• TEST_USER: valid github token

Roadmap

TODO

TODO:
-  Create Gists
-  Point files to include on gist (fs IO)
-  Create a version history file
-  Edit Gists
-  Delete Gists
-  Create release notes
-  Star Gists
-  Unstar Gists

DONE:
-  Open a referenced gist on default system browser
-  Get detailed informations about a single gist
-  Clone gist repository to a local folder
-  Get details from a single gist
-  Show dependencies
-  100% coverage
-  Apply on Travis.ci

notes

• Github api v3
• Github authentication using Personal Access Token
• Commander (User for CLI)

gisthrower's Issues

Fix: CLI node path location on Debian dist

CLI doesn't work on debian after npm i -g gisthrower