Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sjdonado/tmux-workspace-usage
Memory and CPU usage of your workspace processes in your status bar
https://github.com/sjdonado/tmux-workspace-usage
bash tmux
Last synced: about 1 month ago
JSON representation
Memory and CPU usage of your workspace processes in your status bar
- Host: GitHub
- URL: https://github.com/sjdonado/tmux-workspace-usage
- Owner: sjdonado
- License: mit
- Created: 2024-10-18T12:44:16.000Z (about 2 months ago)
- Default Branch: master
- Last Pushed: 2024-10-27T08:31:53.000Z (about 2 months ago)
- Last Synced: 2024-10-27T09:39:07.505Z (about 2 months ago)
- Topics: bash, tmux
- Language: Shell
- Homepage:
- Size: 10.7 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- trackawesomelist - tmux-workspace-usage (⭐2)
README
# Workspace usage plugin for tmux
> Displays the memory and CPU usage of your workspace processes in the tmux status bar.
## Features
- Displays memory usage in MB.
- Displays CPU usage as a percentage.
- Configurable list of processes to monitor.
- Toggle memory and CPU usage display on or off via tmux settings.
## Installation
1. Using [TPM](https://github.com/tmux-plugins/tpm), add the following line to your `~/.tmux.conf` file:
```bash
set -g @plugin 'sjdonado/tmux-workspace-usage'
```
> **Note**: The above line should be _before_ `run '~/.tmux/plugins/tpm/tpm'`
2. Then press `tmux-prefix` + I (capital i, as in **I**nstall) to fetch the plugin as per the TPM installation instructions
## Configuration
- `@workspace_usage_processes`: A string of process names separated by `|` that you want to monitor.
- `@workspace_usage_mem`: Toggles memory usage display (`on` or `off`).
- `@workspace_usage_cpu`: Toggles CPU usage display (`on` or `off`).
- `@workspace_usage_interval_delay`: The amount of time (in seconds) to delay updates. If set to a value greater than `@status-interval`, the delay will be skipped.
### Example:
```bash
# Set the processes to monitor, customize this as needed (default is 'tmux')
set -g @workspace_usage_processes 'tmux|nvim|mason'
# Enable memory and CPU usage display (default is 'on')
set -g @workspace_usage_mem 'on'
set -g @workspace_usage_cpu 'on'
# Set the interval delay in seconds, updates every 20 seconds if @status-interval is 15 (default is 0)
set -g @workspace_usage_interval_delay 5
# Add the plugin output to status-right
set -g status-right '#{workspace_usage}'
```
## License
[MIT](https://github.com/sjdonado/tmux-workspace-usage/blob/master/LICENSE.md)