A CLI to instantly get an overview of one or more repos' PRs, and decide which PR to act upon next.
pot stands for Pr Overview Tool
Note: This is an ongoing project, and issues are frequently opened and closed. Refactorings and improvements are on the way. Check the issues section for more info.
pot creates accumulated data for users concerning one or more repositories, using
GitHub's API through the official GitHub CLI (gh), and provides a terminal
table overview of the current PR workload distribution for each team member.
AI assistants: A structured skill for using and interpreting
potis available at.claude/skills/pot/SKILL.md. It includes column definitions, the full decision process, and common--json+jqpatterns.
To keep releases fast, idle time zero, and context switching minimal.
In larger teams, PRs stall because reviewers open new PRs instead of clearing their
actionables. This compounds: more concurrent open PRs → more context switching → slower
releases. Developers do this for two reasons: they don't want idle time, and they lack a
clear picture of what they are currently blocking. pot solves the latter.
pot is not a management tool. It does not require a team meeting or a tech lead to
interpret. Each team member runs it independently to answer one question: What should I
do next?
Please refer to the SKILL.md for a detailed decision process and column reference.
-
GitHub CLI (
gh) v2.0+ — handles all GitHub API access and authentication# Install: https://cli.github.com gh auth login # authenticate once gh auth status # verify
-
Bun — runtime and package manager
curl -fsSL https://bun.com/install | bash -
go-task — task runner (dev/build only, not needed for the standalone binary)
sh -c "$(curl -L https://taskfile.dev/install.sh)" -- -d -b ~/.local/bin
Download the binary for your platform from the Releases page and put it in your PATH:
# Example for Linux x64
curl -L https://github.com/ioanniswd/pot/releases/latest/download/pot-linux-x64 -o pot
chmod +x pot
sudo mv pot /usr/local/bin/potgit clone https://github.com/ioanniswd/pot
cd pot
bun install
task build
bun link # makes `pot` available globallyTo unlink: bun unlink pot
After installing, configure your repositories:
pot configFollow the interactive prompts to set your GitHub owner (org or user) and repository names.
pot uses the GitHub CLI for authentication, which means your GitHub credentials
are managed by gh.
First, ensure you've authenticated with GitHub CLI:
$ gh auth loginThen simply use pot as normal:
$ pot --users=john,jane,doeFor first-time users, here's the complete setup:
# 1. Install GitHub CLI (if not already installed)
# Visit: https://cli.github.com
# 2. Authenticate with GitHub
$ gh auth login
# 3. Configure pot (one-time setup)
$ pot config
# 4. Use pot!
$ pot --users=john,jane,doe$ pot --users=john,jane,doe
+------+----------+-----------+-------+---------------+-------------+-------------------+-----------+
| User | Authored | Reviewing | Total | Total + / - | Actionables | Actionable + / - | Untouched |
+------+----------+-----------+-------+---------------+-------------+-------------------+-----------+
| doe | 3 | 0 | 3 | 146 / 82 | 1 | 40 / 37 | 0 |
| jane | 1 | 2 | 3 | 270 / 254 | 2 | 200 / 187 | 0 |
| john | 2 | 1 | 3 | 34 / 48 | 3 | 34 / 48 | 0 |
+------+----------+-----------+-------+---------------+-------------+-------------------+-----------+Note: By default, pot only counts open PRs.
Number of PRs authored by the user
Number of PRs currently reviewing, meaning that said user has not approved, or rejected the PR. If user is a requested reviewer, or if user has placed comments but has not approved or rejected the PR yet, they are considered active reviewers, and said PR counts as one they are currently reviewing.
Authored + Reviewing
Additions/Deletions for all active PRs of user
A PR is considered actionable for a user, when said user can
perform any action in said PR, and is probably blocking another user. For
example, if john is the author of a PR, and jane places some comments, that PR
becomes actionable for john, and non actionable for jane. When john responds to
jane's comments and re-requests review from her, PR becomes non actionable for
john and actionable for jane.
Additions/Deletions for all actionable PRs of user
When a user is requested to review a PR, and until the moment they place their first comment, that PR is considered untouched for said user. This is useful when workload ends up unevenly distributed amongst devs, and a dev who has an easier time, tries to decide whose PR they are going to review to even the load.
The above rows are sorted. First by Total, then by Actionable, and finally by Untouched (asc). This way, the most likely candidate to whom a new PR will be assigned, will be closer to the top, and the most likely candidate who might need some help with their PRs, will be closer to the bottom.
The above example only shows the accumulated counts for each user. Usually, one
will want more details about a specific user's PRs. In that case the
--user=<user> option can be used.
$ pot --user=doe
+------+----------+-----------+-------+---------------+-------------+-------------------+-----------+
| User | Authored | Reviewing | Total | Total + / - | Actionables | Actionable + / - | Untouched |
+------+----------+-----------+-------+---------------+-------------+-------------------+-----------+
| doe | 2 | 3 | 5 | 5287 / 2095 | 3 | 5270 / 2035 | 1 |
| john | 3 | 2 | 5 | 5287 / 2095 | 1 | 5270 / 2035 | 1 |
+------+----------+-----------+-------+---------------+-------------+-------------------+-----------+
+------------+-----------+-------------+---------------------------+
| Authored |
+------------+-----------+-------------+---------------------------+
| Actionable | Approvals | +/- | PR |
+------------+-----------+-------------+---------------------------+
| Yes | 2 / 2 | 4729 / 1561 | Add feature cool (PR_url) |
| No | 1 / 3 | 12 / 58 | Fix bug wah(PR_url) |
+------------+-----------+-------------+---------------------------+
+------------+-----------+---------------------+-----------+-----------+--------------------------+
| Reviewing |
+------------+-----------+---------------------+-----------+-----------+--------------------------+
| Actionable | Untouched | Author: Actionables | Approvals | +/- | PR |
+------------+-----------+---------------------+-----------+-----------+--------------------------+
| Yes | Yes | john: 1 | 1 / 2 | 304 / 39 | Add feature wow (PR_url) |
| Yes | No | john: 1 | 0 / 2 | 237 / 435 | Fix bug dang (PR_url) |
| No | No | jane: 1 | 3 / 3 | 5 / 2 | Improve styles (PR_url) |
+------------+-----------+---------------------+-----------+-----------+--------------------------+Note: Both --users=<user, names> and --user='user' can be used:
$ pot --users=john,jane --user=doeAnd both the accumulative and the specific output will be shown
In the above example, the accumulative data is shown for user doe, as well
as some details about each of the PRs they are involved in. This can be used by
doe to figure out which PR needs their attention first, or by another user
who happened to have some idle time and wants to help out. Information about
john appear as well, since john is the author of all the PRs that doe is
reviewing, and is also reviewing all PRs that doe has authored. This allows
one to simply pass the --user argument and get information on the status of all
users with which they share any PRs, without explicitly passing a --users
argument.
The ratio of users who have approved the PR, to all users ever involved in the PR.
Additions / Deletions in lines of code
This is used to conveniently open all of a users PRs in the browser
$ pot --user=doe --url-only
This way one can open all of doe's PRs in a browser like this:
$ pot --user=doe --url-only | xargs -L1 xdg-openpot uses the GitHub CLI (gh) for authentication. Credentials are managed by gh, not by pot.
To authenticate:
$ gh auth loginThis step is required before using pot.
You can provide repository information either via command-line options or by saving a default configuration.
Provide options each time you run pot:
$ pot --user=doe --repository_names "octo, cat" --owner_name 'repo_owner_name'To save frequently-used repository information:
$ pot --configFollow the interactive wizard to define:
- Repository names (comma-separated): Which repositories to analyze
- Owner name: GitHub user or organization that owns the repositories
- Cache enabled: Whether to cache PR data for faster subsequent runs
The configuration is saved to ~/.pot/config for future use.
In case a command is usually being used with certain options, options can be saved under a certain name like so:
$ pot --users=jane,jack --user=doe --repository_names "octo, cat" --register_new <register_name>And then:
$ pot --registered <register_name>In the above example, options users, user etc are being filled through the
saved registry in the config.
You can also override some of the underlying options saved in the registry:
$ pot --registered <register_name> --repository_names 'some, other, repos'There is the option of caching raw data returned from github for future use, which significantly speeds up further responses. For example, running:
$ pot --users=john,jane,doeAnd then, wanting to know more about a specific user through the detailed view:
$ pot --user=doe --cachedThis way, for the second command, no request is made, the data is considered to be the same.
To enable this feature, run the config wizard. If enabled, the raw data from
the request(s) are stored in pot_root_folder/cached_response everytime the command
sends a request to github. Results are cached under the repo names used
in the command. If different repo names are used, the request is made and its
response is also saved in the aforementioned file.
e.g.
Assume the cache was just enabled (cache_enabled: true in the config file).
Note: The --cached option specifies that we want to use the cached response, if
present. If not present, the request is made as if --cached was ommited.
This sends the request and saves the raw response:
$ pot --users=jane,doe --repository_names=octo --cachedThis also sends the request and saves the raw response under a different key:
$ pot --users=jane,doe --repository_names=octo,cat --cachedSubsequent requests made with the repositories being octo, octo,cat or cat, octo and the --cached option will use the cached response from the previous requests.
For example, the following commands will not trigger a request:
$ pot --users=john --repository_names=octo,cat --cached$ pot --users=jane --repository_names=cat,octo --cached$ pot --users=doe --repository_names=octo --cachedBut this one will, since response for repo cat alone has not been received so
far:
$ pot --users=doe --repository_names=cat --cachedNote: --cached is not saved when using --register See register
Error: gh: command not found
Solution: Install the GitHub CLI from https://cli.github.com
Error: Error fetching PRs: authentication required
Solution: Run gh auth login and follow the interactive prompts to authenticate with GitHub
Error: Error fetching PRs: insufficient permissions
Solution: Ensure your GitHub credentials have access to the repositories you're querying. Check your GitHub token permissions:
$ gh auth statusError: Error fetching PRs: repository not found
Solution: Verify that:
- The owner name and repository names are correct
- You have access to the repository
- The repository exists on GitHub
- Create an issue describing the purpose of the pull request unless there is one already
- Fork the repository ( https://github.com/ioanniswd/pot/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request
Thanks goes to these wonderful people (emoji key):
Lazarus Lazaridis 🤔 |
Stefanos Ntokos 🤔 |
This project follows the all-contributors specification. Contributions of any kind welcome!
This tool is open source under the MIT License terms.