https://github.com/dctucker/octoterm
Octobox for Terminal
https://github.com/dctucker/octoterm
github ncurses
Last synced: 7 months ago
JSON representation
Octobox for Terminal
- Host: GitHub
- URL: https://github.com/dctucker/octoterm
- Owner: dctucker
- License: mit
- Created: 2018-06-29T16:30:53.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2022-07-06T22:51:50.000Z (over 3 years ago)
- Last Synced: 2025-04-05T14:03:40.202Z (10 months ago)
- Topics: github, ncurses
- Language: JavaScript
- Homepage:
- Size: 1.67 MB
- Stars: 13
- Watchers: 1
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Octoterm
Octobox for Terminal
## Synopsis
Inspired by Octobox, but wanting to reduce the memory footprint, Octoterm was born. It uses the GitHub REST and GraphQL APIs to load metadata about notifications.
## Requirements
Run `npm install` to download dependencies.
Make sure you have exported a [Personal Access Token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) via the `GITHUB_TOKEN` environment variable from your `.profile`, `.bashrc` or whatever.
Your access token must include `notifications`, `read:discussion`, `read:org`, `repo`, `user`, and should probably also include `read:packages` and `write:packages` (this is how I have mine configured and it seems to work).
## Usage
```
./gh.js
```
- `h` `j` `k` `l` cursor movement
- `return` open selected notification in a web browser
- `o` open selected notification in the background
- `x` toggle selection
- `m` mute selection
- `/` search
- `r` refresh
- `q` quit
## Screenshot
## Development
Feel free to create a PR or Issue in this repository, where it's a bugfix or an enhancement.