explaingit

yangkx1024/truenasstate

Analysis updated 2026-05-18

0SwiftAudience · ops devopsComplexity · 2/5LicenseSetup · moderate

TLDR

A macOS menu bar app that shows live TrueNAS SCALE server stats, storage pool health, and app status without opening a browser.

Mindmap

mindmap
  root((TrueStats))
    What it does
      Menu bar monitoring
      Realtime dashboard
      App upgrades
    Tech stack
      Swift
      SwiftUI
      WebSocket
    Use cases
      Watch storage health
      Track app resource use
      Trigger updates
    Audience
      Homelab users
      Sysadmins

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Keep an eye on TrueNAS storage pool health and active alerts from the Mac menu bar.

USE CASE 2

Monitor live CPU and memory usage of installed TrueNAS apps.

USE CASE 3

Trigger app upgrades and check for TrueNAS system updates without opening a browser.

What is it built with?

SwiftSwiftUIWebSocket

How does it compare?

yangkx1024/truenasstateaiduckman/claudeusage_latest_may2026arnabau/thermalpulse
Stars000
LanguageSwiftSwiftSwift
Setup difficultymoderateeasymoderate
Complexity2/52/53/5
Audienceops devopsvibe coderdeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · moderate Time to first run · 30min

Requires a TrueNAS SCALE server with HTTPS and an API key, self-signed certs need manual trust setup.

In plain English

TrueStats is a lightweight macOS app that lives in the menu bar and lets you monitor a TrueNAS SCALE server at a glance. TrueNAS SCALE is a popular open source network attached storage system used at home or in small businesses to manage disks, data pools, and self hosted applications. Instead of opening a browser and logging into the NAS web interface, TrueStats sits quietly in your Mac's status bar and shows a count of active alerts, so you always know if something needs attention. Clicking the menu bar icon opens a popover dashboard showing system information, the health of your storage pools, any active alerts, and a list of your installed apps, each with live CPU and memory usage. The data updates in real time using the TrueNAS WebSocket API, with a snapshot refresh every 30 seconds. You can also trigger app upgrades and check for system updates directly from the menu without opening a browser. Credentials are stored securely in the macOS Keychain rather than in plain configuration files, and the endpoint URL is kept in the app's local settings. If your TrueNAS server uses a self signed certificate, the README walks through exporting that certificate from your browser and marking it as trusted in macOS Keychain Access, since otherwise the app's connection will fail with a certificate error. The app requires macOS 14.0 or later and a TrueNAS SCALE server reachable over HTTPS with an API key tied to a specific user account. It is built in Swift with SwiftUI for the popover views, and it runs purely as a status bar agent with no Dock icon or main window. You would use this tool if you run a TrueNAS SCALE server at home or in a small office and want a low friction way to keep an eye on your storage health and installed apps from your Mac without switching windows. The project is released under the Apache License 2.0.

Copy-paste prompts

Prompt 1
Help me set up the TrueNAS API key and connect this menu bar app to my server.
Prompt 2
Walk me through trusting a self-signed TrueNAS certificate in macOS Keychain Access.
Prompt 3
Explain how this app uses the TrueNAS WebSocket API for realtime updates.
Prompt 4
Show me how to add a new dashboard panel to this SwiftUI popover.

Frequently asked questions

What is truenasstate?

A macOS menu bar app that shows live TrueNAS SCALE server stats, storage pool health, and app status without opening a browser.

What language is truenasstate written in?

Mainly Swift. The stack also includes Swift, SwiftUI, WebSocket.

How hard is truenasstate to set up?

Setup difficulty is rated moderate, with roughly 30min to a first successful run.

Who is truenasstate for?

Mainly ops devops.

Open on GitHub → Explain another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.