A customizable cross-platform graphical process/system monitor for the terminal.
Supports Linux, macOS, and Windows. Inspired by gtop, gotop, and htop.
](https://crates.io/crates/bottom)
[
](https://bottom.pages.dev/stable)
[
](https://bottom.pages.dev/nightly)
[
](https://clementtsang.github.io/bottom/stable)
[
](https://ko-fi.com/clementtsang)
Demo using the Gruvbox theme (--theme gruvbox), along with IBM Plex Mono and Kitty
- Also thanks to [SignPath.io](https://about.signpath.io/) for providing a free code signing service, and to the
[SignPath Foundation](https://signpath.org/) for the certificate.
---
### Overview (`docs/README.md`)
# Extended Documentation
This is where the extended documentation resides, hosted on GitHub Pages. We use [MkDocs](https://www.mkdocs.org/),
[Material for MkDocs](https://squidfunk.github.io/mkdocs-material/), and [mike](https://github.com/jimporter/mike).
Documentation is currently built using Python 3.11, though it should work fine with older versions.
## Running locally
One way is to just run `serve.sh`. Alternatively, the manual steps are, assuming your current working directory
is the bottom repo:
```bash
# Change directories to the documentation.
cd docs/
# Create and activate venv.
python -m venv venv
source venv/bin/activate
# Install requirements
pip install -r requirements.txt
# Run mkdocs
venv/bin/mkdocs serve
```
## Deploying
Deploying is done via [mike](https://github.com/jimporter/mike) in order to get versioning. Typically,
this is done through CI, but can be done manually if needed.
### Nightly docs
```bash
cd docs
mike deploy nightly --push
```
### Stable docs
```bash
cd docs
# Rename the previous stable version
mike retitle --push stable $OLD_STABLE_VERSION
# Set the newest version as the most recent stable version
mike deploy --push --update-aliases $RELEASE_VERSION stable
# Append a "(stable)" string to the end.
mike retitle --push $RELEASE_VERSION "$RELEASE_VERSION (stable)"
```
---
### Overview (`schema/README.md`)
# Config JSON Schema
## Generation
These are automatically generated from the code using [`schemars`](https://github.com/GREsau/schemars). The `schemars`
derives are locked behind the `generate_schema` feature flag to avoid building unnecessary code for normal builds.
Meanwhile, the generator itself lives in a separate `scripts/schema_gen` helper crate. You can
generate them like so:
```bash
# Will print out to stdout
cargo run --manifest-path scripts/schema_gen/Cargo.toml
# e.g. for nightly
cargo run --manifest-path scripts/schema_gen/Cargo.toml > schema/nightly/bottom.json
# e.g. for a specific version
cargo run --manifest-path scripts/schema_gen/Cargo.toml -- 0.12.0 > schema/v0.12.0/bottom.json
```
Alternatively, run the `scripts/schema/generate.sh` script (for stable releases) or `scripts/schema/nightly.sh`
(for nightly), which does all of this for you.
## Publication
To publish these schemas:
### Stable
1. Run `scripts/schema/generate.sh 
btm --dot_marker
