Skip to content
This repository has been archived by the owner on Nov 3, 2021. It is now read-only.

jakethedev/noish

Repository files navigation

Noish: The Github Issue Viewer

NOTICE: I built Noish to hit public github repos for issues and store them locally, so you could list them out or search through them by title or description. But, the times have changed, and Github came out with Hub - a fantastic, fully idealized version of this tool that totally supercedes this. Go use that one, this repo is now just another deprecated project :)

Remainder of the README is what it was before deprecation.

Usage

Noish works best globally installed. Make sure you have node 8+, then give it a whirl with npm install --global noish, and if your path is set up correctly, noish -h should work for you after that.

Noish runs on the repo containing the current directory: noish command [option]. You can override the repo Noish looks at for all repo-based commands with -r: noish -r username/reponame command [option]

Below is a list of commands Noish recognizes. Each is in shorthand but can be spelled out: -h/--help, -c/--issueCount, -f/--savefile, -i/--id, -l/--list, -r/--repo, -s/--search, and -u/--update

  • -h: Prints version and usage info
  • -f $filepath: Force read or write from $filepath instead of ~/.noish/$repo.json
  • -i $id: Print detailed information about an issue with issue number $id for $repo
  • -l: List id, title, and status of $repo's cached issues
  • -r $override: Set $repo to $override, must be in the form of 'username/reponame'
  • -s: Caseless search of local $repo cache by issue title and description
  • -u: Updates cache for $repo. Currently there is no merge, it rewrites the local cache. Defaults to 50 most recent open issues

Development

There's not much to know. Just make sure you're running node 8+, and if you add anything to this repo or a fork, please make sure to keep minimal dependencies in mind. Axios is really tiny compared to requests, for instance, and minimalism is important here

Comments, suggestions, feature requests, and feedback

Drop me an issue or ping me on Twitter

About

CLI Github Issue Viewer: I built this before github released the Hub CLI, which is way better than this, by like a long shot haha. Check it out here: https://github.com/github/hub

Topics

Resources

Stars

Watchers

Forks