Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/orhun/pkgtop
Interactive package manager and resource monitor designed for the GNU/Linux.
https://github.com/orhun/pkgtop
gnu-linux linux-packages package-management package-manager resource-monitor
Last synced: 30 days ago
JSON representation
Interactive package manager and resource monitor designed for the GNU/Linux.
- Host: GitHub
- URL: https://github.com/orhun/pkgtop
- Owner: orhun
- License: gpl-3.0
- Created: 2019-07-19T19:30:11.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-10-13T10:56:12.000Z (about 1 year ago)
- Last Synced: 2024-11-06T21:43:32.228Z (about 1 month ago)
- Topics: gnu-linux, linux-packages, package-management, package-manager, resource-monitor
- Language: Go
- Homepage:
- Size: 259 KB
- Stars: 309
- Watchers: 10
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-robotic-tooling - pkgtop - Interactive package manager and resource monitor designed for the GNU/Linux. (Interaction / Command Line)
- awesome-robotic-tooling - pkgtop - Interactive package manager and resource monitor designed for the GNU/Linux. (User Interaction / Command Line Interface)
README
**pkgtop** is an **interactive package manager** & **resource monitor** tool designed for the GNU/Linux.
[](https://github.com/orhun/pkgtop/releases) [](https://aur.archlinux.org/packages/pkgtop/) [](https://github.com/orhun/pkgtop/actions) [](https://goreportcard.com/report/github.com/orhun/pkgtop) [](./LICENSE)
Package management (install/upgrade/remove etc.) can be a problem if the user is not familiar with the operating system or the required command for that operation. So pkgtop tries to solve this problem with an easy-to-use terminal interface and shortcut keys. Briefly, **pkgtop aims to provide a terminal dashboard for managing packages on GNU/Linux systems.** Using the terminal dashboard, it's possible to list installed packages by size (or alphabetically with `-a` argument), show information about the package, install/upgrade/remove packages and search package. Also, there are other handy shortcuts for easing the package management process which mentioned in the [usage information](https://github.com/orhun/pkgtop#usage).
In addition to the package management features, there's a section at the top of the dashboard that shows disk usages and general system information. For example, this section can be used as a resource monitor and help decide whether the system should be cleaned or not.
Another useful section is the '`executed`' or '`confirm to execute`' command list which is placed below the installed packages. Thus, the user can see which command executed recently or confirm & execute the selected command. (The commands that need confirmation to execute exist in the list with a prefix like "`[y]`".)
After scrolling the commands list with "`c`" key for selecting the command to execute, press "`y`" for executing it. pkgtop will execute the command and restart the terminal dashboard afterwards.
pkgtop uses the advantage of mainly used package managers being installed on most of the preferred GNU/Linux distributions. As an example, it works on a [Manjaro](https://manjaro.org/) based system as it works on [Arch Linux](https://www.archlinux.org/) systems since both distributions use the [Pacman](https://wiki.archlinux.org/index.php/pacman) package manager. You can use pkgtop if you have one of the package managers listed below.
* pacman
* apt
* zypp
* dnf
* xbps
* portage
* nix
* guix
If you are happy user of Arch-based distributive, you can use pkgtop with pacman wrappers and AUR supporters, such as [paru](https://aur.archlinux.org/packages/paru). See [this](#aur-support) section for details.
If the distribution is not defined in the source but has the required package manager for running the pkgtop, `-d` argument can be used for specifying a distribution that has the same package manager. Current defined and supported distributions are `arch, manjaro, debian, ubuntu, mint, suse, fedora, centos, redhat, void, gentoo, nixos, guix`.
- [Installation](#installation)
- [Dependencies](#dependencies)
- [AUR](#aur)
- [Manual Installation](#manual-installation)
- [Command-Line Arguments](#command-line-arguments)
- [AUR Support](#aur-support)
- [Usage](#usage)
- [List Installed Packages & Show Package Information](#list-installed-packages--show-package-information)
- [Search, Go-to Package](#search-go-to-package)
- [Install, Upgrade, Remove Package](#install-upgrade-remove-package)
- [Show Disk Usage Information](#show-disk-usage-information)
- [Confirm Command to Execute](#confirm-command-to-execute)
- [Show Help](#show-help)
- [Docker](#docker)
- [Build Docker Image](#build-docker-image)
- [Run the Container](#run-the-container)
- [Start a shell in the Container](#start-a-shell-in-the-container)
- [Screenshots](#screenshots)
- [Todo(s)](#todos)
- [Sponsor](#sponsor)
- [License](#license)
- [Copyright](#copyright)
## Installation
### Dependencies
* [gizak/termui](https://github.com/gizak/termui/)
* [atotto/clipboard](https://github.com/atotto/clipboard)
* [dustin/go-humanize](https://github.com/dustin/go-humanize)
* [mattn/go-runewidth](https://github.com/mattn/go-runewidth)
* [mitchellh/go-wordwrap](https://github.com/mitchellh/go-wordwrap)
* [nsf/termbox-go](https://github.com/nsf/termbox-go)
### AUR
```
git clone https://aur.archlinux.org/pkgtop.git && cd pkgtop/
makepkg --install
```
### Manual Installation
```
go build cmd/pkgtop.go
sudo mv pkgtop /usr/local/bin/
```
Preferably, [go install](https://pkg.go.dev/cmd/go#hdr-Compile_and_install_packages_and_dependencies) command can be used.
## Command-Line Arguments
```
-h, show help message
-d, select linux distribution
-c, main color of the dashboard (default: blue)
[red, green, yellow, blue, magenta, cyan, white]
-pacman, pacman backend for arch-based distributions (default: pacman)
-a, sort packages alphabetically
-r, reverse the package list
-v, print version
```
## AUR Support
You can specify which pacman wrapper you should to use by launch pkgtop with `-pacman` option.
For example, for [paru](https://aur.archlinux.org/packages/paru) support:
```
$ pkgtop -pacman paru
```
If you don't want to provide the `-pacman` option every time on app launch, you can create bash alias on `~/.bashrc` file.
```
~/.bashrc
alias pkgtop='pkgtop -pacman paru'
```
After that you can simply launch `pkgtop` command and get full AUR support, provided by `paru` wrapper.
## Usage
| Key | Action |
|-------------------------- |------------------------------------------ |
| `?` | help |
| `enter, space, tab` | show package information |
| `i` | install package |
| `u/ctrl-u` | upgrade package/with input |
| `r/ctrl-r` | remove package/with input |
| `s,/` | search package |
| `g` | go to package (index) |
| `y` | confirm and execute the selected command |
| `p` | copy selected package |
| `e` | copy selected command |
| `c` | scroll executed commands list |
| `j/k, down/up` | scroll down/up (packages) |
| `ctrl-j/ctrl-k` | scroll to bottom/top (packages) |
| `l/h, right/left` | scroll down/up (disk usage) |
| `backspace` | go back |
| `q, esc, ctrl-c, ctrl-d` | exit |
### List Installed Packages & Show Package Information
```
pressed keys: down, enter, backspace
```
### Search, Go-to Package
```
pressed keys: s, (type), enter, g, (type), enter
```
### Install, Upgrade, Remove Package
```
pressed keys:
i, (type), enter, y -> install
ctrl-u, (type), enter, y -> upgrade
ctrl-r, (type), enter, y -> remove
```
### Show Disk Usage Information
```
pressed keys: right, left
```
### Confirm Command to Execute
```
pressed keys: c, y
```
### Show Help
```
pressed key: ?
```
## Docker
### Build Docker Image
```
docker build -f docker/Dockerfile -t pkgtop-docker .
```
### Run the Container
```
docker run pkgtop-docker
```
### Start a shell in the Container
```
docker run -it pkgtop-docker /bin/bash
```
## Screenshots
## Todo(s)
* Add 'paste' feature
## Sponsor
If you would like to support the development of pkgtop and my other open source [projects](https://github.com/orhun), consider supporting me on [GitHub Sponsors](https://github.com/sponsors/orhun) or becoming a [patron](https://www.patreon.com/bePatron?u=23697306).
## License
GNU General Public License ([v3](https://www.gnu.org/licenses/gpl.txt))
## Copyright
Copyright © 2019-2023, [Orhun Parmaksız](mailto:[email protected])