Code Monkey home page Code Monkey logo

ackboard's Introduction

ACKBoard

A curses dashboard for ACKs.

Github Token

ACKBoard requires a GitHub token in order to use the GraphQL API. See the GitHub Docs for how to get a token. The token should be put in a text file whose path will be given as a CLI arg.

Usage

Command line arguments

usage: ackboard.py [-h] token_file repo_owner repo_name

positional arguments:
  token_file  Path to the file containing the GitHub token
  repo_owner  Repository owner
  repo_name   Repository name

options:
  -h, --help  show this help message and exit

Main UI Keybinds

Keys Action
:q Quit
j, Down arrow Move cursor down one line
k, Up arrow Move cursor up one line
Page Down Show next page of lines
Page Up Show previous page of lines
g Go to top
G Go to bottom
d Show details of the PR highlighted by the cursor
:r Refresh data
:sa Sort by number of ACKs
:ss Sort by number of Stale ACKs
:sn Sort by number of NACKs
:sc Sort by number of Concept ACKs
:f Apply a filter. See Filters for more info
:c Clear filters
o Open PR in browser

Filters

A command to apply a filter begins with :f. The next character indicates the column to apply the filter to. A / indicates the following string is the filter. The filter itself is a regular expression.

Type Char Column
p PR Number
t PR Title
o Original poster (PR Author)
l Labels
a ACKers and ACK comments
s Stale ACKers and Stale ACK comments
n NACKers and NACK comments
c Concept ACKers and Concept ACK coments

For example, the command :fo/achow101 filters the listed PRs where the PR author name is achow101.

Details UI Keybinds:

Keys Action
q Quit
j, Down arrow Scroll down one line
k, Up arrow Scroll up one line
h, Left arrow Scroll left one character
h, Right arrow Scroll right one character
Page Down Show next page of lines
Page Up Show previous page of lines
g Go to top
G Go to bottom
o Open PR in browser

Colors

Some lines are colored differently to indicate special statuses that may be important:

Color Status
Blue Draft PR
Cyan PR needs rebase

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.