# issue-explorer

> Explore Github issues from your terminal

Latest version **0.4.0** (published 2015-10-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install issue-explorer
pnpm add issue-explorer
yarn add issue-explorer
bun add issue-explorer
```

Provides the commands `gie`, `issue-explorer`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.0 |
| Published | 2015-10-03 |
| First published | 2015-08-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.10.0 |
| Dependencies | 14 |
| Known vulnerabilities | 0 (+11 in 4 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | GochoMugo |
| Maintainers | gochomugo |
| Keywords | github, issues, explorer, terminal |

## Links

- npm: https://www.npmjs.com/package/issue-explorer
- Repository: https://github.com/GochoMugo/issue-explorer
- Homepage: https://github.com/GochoMugo/issue-explorer#readme
- Issues: https://github.com/GochoMugo/issue-explorer/issues
- npm.io page: https://npm.io/package/issue-explorer

## Dependencies (14)

- [open](https://npm.io/package/open.md) 0.0.5
- [github](https://npm.io/package/github.md) 0.2.4
- [lodash](https://npm.io/package/lodash.md) 3.10.1
- [moment](https://npm.io/package/moment.md) 2.10.6
- [blessed](https://npm.io/package/blessed.md) 0.1.81
- [inquirer](https://npm.io/package/inquirer.md) 0.10.1
- [username](https://npm.io/package/username.md) 1.0.0
- [untildify](https://npm.io/package/untildify.md) 2.1.0
- [word-wrap](https://npm.io/package/word-wrap.md) 1.1.0
- [cli-output](https://npm.io/package/cli-output.md) 0.1.0
- [github-slug](https://npm.io/package/github-slug.md) 1.0.0
- [fixed-object](https://npm.io/package/fixed-object.md) 0.0.0
- [blessed-contrib](https://npm.io/package/blessed-contrib.md) 2.3.3
- [simple-argparse](https://npm.io/package/simple-argparse.md) 0.3.0

## Alternatives

- [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads
- [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads
- [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads
- [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads
- [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads

## Recent versions

- 0.4.0 (latest) — 2015-10-03
- 0.3.1 — 2015-08-19
- 0.3.0 — 2015-08-17
- 0.2.0 — 2015-08-16
- 0.1.0 — 2015-08-16
- 0.0.1 — 2015-08-16
- 0.0.0 — 2015-08-15

## README

# issue-explorer

> Explore Github issues from your terminal. See [introductory post](https://gochomugo.github.io/musings/issue-explorer).

[![node](https://img.shields.io/node/v/issue-explorer.svg?style=flat-square)](https://www.npmjs.com/package/issue-explorer) [![npm](https://img.shields.io/npm/v/issue-explorer.svg?style=flat-square)](https://www.npmjs.com/package/issue-explorer) [![Travis](https://img.shields.io/travis/GochoMugo/issue-explorer.svg?style=flat-square)](https://travis-ci.org/GochoMugo/issue-explorer) [![Gemnasium](https://img.shields.io/gemnasium/GochoMugo/issue-explorer.svg?style=flat-square)](https://gemnasium.com/GochoMugo/issue-explorer) [![Coveralls](https://img.shields.io/coveralls/GochoMugo/issue-explorer.svg?style=flat-square)](https://coveralls.io/github/GochoMugo/issue-explorer?branch=master)

[![asciicast](https://asciinema.org/a/25174.png)](https://asciinema.org/a/25174)


## installation:

```bash
$ npm install issue-explorer --global
```


## exploring:

```bash
$ issue-explorer all RepoName/UserName       # all issues

$ issue-explorer open RepoName/UserName      # open issues

$ issue-explorer closed RepoName/UserName    # closed issues

$ issue-explorer [open|all|closed] RepoName/UserName#7 # single issue

$ issue-explorer [open|all|closed]    # detects repo from cwd and explores issues
```

These commands will open a nice, simple interface for browsing.

* To **navigate up and down**, use the normal arrow keys
* press `Space` to **load more** issues
* press `Enter` on an issue on the list to **open the single issue**
* press `o` on the single issue to **open in browser**
* **navigate back** to the list of issues using the key `q`.
* **exit** using `Cmd/Ctrl + C` or `esc`.
* **`gie`** is an alias for `issue-explorer`

> **Note:** opening a single issue will succeed whether it is open or closed


## authorization:

You can use the application without authenticating with Github. However, you face the risk of going over the limit of requests allowed per hour. Authenticated requests have a [way higher rate limit](https://developer.github.com/v3/#rate-limiting).

To authorize issue-explorer:

```bash
$ issue-explorer auth
```

This will prompt you for your username and password. These are used to create an access token that will be stored on your computer and used in consequent requests rather than your password. You can view/update/revoke the created access token in [your settings panel](https://github.com/settings/tokens).


## misc:

**Errors** are appended to a **gie.log** file in the current working directory. If the interface suddenly shuts down due to an error, you can inspect the file. Please **copy over the log** when [reporting the issue](https://github.com/GochoMugo/issue-explorer/issues).


> HAPPY EXPLORING! :sunglasses:


## license:

__The MIT License (MIT)__

Copyright (c) 2015 GochoMugo <mugo@forfuture.co.ke>

---
_Source: https://npm.io/package/issue-explorer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._