Simple Sketchybar System Stats

This is a simple event provider for Sketchybar that sends system stats to Sketchybar via the event trigger system_stats.

Installation

Prebuilt binaries

You can download a prebuilt binary for Apple Silicon (aarch64) and Intel Macs (x86_64) from the latest release.

Build locally

1. Install the Rust toolchain.

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

2. Use cargo to build the binary:

git clone https://github.com/joncrangle/sketchybar-system-stats.git
cd sketchybar-system-stats
cargo build --release

CLI usage

Use the help command to get usage information:

$ stats_provider --help
A simple system stats event provider for Sketchybar.

Usage: stats_provider [OPTIONS]

Options:
  -a, --all                   Get all stats
  -c, --cpu <CPU>...          Get CPU stats [possible values: count, frequency, temperature, usage]
  -d, --disk <DISK>...        Get disk stats [possible values: count, free, total, usage, used]
  -m, --memory <MEMORY>...    Get memory stats [possible values: ram_available, ram_total, ram_usage, ram_used, swp_free, swp_total, swp_usage, swp_used]
  -n, --network <NETWORK>...  Network rx/tx in KB/s. Specify network interfaces (e.g., -n eth0 en0 lo0). At least one is required.
  -s, --system <SYSTEM>...    Get system stats [possible values: arch, distro, host_name, kernel_version, name, os_version, long_os_version, uptime]
  -i, --interval <INTERVAL>   Refresh interval in seconds [default: 5]
  -b, --bar <BAR>             Bar name (optional)
      --verbose               Enable verbose output
  -h, --help                  Print help
  -V, --version               Print version

Example: trigger event with cpu, disk and ram usage percentages at a refresh interval of 2 seconds:

stats_provider --cpu usage --disk usage --memory ram_usage --interval 2

Add the --verbose flag to see more detailed output:

$ stats_provider --cpu usage --disk usage --memory ram_usage --interval 2 --verbose
SketchyBar Stats Provider is running.
Stats Provider CLI: Cli { all: false, cpu: Some(["usage"]), disk: Some(["usage"]), memory: Some(["ram_usage"]), network: None, system: None, interval: 2, bar: None, verbose: true }
Successfully sent to SketchyBar: --add event system_stats
Current message: CPU_USAGE="4%" DISK_USAGE="65%" RAM_USAGE="54%"
Successfully sent to SketchyBar: --trigger system_stats CPU_USAGE="4%" DISK_USAGE="65%" RAM_USAGE="54%"
Current message: CPU_USAGE="6%" DISK_USAGE="65%" RAM_USAGE="54%"
Successfully sent to SketchyBar: --trigger system_stats CPU_USAGE="6%" DISK_USAGE="65%" RAM_USAGE="54%"
Current message: CPU_USAGE="5%" DISK_USAGE="65%" RAM_USAGE="54%"
Successfully sent to SketchyBar: --trigger system_stats CPU_USAGE="5%" DISK_USAGE="65%" RAM_USAGE="54%"

Usage with Sketchybar

Environment variables that can be provided by the system_stats event

[!NOTE] System stats that are not expected to change between system restarts (e.g. NAME, OS_VERSION, etc.) are sent when the app binary starts, but are not refreshed.

sketchybarrc file

Run stats_provider with desired options by including it in your sketchybarrc config:

killall stats_provider
# Update with path to stats_provider
$CONFIG_DIR/sketchybar-system-stats/target/release/stats_provider --cpu usage --disk usage --memory ram_usage &

Example: use stats_provider to add an item disk_usage, subscribe to the system_stats event and update the disk_usage item.

sketchybar --add item disk_usage right \
           --set disk_usage script="sketchybar --set disk_usage label=\$DISK_USAGE" \
           --subscribe disk_usage system_stats

SbarLua module

-- Update with path to stats_provider
sbar.exec('killall stats_provider >/dev/null; $CONFIG_DIR/sketchybar-system-stats/target/release/stats_provider --cpu usage --disk usage --memory usage')

-- Subscribe and use the `DISK_USAGE` var
local disk = sbar.add('item', 'disk', {
    position = 'right',
})
disk:subscribe('system_stats', function(env)
    disk:set { label = env.DISK_USAGE }
end)

Why?

I wanted a single simple, lightweight binary to provide stats to Sketchybar. I also wanted to learn how to code in Rust, and learning by doing is a great way to learn.

Thanks

• Sketchybar and SbarLua
• sketchybar-rs