TR-300

Cross-platform system information report with Unicode box-drawing tables.

TR-300 is a standalone Rust CLI for fast, reliable, and readable terminal machine reports.

Latest release: v3.15.0 (2026-05-14). Windows users get four installer options — Global / Corporate Editions, each in MSI and EXE formats — none of which require Rust on the install machine. macOS / Linux ship via cargo-dist's shell installer. The crates.io package is tr300.

Features

• Cross-platform support (Windows, macOS, Linux)
• Beautiful Unicode box-drawing tables with ASCII fallback
• ASCII fallback mode for legacy terminals
• Bar graphs for CPU load, memory, and disk usage
• VPN-aware network information on Windows — MACHINE IP and DNS IP rows reflect the active default route (GetBestInterfaceEx-driven) so Tailscale / WireGuard / OpenVPN / corporate VPN tunnels are reported correctly instead of a coin-flip pick
• Hypervisor / virtualization detection (CPUID-based; disambiguates Win11 VBS from real VMs)
• Session info with last-login/current-session tracking; Windows uses WTS APIs with a boot-time fallback
• Disk encryption status (BitLocker on Windows when readable)
• Fast Startup-aware uptime on Windows — when the kernel session age and the WMI cold-boot time diverge by >1h (typical on Win10/Win11 laptops with HiberbootEnabled), the UPTIME row renders both as 9d 4h 12m (session: 7h 14m)
• 5-state battery awareness on Windows — distinguishes AC Power (plugged in, fully topped up), X% (Charging), X% (Plugged in) (gaming-laptop case where peak GPU draw exceeds the brick wattage, OR firmware-limited charging modes like ThinkPad battery longevity), X% (Discharging), plus Critical / Low overrides
• Smart terminal detection on Windows — env-var pre-checks (WT_SESSION, TERM_PROGRAM, CURSOR_TRACE_ID) then a parent-process walk via Toolhelp32 that recognizes Windows Terminal, WezTerm, Alacritty, VS Code, Cursor, Windsurf, Hyper, Tabby, Ghostty, Kitty, MinTTY, Claude Code, and Antigravity even when env vars are absent
• PowerShell 7+ ("PowerShell Core") detection on Windows — reads HKLM\SOFTWARE\Microsoft\PowerShellCore\InstalledVersions\<GUID>\SemanticVersion so pwsh users see the actual installed version instead of falling back to Windows PowerShell 5.x
• JSON output for scripting
• Auto-save markdown report to Downloads folder on manual runs
• Fast mode (--fast) for sub-second auto-run startup
• Positional action syntax (tr300 update, tr300 install, tr300 uninstall) with legacy flag compatibility
• Resilient self-update with cargo-first probing and shell/PowerShell installer fallbacks
• Conditional platform detail rows for machine model, CPU core topology, ZFS health, motherboard, BIOS, and RAM slots when the host exposes them
• Self-installation with shell alias and auto-run

Installation

TR-300 ships prebuilt binaries — no Rust toolchain required to install or run. Pick the installer that matches your operating system and (on Windows) whether you have admin rights on the machine.

Windows — Global Edition (recommended for personal machines)

Installs to C:\Program Files\tr300\bin\tr300.exe and adds it to system PATH so every terminal on the machine can find it. Requires admin (UAC prompt).

Two equivalent download options — pick one, not both. Both install to the same location; installing both creates duplicate Add/Remove Programs entries.

After install, open a new terminal and run tr300. The binary is unsigned, so SmartScreen will show "Windows protected your PC" the first time — click More info → Run anyway. (Code signing is on the roadmap; see Releases for status.)

Windows — Corporate Edition (recommended for locked-down work machines)

Installs to %LocalAppData%\Programs\tr300\bin\tr300.exe and adds it to your user PATH only — no admin, no UAC, no system-wide changes. Use this on machines managed by Intune / Active Directory / Group Policy when you don't have admin rights but still need to install software.

Same "pick ONE format" rule as the Global Edition. If WDAC / AppLocker blocks both, your only options are the bare-EXE path below or asking IT to allowlist one of these installers.

Choosing between Global and Corporate Edition

If you accidentally install both editions, they coexist (different Add/Remove Programs entries) but PATH ordering picks which one wins. Uninstall one before installing the other for a clean state.

macOS / Linux

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/QubeTX/qube-machine-report/releases/latest/download/tr300-installer.sh | sh

Installs to ~/.cargo/bin/tr300 and modifies your shell's PATH. Does not require Rust — downloads the prebuilt binary from the GitHub Release.

Alternative install methods

powershell -ExecutionPolicy ByPass -c "irm https://github.com/QubeTX/qube-machine-report/releases/latest/download/tr300-installer.ps1 | iex"

