Skip to main content

GHpeek - the easy Github repository viewer

GHpeek screenshot

GHpeek is a friendly terminal UI for keeping tabs on your GitHub repositories. Add the repos you care about and get a clean, readable list of open issues and pull requests with unread items highlighted. Each repo also shows a quick summary of stars, forks, and open counts so you can spot activity at a glance.

Dependencies

  • textual
  • PyGithub
  • rich
  • markdown
  • python-dotenv

Installation

GHpeek can be installed via pip. Simply run the following command:

pip install ghpeek

Or, even better with pipx:

pipx install ghpeek

Usage

To start GHpeek, simply run the following command:

ghpeek

Press a to add a repository. If a GitHub token is configured, you can choose from your own repositories, filter forks, organizations, and public/private repos, or enter a repo manually in owner/repo format. Without a token, manual entry still works.

Once added, repositories appear on the left. Use the arrow keys to switch between them, and you will see a summary of stars, forks, and open counts. The main panel lists issues and pull requests; press Enter to open a preview, then Enter again to open it in your browser. The preview includes the issue or PR description plus the latest comments, with a "Load older" option when more are available.

Quick keys:

  • i / p: jump between Issues and Pull Requests
  • c: show or hide closed issues/PRs
  • r: refresh the selected repo
  • q: quit

GitHub token

To enable repository picking and higher API limits, set a personal access token in GITHUB_TOKEN (recommended via a .env file in ~/.config/ghpeek/.env). For private repositories, the token needs the repo scope. For public repos only, public_repo (or no scopes) is sufficient.

License

The project is licensed under the MIT License. See the LICENSE file for details.

Contributing

I would love to see contributions to GHpeek! If you have any ideas for new features or improvements, please feel free to open an issue or submit a pull request.

Acknowledgements

This project uses the following open source libraries:

GHpeek was inspired by other terminal-based tools and was originally written by Kim Schulz.

Roadmap

  • Add search and filtering by label, author, and assignee
  • Add notifications or a background refresh mode
  • Add quick actions (close/reopen, comment) directly from the TUI

Metadata

Release files for ghpeek 0.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ghpeek 0.2.1
File Size Uploaded
ghpeek-0.2.1.tar.gz 11.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ghpeek 0.2.1
File Interpreter ABI Platform
ghpeek-0.2.1-py3-none-any.whl Python 3 none any Details

Total release size: 23.4 kB

Release files / ghpeek-0.2.1.tar.gz

Download URL ghpeek-0.2.1.tar.gz
Size 11.9 kB
Tags Source
SHA-256 checksum
How to use checksums
3989238bf39315022d773eeccdd5ab652ba77a4813dc3cc960f4f06206266935
BLAKE2b-256 checksum
How to use checksums
698dd30a12ebbeac15ca80d19fbd681fb74497331ab9b6bb9353b6c0cb4ce131
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.3

Release files / ghpeek-0.2.1-py3-none-any.whl

Download URL ghpeek-0.2.1-py3-none-any.whl
Size 11.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
00274f44a631ddf59d9a5e91053e437c648780ec7cc0d77164563f4f647c98e0
BLAKE2b-256 checksum
How to use checksums
02221e93fc28eade28a232576d3cdacf71452f9f2bf37bfefdfe52a9374d4fae
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.3

Release history Release notifications | RSS feed

This release

0.2.1 This release

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page