+
+
+
-
-
-
+
+
+
-
-
-
+Another terminal based graphical activity monitor, inspired by [gtop](https://github.com/aksakalli/gtop) and [vtop](https://github.com/MrRio/vtop), this time written in [Go](https://golang.org/)! -
-
+Join us in [\#gotop:matrix.org](https://app.element.io/#/room/#gotop:matrix.org)  ([matrix clients](https://matrix.to/#/#gotop:matrix.org)).
+
+> Badges? We don't need no stinking badges!
+
+
+
+
+
+[](https://goreportcard.com/report/github.com/xxxserxxx/gotop/v4)
+
+
+
+
+
+
+
+See the [change log](/CHANGELOG.md) for release updates.
+
+
## Installation
-Working and tested on Linux, FreeBSD and macOS. Windows support is planned. OpenBSD works with some caveats.
+Working and tested on Linux, FreeBSD and MacOS. Windows binaries are provided, but have limited testing. OpenBSD works with some caveats; cross-compiling is difficult and binaries are not provided.
-### Source
+If you install gotop by hand, or you download or create new layouts or colorschemes, you will need to put the layout files where gotop can find them. To see the list of directories gotop looks for files, run `gotop -h`. The first directory is always the directory from which gotop is run.
-```bash
-go get github.com/cjbassi/gotop
-```
+- **Arch**:  Install from AUR, e.g. `yay -S gotop-bin`. There is also `gotop` and `gotop-git`
+- **Gentoo**: gotop is available on [guru](https://gitweb.gentoo.org/repo/proj/guru.git) overlay.
+ ```shell
+ sudo layman -a guru
+ sudo emerge gotop
+ ```
+- **Nix**: you can run `gotop` with `nix-shell -p gotop --run gotop` or add the package `gotop` to your environment
+- **OSX**: gotop is in *homebrew-core*. `brew install gotop`. Make sure to uninstall and untap any previous installations or taps.
+- **Windows**: gotop is in the [Main](https://github.com/ScoopInstaller/Main) bucket. `scoop install gotop`.
+- **Prebuilt binaries**: Binaries for most systems can be downloaded from [the github releases page](https://github.com/xxxserxxx/gotop/releases). RPM and DEB packages are also provided.
+- **Source**: This requires Go >= 1.16. `go install github.com/xxxserxxx/gotop/v4/cmd/gotop@latest`
+
+### Extensions update
+
+Extensions have proven problematic; go plugins are not usable in real-world cases, and the solution I had running for a while was hacky, at best. Consequently, extensions have been moved into the main code base for now.
-### Prebuilt binaries
+- nvidia support: use the `--nvidia` flag to enable. You must have the `nvidia-smi` package installed, and gotop must be able to find the `nvidia-smi` executable, for this to work.
+- remote: allows gotop to pull sensor data from applications exporting Prometheus metrics, including remote gotop instances themselves.
-**Note**: Doesn't require Go.
+### Console Users
-Clone the repo and then run [scripts/download.sh](./scripts/download.sh) to download the correct binary for your system from the [releases tab](https://github.com/cjbassi/gotop/releases):
+gotop requires a font that has braille and block character Unicode code points; some distributions do not provide this. In the gotop repository is a `pcf` font that has these points, and setting this font may improve how gotop renders in your console. To use this, run these commands:
-```bash
-git clone --depth 1 https://github.com/cjbassi/gotop /tmp/gotop
-/tmp/gotop/scripts/download.sh
+```shell
+curl -O -L https://raw.githubusercontent.com/xxxserxxx/gotop/master/fonts/Lat15-VGA16-braille.psf
+setfont Lat15-VGA16-braille.psf
```
-Then move `gotop` into your `$PATH` somewhere.
+### Platform-specific features
-### Arch Linux
+Sometimes libraries that gotop uses to introspect the hardware only support a subset of operating systems. Rather than cripple gotop to the LCD, I'm allowing features that may only work on some platforms. These will be listed here:
-Install `gotop`, `gotop-bin`, or `gotop-git` from the AUR.
+- nvidia -- only available on systems with an nvidia GPU
+- SMART NVME hard drive temperatures -- Linux & Darwin
-### FreeBSD
+### Building
-```bash
-pkg install gotop
-```
+This is the download & compile approach.
-### Homebrew
+gotop requires Go 1.16 or later to build, as it relies on the embed feature released with 1.16; a library it uses, lingo, uses both embed and the `io/fs` package. For a version of gotop that builds with earlier versions, check out one of the tags prior to v4.2.0.
-```bash
-brew tap cjbassi/gotop
-brew install gotop
+```shell
+git clone https://github.com/xxxserxxx/gotop.git
+cd gotop
+# This ugly SOB gets a usable version from the git tag list
+VERS="$(git tag -l --sort=-v:refname | sed 's/v\([^-].*\)/\1/g' | head -1 | tr -d '-' ).$(git describe --long --tags | sed 's/\([^-].*\)-\([0-9]*\)-\(g.*\)/r\2.\3/g' | tr -d '-')"
+DAT=$(date +%Y%m%dT%H%M%S)
+go build -o gotop \
+ -ldflags "-X main.Version=v${VERS} -X main.BuildDate=${DAT}" \
+ ./cmd/gotop
```
-### Snap
+If you want to compact the executable as much as possible on Linux, change the `ldflags` line to this:
-```bash
-snap install gotop-cjbassi
+```
+-ldflags "-X main.Version=v${VERS} -X main.BuildDate=${DAT} -extldflags '-s -w'" \
```
-**Note**: You may need to enable certain permissions for all of the widgets to work:
+Now move the `gotop` executable to somewhere in your `$PATH`.
-```bash
-snap connect gotop-cjbassi:hardware-observe
-snap connect gotop-cjbassi:mount-observe
-snap connect gotop-cjbassi:system-observe
-```
+If Go is not installed or is the wrong version, and you don't have root access or don't want to upgrade Go, a script is provided to download Go and the gotop sources, compile gotop, and then clean up. See `scripts/install_without_root.sh`.
+
+#### go generate
+
+With Go 1.16, it is no longer necessary to call `go generate`. Translations and Apple SMC tags are embedded with `go:embed`.
## Usage
-### Keybinds
-
-- Quit: `q` or `
-To make a custom colorscheme, check out the [template](./colorschemes/template.go) for instructions and then use [default.json](./colorschemes/default.json) as a starter. Then put the file at `~/.config/gotop/
-### CLI Options
+#### "-l minimal"
+
+
+#### Custom (layouts/procs)
+
+
+
+## Contributors
+
+Many people  have contributed code to gotop. Most of the work was by the original author, Caleb Bassi, who was seduced by the dark side (Rust) and had to be thrown into a volcano. Thanks to [everyone who's submitted a PR](https://github.com/xxxserxxx/gotop/CONTRIBUTORS.md), or otherwise contributed to the project!
-`-c`, `--color=NAME` Set a colorscheme.
-`-m`, `--minimal` Only show CPU, Mem and Process widgets.
-`-r`, `--rate=RATE` Number of times per second to update CPU and Mem widgets [default: 1].
-`-V`, `--version` Print version and exit.
-`-p`, `--percpu` Show each CPU in the CPU widget.
-`-a`, `--averagecpu` Show average CPU in the CPU widget.
-`-s`, `--statusbar` Show a statusbar with the time.
-`-b`, `--battery` Show battery level widget (`minimal` turns off). [preview](./assets/screenshots/battery.png)
-`-i`, `--interface=NAME` Select network interface [default: all].
## Built With
- [gizak/termui](https://github.com/gizak/termui)
- - [nsf/termbox](https://github.com/nsf/termbox-go)
+- [nsf/termbox](https://github.com/nsf/termbox-go)
- [exrook/drawille-go](https://github.com/exrook/drawille-go)
- [shirou/gopsutil](https://github.com/shirou/gopsutil)
- [goreleaser/nfpm](https://github.com/goreleaser/nfpm)
- [distatus/battery](https://github.com/distatus/battery)
+- [VictoriaMetrics/metrics](https://github.com/VictoriaMetrics/metrics) Check this out! The API is clean, elegant, introduces many fewer indirect dependencies than the Prometheus client, and adds 50% less size to binaries.
+- [lingo](https://github.com/xxxserxxx/lingo) is forked from [jdkeke142's](https://github.com/jdkeke142/lingo-toml) lingo, which was in turn forked from [kortemy's](https://github.com/kortemy/lingo) original project.
+
+
+## History
+
+**ca. 2020-01-25** The original author of gotop started a new tool in Rust, called [ytop](https://github.com/cjbassi/ytop), and deprecated his Go version. This repository is a fork of original gotop project with a new maintainer to keep the project alive and growing. An objective of the fork is to maintain a small, focused core while providing a path to extend functionality for less universal use cases; examples of this is sensor support for NVidia graphics cards, and for aggregating data from remote gotop instances.
+
+## Alternatives
+
+I obviously think gotop is the Bee's Knees, but there are many alternatives. Many of these have been around for years. All of them are terminal-based tools.
+
+- Grandpa [top](http://sourceforge.net/projects/unixtop/). Written 36 years ago, C, installed by default on almost every Unix descendant.
+- [bashtop](https://github.com/aristocratos/bashtop), in pure bash! Beautiful and space efficient, and [deserves special comment](docs/bashtop.md).
+- [bpytop](https://github.com/aristocratos/bpytop), @aristocratos, the author of bashtop, rewrote it in Python in mid-2020; it's the same beautiful interface, and a very nice alternative.
+- [htop](https://hisham.hm/htop/). A prettier top. Similar functionality. 16 years old!
+- [atop](https://www.atoptool.nl/). Detailed process-focused inspection with a table-like view. Been around for 9 long years.
+- [iftop](http://www.ex-parrot.com/~pdw/iftop/), a top for network connections. More than just data transfer, iftop will show what interfaces are connecting to what IP addresses. Requires root access to run.
+- [iotop](http://guichaz.free.fr/iotop/), top for disk access. Tells you *which* processes are writing to and from disk space, and how much. Also requires root access to run.
+- [nmon](http://nmon.sourceforge.net) a dashboard style top; widgets can be dynamically enabled and disabled, pure ASCII rendering, so it doesn't rely on fancy character sets to draw bars.
+- [ytop](https://github.com/cjbassi/ytop), a rewrite of gotop (ca. 3.0) in Rust. Same great UI, different programming language.
+- [slabtop](https://gitlab.com/procps-ng/procps), part of procps-ng, looks like top but provides kernel slab cache information! Requires root.
+- [systemd-cgtop](https://www.github.com/systemd/systemd), comes with systemd (odds are your system uses systemd, so this is already installed), provides a resource use view of control groups -- basically, which services are using what resources. Does *not* require root to run.
+- [virt-top](https://libvirt.org/) top for virtualized containers (VMs, like QEMU).
+- [ctop](https://bcicen.github.io/ctop/) top for containers (LXC, like docker)
+
+
+### A comment on clones
+
+In a chat room I heard someone refer to gotop as "another one of those fancy language rewrites people do." I'm not the original author of gotop, so it's easy to not take offense, but I'm going on record as saying that I disagree with that sentiment: I think these rewrites are valuable, useful, and healthy to the community. They increase software diversity at very little [cost to users](https://en.wikipedia.org/wiki/Information_overload), and are a sort of evolutionary mechanism: as people do rewrites, some are worse, but some are better, and users benefit. Rewrites provide options, which fight against [monocultures](https://github.com). As importantly, most developers are really only fluent in a couple of programming languages. We all have *familiarity* with a dozen, and may even have extensive experience with a half-dozen, but if you don't constantly use a language, you tend to forget the extended library APIs, your development environment isn't tuned, you're rusty with using the tool sets, and you may have forgotten a lot of the language peculiarities and gotchas. The barrier to entry for contributing to a software project -- to simply finding and fixing a bug -- in a language you're not intimate with can be very high. It gets much worse if the project owner is a stickler for a particular style. So I believe that gotop's original author's decision to rewrite his project in Rust is a net positive. He probably made fewer design mistakes in ytop (we always do, on the second rewrite), and Rust developers -- who may have hesitated learning or brushing up on Go to submit an improvement -- have another project to which they can contribute.
+
+Diversity is good. Don't knock the free stuff.
-## Stargazers over time
+## Star History
-[](https://starcharts.herokuapp.com/cjbassi/gotop)
+[](https://star-history.com/#xxxserxxx/gotop&Date)
diff --git a/assets/screenshots/battery.png b/assets/screenshots/battery.png
index b70f2ab9..4698d1a4 100644
Binary files a/assets/screenshots/battery.png and b/assets/screenshots/battery.png differ
diff --git a/assets/demos/demo.gif b/assets/screenshots/demo.gif
similarity index 100%
rename from assets/demos/demo.gif
rename to assets/screenshots/demo.gif
diff --git a/assets/screenshots/fourby.png b/assets/screenshots/fourby.png
new file mode 100644
index 00000000..12c99ba3
Binary files /dev/null and b/assets/screenshots/fourby.png differ
diff --git a/assets/screenshots/kitchensink.gif b/assets/screenshots/kitchensink.gif
new file mode 100644
index 00000000..6061c84f
Binary files /dev/null and b/assets/screenshots/kitchensink.gif differ
diff --git a/assets/screenshots/minimal.png b/assets/screenshots/minimal.png
index efe5cc34..354b60b0 100644
Binary files a/assets/screenshots/minimal.png and b/assets/screenshots/minimal.png differ
diff --git a/assets/screenshots/procs.png b/assets/screenshots/procs.png
new file mode 100644
index 00000000..0e4e7a62
Binary files /dev/null and b/assets/screenshots/procs.png differ
diff --git a/build/gotop.conf b/build/gotop.conf
new file mode 100644
index 00000000..5ab6308a
--- /dev/null
+++ b/build/gotop.conf
@@ -0,0 +1,33 @@
+# Scale graphs to this level; 7 is the default, 2 is zoomed out.
+graphhorizontalscale=7
+# If true, start the UI with the help visible
+helpvisible=false
+# The color scheme to use. See `--list colorschemes`
+colorscheme=default
+# How frequently to update the UI, in nanoseconds
+updateinterval=1000000000
+# If true, show the average CPU load
+averagecpu=false
+# If true, show load per CPU
+percpuload=true
+# Temperature units. C for Celsius, F for Fahrenheit
+tempscale=C
+# If true, display a status bar
+statusbar=false
+# The network interface to monitor
+netinterface=all
+# A layout name. See `--list layouts`
+layout=default
+# The maximum log file size, in bytes
+maxlogsize=5000000
+# If set, export data as Promethius metrics on the interface:port.
+# E.g., `:8080` (colon is required, interface is not)
+#metricsexportport=
+# Display network IO in mpbs if true
+mbps=false
+# A list of enabled temp sensors. See `--list devices`
+#temperatures=
+# Enable NVidia GPU metrics.
+nvidia=false
+# To configure the NVidia refresh rate, set a duration:
+#nvidiarefresh=30s
diff --git a/build/nfpm.yml b/build/nfpm.yml
index 1e9501af..12cb2136 100644
--- a/build/nfpm.yml
+++ b/build/nfpm.yml
@@ -1,15 +1,31 @@
-name: "gotop"
-arch: "amd64"
-platform: "linux"
-version: "v${VERSION}"
-section: "default"
-priority: "extra"
-maintainer: "Caleb Bassi