Installs to %USERPROFILE%\.cargo\bin\tr300.exe (the directory is created automatically — Rust is not required). Modifies user PATH only. Fails if PowerShell ExecutionPolicy is Restricted and not overridden; the MSI / EXE installers above don't have that limitation.

Download tr300-x86_64-pc-windows-msvc.zip, extract tr300.exe, place it anywhere you can write to (your Desktop, a USB stick, C:\bin, etc.). Run by typing the full path or by adding the containing directory to your PATH manually. Useful for portable use, USB sticks, and scenarios where any installer is blocked.

Requires Rust 1.95.0 or later (rustup update stable if needed). Most users should NOT use these paths — they download and compile the source instead of using the prebuilt binary, which is slower and requires the Rust toolchain.

From crates.io:

cargo install tr300

From a specific Git tag:

rustup update stable
cargo install --git https://github.com/QubeTX/qube-machine-report.git --tag v3.15.0

Local clone for development:

git clone https://github.com/QubeTX/qube-machine-report.git
cd qube-machine-report
cargo build --release

Usage

# Display system report (default)
tr300

# Use ASCII characters instead of Unicode
tr300 --ascii

# Output as JSON
tr300 --json

# Custom title
tr300 --title "MY SERVER"

# Disable colors
tr300 --no-color

# Self-update to the latest release
tr300 update
# Legacy form still works:
tr300 --update

# Install to shell profile (adds 'report' alias + auto-run)
tr300 install
# Legacy form still works:
tr300 --install

# Remove from shell profile
tr300 uninstall
# Legacy form still works:
tr300 --uninstall

# Show help
tr300 --help

Example Output

┌┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┬┐
├┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┤
│            QUBETX DEVELOPER TOOLS                 │
│             TR-300 MACHINE REPORT                 │
├──────────────┬────────────────────────────────────┤
│ OS           │ Windows 11 24H2                    │
│ KERNEL       │ Windows 10.0.26200                 │
├──────────────┼────────────────────────────────────┤
│ HOSTNAME     │ DESKTOP-ABC123                     │
│ MACHINE IP   │ 192.168.1.100                      │
│ CLIENT  IP   │ Not connected                      │
│ DNS  IP 1    │ 192.168.1.1                        │
│ USER         │ emmett                             │
├──────────────┼────────────────────────────────────┤
│ PROCESSOR    │ Intel Core Ultra 7 155H            │
│ CORES        │ 22 vCPU(s) / 1 Socket(s)           │
│ HYPERVISOR   │ Bare Metal                         │
│ CPU FREQ     │ 1.4 GHz                            │
│ LOAD  1m     │ ███████░░░░░░░░░░░░░░░░░░░░░░░░░░░ │
│ LOAD  5m     │ █████░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │
│ LOAD 15m     │ ████░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │
├──────────────┼────────────────────────────────────┤
│ VOLUME       │ 848.18/935.54 GB [90.66%]          │
│ DISK USAGE   │ █████████████████████████████░░░░░ │
├──────────────┼────────────────────────────────────┤
│ MEMORY       │ 18.00/31.52 GiB [57.1%]            │
│ USAGE        │ ██████████████████░░░░░░░░░░░░░░░░ │
├──────────────┼────────────────────────────────────┤
│ LAST LOGIN   │ Login tracking unavailable         │
│ UPTIME       │ 5h 38m                             │
├──────────────┴────────────────────────────────────┤
└──────────────┴────────────────────────────────────┘

Command Line Options

Positional actions can be written without a double dash. They are mutually exclusive with each other and with the legacy action flags.

Self-Update

Both action forms update to the latest release:

tr300 update
tr300 --update

tr300 update detects how this binary was installed and downloads the matching installer for an in-place upgrade — no manual download required.

On Windows (v3.15.0+):

Detection uses a HKCU\Software\TR300\InstallSource registry marker that the four first-class installers write at install time. If the marker is missing (legacy install from before v3.15.0), the updater falls back to inspecting the running binary's path: C:\Program Files\tr300\ → MSI Global, %LocalAppData% \Programs\tr300\ → MSI Corporate, ~\.cargo\bin\ → legacy chain.

On macOS / Linux:

1. Checks the latest release on GitHub. If you're already current, exits 0 without changing anything.
2. Tries cargo install tr300 --force first when cargo --version succeeds. If rustup is present, it runs rustup update stable best-effort first so cargo installs against the current MSRV.
3. Falls through to the cargo-dist shell installer: curl | sh then wget | sh.

Manual fallback (any platform): if tr300 update fails, you can always re-download the installer for your platform from the Releases page and re-run it — WiX MajorUpgrade (MSI) and Inno Setup's AppId-based upgrade detection (EXE) handle in-place upgrades cleanly.

