An open API service indexing awesome lists of open source software.

https://github.com/sunng87/zemon

A minimal TUI system monitor for zellij/tmux
https://github.com/sunng87/zemon

Last synced: 7 months ago
JSON representation

A minimal TUI system monitor for zellij/tmux

Awesome Lists containing this project

README

          

# zemon

A small TUI widget designed for display system information in zellij.

![screenshot](screenshot.png)

## Installation

### Using Nix Flakes

#### Direct installation
```bash
nix profile install github:sunng87/zemon
```

#### Run without installing
```bash
nix run github:sunng87/zemon
```

### NixOS Configuration

Add to your `configuration.nix`:

```nix
{
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
zemon.url = "github:sunng87/zemon";
};

outputs = { self, nixpkgs, zemon, ... }: {
nixosConfigurations.YOUR_USERNAME = nixpkgs.lib.nixosSystem {
system = "x86_64-linux";
modules = [
{
environment.systemPackages = [
zemon.packages.x86_64-linux.default
];
}
];
};
};
}
```

### Home Manager

Add to your `home.nix`:

```nix
{
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
home-manager.url = "github:nix-community/home-manager";
zemon.url = "github:sunng87/zemon";
};

outputs = { nixpkgs, home-manager, zemon, ... }: {
homeConfigurations.YOUR_USERNAME = home-manager.lib.homeManagerConfiguration {
pkgs = nixpkgs.legacyPackages.x86_64-linux;
modules = [
{
home.packages = [
zemon.packages.x86_64-linux.default
];
}
];
};
};
}
```

## Usage

You can start `zemon` from any shell. But it is designed for using in Zellij
typically. Start it as a floating pane in Zellij:

```bash
zellij run -f -c -- zemon
```

Or bind it to a shortcut key in Zellij configuration:

```kdl
bind "Alt m" {
Run "zemon" {
floating true
close_on_exit true
};
}
```

## Development

### Using the development shell
```bash
nix develop
cargo run
```

### Building locally
```bash
nix build
```