In --json mode, every response includes a top-level install_origin field on Windows (msi-global / msi-corporate / exe-global / exe-corporate / cargo-or-installer / unknown). Successful updates include the legacy "method" field plus a precise "strategy" value (msi_global, msi_corporate, exe_global, exe_corporate, or the legacy installer IDs). Failed updates include an "attempts" array with each strategy result and diagnostic message.

Release Automation

GitHub Actions handles both release assets and crates.io publishing:

• CI runs formatting, clippy, tests, release builds, speed checks, audit, and cargo-dist planning on pushes to the default branch.
• Crates.io Publish runs only after CI succeeds for that default-branch commit, checks whether the manifest version is already on crates.io with a descriptive data-access User-Agent, reruns fmt/clippy/tests/package/dry-run with --locked, and publishes tr300 only when the repository CARGO_REGISTRY_TOKEN Actions secret is configured.
• Release is the cargo-dist workflow triggered by an explicit version tag such as v3.14.3; it builds the cross-platform archives and installers. New installer assets use tr300-installer.*; the workflow also publishes tr-300-installer.* compatibility aliases so v3.14.2 binaries can self-update after the old package name was removed. The cargo-dist config permits that checked-in workflow customization with allow-dirty = ["ci"].

Cargo.lock is tracked so the crates.io publish workflow uses the same resolved dependency set that local release verification used.

Elevation Tier

TR-300 detects whether it is running with elevated privileges (root on Unix / Administrator on Windows) and surfaces additional data when it is.

• Default (unelevated) — the report renders exactly as it always has, with one small addition on Linux and Windows: a single dim line below the table noting that running with sudo / Administrator would unlock more details (motherboard / BIOS / RAM slots on Linux; BitLocker status on Windows). This hint is never shown during --fast auto-run, so the prompt-ready experience is unchanged.
• Elevated — extra rows render inline (motherboard, BIOS, RAM slot summary on Linux when dmidecode is available; BitLocker status when readable on Windows).
• macOS — no elevation tier; everything TR-300 needs is accessible without sudo.

To opt out of the hint, run tr300 --no-elevation-hint (or wire the flag into your shell alias). The hint is rendered with ANSI dim, so respects --no-color as well.

The JSON output exposes this state under top-level keys elevated and elevation_unlocks_more for scripted consumers.

Installation to Shell Profile

Running tr300 install or tr300 --install will:

1. Remove existing TR-300 configuration (if present)
2. Add a report alias so you can type report instead of tr300
3. Configure auto-run on new interactive shell sessions

This means you can safely run tr300 install multiple times without duplicating profile blocks.

On Unix/macOS: Modifies ~/.bashrc and/or ~/.zshrc

On Windows: Modifies the Windows PowerShell CurrentUserCurrentHost profile ($PROFILE). Fresh Windows machines default ExecutionPolicy to Restricted, which blocks every .ps1 including the profile itself, so tr300 install runs a preflight that adjusts the CurrentUser scope to RemoteSigned when needed. RemoteSigned is the minimum policy that lets the local profile load — it still requires downloaded .ps1 files to be Authenticode-signed. The change is HKCU-only, affects only your user account, and does not require admin. If you have deliberately set AllSigned, tr300 install will not silently downgrade it; it prints a notice explaining the auto-run will not fire and leaves the policy alone. See Microsoft Learn — about_Execution_Policies.

To remove these additions, run tr300 uninstall or tr300 --uninstall. The uninstall does not roll back your execution policy — other PowerShell tooling typically relies on RemoteSigned, so restoring it would surprise users.

If tr300 install (or uninstall) hits a permissions error on Windows — common on work machines managed by Intune, Group Policy, AppLocker, or WDAC, and on personal machines where Documents is redirected to OneDrive — the tool prints a multi-paragraph explanation of what likely caused the failure (OneDrive offline / online-only files, an MDM lockdown, antivirus blocking the profile edit, a sharing violation, a disk-full condition, or a MAX_PATH overflow) along with concrete next steps: which path to ask IT to allowlist, where to add an antivirus exclusion, or how to takeown ownership. Manual tr300 invocations from the prompt always continue to work in this case; only the auto-run on new shells is affected, and you can re-run tr300 install once the underlying restriction is addressed.

Building from Source

Requirements:

• Rust 1.95.0 or later (rustup update stable)
• Cargo

# Debug build
cargo build

# Release build
cargo build --release

# Run tests
cargo test --workspace --all-targets

# Run clippy
cargo clippy --all-targets --workspace -- -D warnings

# Check formatting
cargo fmt --all -- --check

# Run with arguments
cargo run -- --ascii

Man Page (Linux/macOS)

A man page is auto-generated during build via clap_mangen. After building from source:

sudo cp man/tr300.1 /usr/local/share/man/man1/
man tr300

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

This project is licensed under the PolyForm Noncommercial License 1.0.0 - see the LICENSE file for details. This license permits noncommercial use, personal use, and use by charitable organizations, educational institutions, and government agencies.