tr200 2.0.0

package/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, ES Development LLC (https://emmetts.dev)
+Based on original work Copyright (c) 2024, U.S. Graphics, LLC.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,529 @@
+# TR-200 Machine Report
+SKU: TR-200, filed under Technical Reports (TR).
+
+## What is it?
+A machine information report by **SHAUGHNESSY V DEVELOPMENT INC.** (originally from [United States Graphics Company](https://x.com/usgraphics))
+
+"Machine Report" is similar to Neofetch, but very basic. It's a bash script (or PowerShell on Windows) that's linked in the user's login startup script (`.bashrc`, `.zshrc`, or PowerShell profile); it displays useful machine information right in the terminal session. The report automatically displays when a user logs in, opens a new terminal, or SSHs into the machine. See installation instructions below.
+
+<img src="https://github.com/usgraphics/TR-200/assets/8161031/2a8412dd-09de-45ff-8dfb-e5c6b6f19212" width="500" />
+
+## 🎉 Key Features
+
+This version includes major enhancements:
+
+- ✅ **Cross-Platform**: Linux, macOS, Windows (PowerShell), BSD (partial)
+- ✅ **Multi-Shell Support**: bash, zsh (macOS default), PowerShell
+- ✅ **Auto-Run Everywhere**: Boot, login, SSH, new terminal windows
+- ✅ **Clean Uninstall**: `uninstall` command removes all configurations
+- ✅ **lastlog2 Support**: Works with modern Debian/Raspberry Pi OS (Trixie+)
+- ✅ **Non-ZFS Support**: Works on standard ext4/APFS/NTFS/other filesystems
+- ✅ **Raspberry Pi Tested**: Fully working on ARM64 systems
+
+### Status Update
+
+~~‼️*** WARNING ***‼️~~
+
+~~Alpha release, only compatible with Debian systems with ZFS root partition running as `root` user. This is not ready for public use *at all*.~~
+
+**✅ This fork is stable and tested on:**
+- Raspberry Pi OS (Debian Trixie)
+- Standard Debian systems (with or without ZFS)
+- Non-root user installations
+- ARM64 and x86_64 architectures
+
+## Software Philosophy
+Since it is a bash script, you've got the source code. Just modify that for your needs. No need for any abstractions, directly edit the code. No modules, no DSL, no config files, none of it. Single file for easy deployment. Only abstraction that's acceptable is variables at the top of the script to customize the system, but it should stay minimal.
+
+Problem with providing tools with a silver spoon is that you kill the creativity of the users. Remember MySpace? Let people customize the hell out of it and share it. Central theme as you'll see is this:
+
+```
+ENCOURAGE USERS TO DIRECTLY EDIT THE SOURCE
+```
+
+When you build a templating engine, a config file, a bunch of switches, etc; it adds 1) bloat 2) complexity 3) limits customization because by definition, customization template engine is going to be less featureful than the source code itself. So let the users just edit the source. Keep it well organized.
+
+Another consideration is to avoid abstracting the source code at the expense of direct 1:1 readability. For e.g., the section "Machine Report" at the end of the bash script prints the output using `printf`—a whole bunch load of `printf` statements. There is no need to add loops or functions returning functions. What you see is roughly what will print. 1:1 mapping is important here for visual ID.
+
+## Design Philosophy
+Tabular, short, clear and concise. The tool's job is to inform the user of the current state of the system they are logging in or are operating. No emojis (except for the one used as a warning sign). No colors (as default, might add an option to add colors).
+
+## System Compatibility
+
+### Originally Designed For
+- AMD EPYC CPU
+- Debian OS
+- ZFS installed on root partition
+- VMWare Hypervisor
+
+### Now Also Works On
+- **Raspberry Pi** (ARM64 Cortex-A72)
+- **Standard Linux** filesystems (ext4, btrfs, xfs, etc.)
+- **Bare metal** and virtualized systems
+- **Non-root** user installations
+
+## Dependencies
+- `lscpu` (usually pre-installed)
+- `lastlog2` (modern Debian/Raspberry Pi OS) **OR** `lastlog` (legacy systems)
+
+If your system is different, things might break. Look up the offending line and you can try to fix it for your specific system.
+
+---
+
+# Installation
+
+## 📦 npm Install (Recommended - All Platforms)
+
+**The easiest way to install TR-200 on any platform:**
+
+```bash
+npm install -g tr200
+```
+
+**That's it!** Now you can run:
+
+```bash
+tr200
+# or
+report
+```
+
+**Requirements:**
+- Node.js 14.0.0 or later
+- bash (Linux/macOS) or PowerShell (Windows)
+
+**What this does:**
+- Downloads the TR-200 package from npm
+- Creates global `tr200` and `report` commands
+- Automatically detects your OS and runs the appropriate script
+
+**Note:** The npm version is for on-demand use. If you want TR-200 to auto-run on terminal startup, use one of the install scripts below instead.
+
+---
+
+## ⚡ Super Quick Install (install.sh)
+
+**Simplest method - fully automated!**
+
+```bash
+cd ~/git-projects && gh repo clone RealEmmettS/usgc-machine-report && \
+cd RealEmmettS-usgc-machine-report && ./install.sh
+```
+
+The `install.sh` script handles everything:
+- Detects your OS and architecture
+- Installs dependencies (lastlog2)
+- Backs up existing installations
+- Copies and configures the script
+- Tests everything works
+- Sets up the `report` alias
+
+**That's it! Type `report` or open a new terminal to see it in action.**
+
+---
+
+## 🧳 Downloadable Installer Bundle (GUI-friendly)
+
+Prefer not to touch the terminal? Download the pre-packaged zip (hosted soon at a friendly URL like `https://…/tr-200-machine-report.zip`), extract it anywhere, and double-click one of these launchers inside the extracted folder:
+
+| Platform | Launcher | What it does |
+| --- | --- | --- |
+| Windows | `install_windows.exe` | Runs the PowerShell installer via the bundled ps2exe executable so it works from Explorer |
+| macOS | `install_mac.command` | Opens Terminal automatically and runs `install.sh` with full macOS detection |
+| Linux (Debian/Ubuntu/Arch/Fedora/etc.) | `install_linux.sh` | Finds your terminal emulator, launches it, and runs `install.sh` with all the existing distro detection |
+
+Each launcher simply calls the same `install.sh`/`install_windows.ps1` logic already in this repo, so you get identical results without typing commands manually. Keep the extracted directory structure intact so the launchers can find the scripts.
+
+### Building the zip yourself
+
+Maintainers can regenerate the bundle with:
+
+```bash
+./tools/package_release.sh
+```
+
+The script creates `dist/tr-200-machine-report.zip` containing the launchers, `machine_report.sh`, documentation, and the latest Windows assets. If `pwsh` + `ps2exe` are available it also builds `install_windows.exe` automatically; otherwise it leaves the PowerShell installer in place with a warning so you can build the executable later on Windows.
+
+---
+
+## 🤖 Claude Code Automated Installation
+
+**Best for:** Using with [Claude Code](https://claude.ai/code) AI assistant
+
+Ask Claude Code:
+
+```
+Install usgc-machine-report from RealEmmettS/usgc-machine-report using install.sh
+```
+
+Or provide these specific instructions:
+
+```bash
+cd ~/git-projects && \
+gh repo clone RealEmmettS/usgc-machine-report && \
+cd RealEmmettS-usgc-machine-report && \
+./install.sh
+```
+
+Claude Code will automatically:
+1. Clone this repository
+2. Install `lastlog2` if on Debian/Raspberry Pi OS
+3. Copy script to `~/.machine_report.sh`
+4. Add to `.bashrc` with automatic run on login
+5. Create convenient `report` alias
+
+**Or provide these specific instructions to Claude Code:**
+
+```bash
+# 1. Clone the repository
+cd ~/git-projects
+gh repo clone RealEmmettS/usgc-machine-report
+
+# 2. Install dependencies (Debian/Ubuntu/Raspberry Pi OS)
+sudo apt install -y lastlog2
+
+# 3. Install the script
+cp ~/git-projects/RealEmmettS-usgc-machine-report/machine_report.sh ~/.machine_report.sh
+chmod +x ~/.machine_report.sh
+
+# 4. Add to .bashrc
+cat >> ~/.bashrc << 'EOF'
+
+# Machine Report alias - run anytime with 'report' command
+alias report='~/.machine_report.sh'
+
+# Run Machine Report only when in interactive mode
+if [[ $- == *i* ]]; then
+    ~/.machine_report.sh
+fi
+EOF
+
+# 5. Test installation
+~/.machine_report.sh
+```
+
+---
+
+## 🍎 macOS Installation
+
+**Requirements:**
+- macOS 10.13 (High Sierra) or later
+- Bash 4.0+ recommended (install via `brew install bash`)
+
+**Quick Install:**
+
+```bash
+cd ~/git-projects && gh repo clone RealEmmettS/usgc-machine-report && \
+cd RealEmmettS-usgc-machine-report && ./install.sh
+```
+
+**What works on macOS:**
+- ✅ OS version detection (via `sw_vers`)
+- ✅ CPU info (via `sysctl`)
+- ✅ Memory usage (via `vm_stat`)
+- ✅ Disk usage (via `df`)
+- ✅ Network info (via `scutil`)
+- ✅ System uptime (calculated from boot time)
+- ⚠️ Last login may show "unavailable" (macOS limitation)
+
+**macOS-Specific Notes:**
+- No package installation needed - uses built-in commands
+- Default Bash 3.2 works but Bash 4+ recommended
+- To install newer Bash: `brew install bash`
+- Script automatically detects macOS and uses appropriate commands
+
+### 🐚 zsh Installation (macOS Default Shell)
+
+**Modern macOS (Catalina 10.15+) uses zsh by default**, not bash. If you're using zsh, follow these instructions:
+
+**Quick Install for zsh:**
+
+```bash
+# Clone and install the script
+cd ~/Downloads && git clone https://github.com/RealEmmettS/usgc-machine-report.git && \
+cp ~/Downloads/usgc-machine-report/machine_report.sh ~/.machine_report.sh && \
+chmod +x ~/.machine_report.sh
+
+# Add to .zshrc (not .bashrc!)
+cat >> ~/.zshrc << 'EOF'
+
+# Machine Report alias - run anytime with 'report' command
+alias report='~/.machine_report.sh'
+
+# Run Machine Report only when in interactive mode
+if [[ $- == *i* ]]; then
+    ~/.machine_report.sh
+fi
+EOF
+
+# Clean up cloned repo (optional)
+rm -rf ~/Downloads/usgc-machine-report
+
+echo "✅ Installation complete! Open a new terminal or type: source ~/.zshrc"
+```
+
+**Important zsh Notes:**
+- ✅ Use `~/.zshrc` instead of `~/.bashrc`
+- ✅ The script works identically in zsh - no code changes needed
+- ✅ Test with: `zsh -c "source ~/.zshrc && report"`
+- ℹ️ To check your shell: `echo $SHELL` (should show `/bin/zsh`)
+
+---
+
+## 📦 Quick Install (Manual - Raspberry Pi OS / Debian)
+
+**One-liner installation:**
+
+```bash
+cd ~/git-projects && gh repo clone RealEmmettS/usgc-machine-report && \
+sudo apt install -y lastlog2 && \
+cp ~/git-projects/RealEmmettS-usgc-machine-report/machine_report.sh ~/.machine_report.sh && \
+chmod +x ~/.machine_report.sh && \
+cat >> ~/.bashrc << 'EOF'
+
+# Machine Report alias - run anytime with 'report' command
+alias report='~/.machine_report.sh'
+
+# Run Machine Report only when in interactive mode
+if [[ $- == *i* ]]; then
+    ~/.machine_report.sh
+fi
+EOF
+echo "✅ Installation complete! Type 'report' or open a new terminal."
+```
+
+**Step-by-step installation:**
+
+1. **Clone the repository**:
+   ```bash
+   cd ~/git-projects
+   gh repo clone RealEmmettS/usgc-machine-report
+   ```
+
+2. **Install dependencies** (for modern Debian/Raspberry Pi OS):
+   ```bash
+   sudo apt install -y lastlog2
+   ```
+
+   *Note: On systems with the legacy `lastlog` command, this step is optional. The script automatically detects and uses whichever is available.*
+
+3. **Copy the script to your home directory**:
+   ```bash
+   cp ~/git-projects/RealEmmettS-usgc-machine-report/machine_report.sh ~/.machine_report.sh
+   chmod +x ~/.machine_report.sh
+   ```
+
+4. **Add to `.bashrc` for automatic display on login**:
+   ```bash
+   cat >> ~/.bashrc << 'EOF'
+
+# Machine Report alias - run anytime with 'report' command
+alias report='~/.machine_report.sh'
+
+# Run Machine Report only when in interactive mode
+if [[ $- == *i* ]]; then
+    ~/.machine_report.sh
+fi
+EOF
+   ```
+
+5. **Test the installation**:
+   ```bash
+   ~/.machine_report.sh
+   ```
+
+---
+
+## 🛠️ Manual Installation (Advanced)
+
+For login sessions over ssh, reference the script `~/.machine_report.sh` in your `.bashrc` file. Make sure the script is executable by running `chmod +x ~/.machine_report.sh`.
+
+Copy `machine_report.sh` from this repository and add it to `~/.machine_report.sh` ('.' for hidden file if you wish). Reference it in your `.bashrc` file as follows:
+
+```bash
+# This is your .bashrc file.
+# Add the following lines anywhere in the file.
+
+# Machine Report alias - run anytime with 'report' command
+alias report='~/.machine_report.sh'
+
+# Run Machine Report only when in interactive mode
+if [[ $- == *i* ]]; then
+    ~/.machine_report.sh
+fi
+```
+
+---
+
+## 🚀 Using the Report Command
+
+Once installed, you can run the machine report anytime with:
+
+```bash
+report
+```
+
+Or directly:
+
+```bash
+~/.machine_report.sh
+```
+
+**Automatic display:** Machine Report will automatically appear when you open a new terminal or SSH into the machine.
+
+---
+
+## 🔧 Customization
+
+Following the project's philosophy, **directly edit the source** to customize:
+
+```bash
+nano ~/.machine_report.sh
+```
+
+**Common customizations:**
+- Line 15: `report_title` - Change the header text
+- Line 18: `zfs_filesystem` - Set your ZFS pool name
+- Lines 6-11: Adjust column widths and padding
+
+---
+
+## ✅ Compatibility Matrix
+
+| System | Architecture | Filesystem | Bash | Status |
+|--------|-------------|------------|------|--------|
+| **Raspberry Pi OS (Trixie)** | ARM64 | ext4 | 5.x | ✅ **Tested** |
+| **macOS Sonoma/Ventura** | ARM64/x86_64 | APFS | 4.0+ | ✅ **Full Support** |
+| macOS (default Bash 3.2) | ARM64/x86_64 | APFS | 3.2 | ⚠️ Works with warnings |
+| Debian 13 (Trixie) | x86_64 | ext4/ZFS | 5.x | ✅ Working |
+| Debian 12 (Bookworm) | x86_64 | ext4/ZFS | 5.x | ✅ Working |
+| Ubuntu 24.04+ | x86_64 | ext4/ZFS | 5.x | ✅ Should work |
+| Fedora/RHEL 9 | x86_64 | ext4/xfs/btrfs | 5.x | ✅ Should work |
+| Arch/Manjaro | x86_64 | ext4/btrfs | 5.x | ✅ Should work |
+| Alpine Linux | x86_64 | ext4 | varies | ⚠️ May need tweaks |
+| BSD (FreeBSD/OpenBSD) | x86_64 | UFS/ZFS | varies | ⚠️ Partial support |
+
+---
+
+## 🐛 Troubleshooting
+
+### lastlog command not found
+
+**Solution:** Install `lastlog2` package:
+```bash
+sudo apt install -y lastlog2
+```
+
+This fork automatically handles both `lastlog2` (modern) and `lastlog` (legacy).
+
+### CPU frequency shows blank
+
+This is normal on some ARM systems where CPU frequency isn't exposed via `/proc/cpuinfo`. The script continues to work normally.
+
+### Disk usage shows wrong partition
+
+Edit `~/.machine_report.sh` and modify:
+- Line 293: `root_partition="/"` to your desired partition
+
+For ZFS systems, edit:
+- Line 18: `zfs_filesystem="zroot/ROOT/os"` to your pool name
+
+---
+
+## 📝 Changelog (Fork-specific)
+
+### v2.0.0 (2026-01-30) - **SHAUGHV REBRAND + NPM RELEASE**
+**Complete Rebrand + Auto-Run Enhancements + npm Publishing**
+
+- 📦 **Published to npm**: Install globally with `npm install -g tr200`
+  - Package name: `tr200` (https://www.npmjs.com/package/tr200)
+  - Commands: `tr200` and `report` work globally after npm install
+  - Cross-platform Node.js wrapper auto-detects OS and runs appropriate script
+- 🎨 **Rebranded to SHAUGHNESSY V DEVELOPMENT INC.**: New company branding throughout
+- 🎨 **TR-200 MACHINE REPORT**: Updated product line designation
+- 📜 **Copyright Updated**: Now under ES Development LLC (https://emmetts.dev)
+- 🔄 **`uninstall` Command**: Clean removal of all configurations on all platforms
+- 🐚 **zsh Support**: Full support for macOS default shell (Catalina+)
+- 🔐 **Login Shell Support**: Auto-runs on SSH/console login via `.profile`/`.zprofile`
+- ⚡ **Boot-Time Execution (Linux)**: systemd user service runs report at boot
+- ⚡ **Boot-Time Execution (macOS)**: LaunchAgent runs report at login
+- ⚡ **Boot-Time Execution (Windows)**: Task Scheduler runs report at login
+- 🧹 **Clear Screen**: Screen cleared before auto-run for clean display
+- 🗂️ **File Renames**: TR-100-MachineReport.ps1 → TR-200-MachineReport.ps1
+- 📁 **Install Directory**: Windows now uses `$HOME\TR200` instead of `$HOME\TR100`
+- 🛠️ **Enhanced Windows Installer**: Task Scheduler integration, uninstall support
+- 🤖 **GitHub Actions**: Automated npm publishing on GitHub release
+
+**npm Packaging Details:**
+- Node.js wrapper (`bin/tr200.js`) detects OS and spawns bash/PowerShell
+- Package includes: `machine_report.sh`, `WINDOWS/TR-200-MachineReport.ps1`
+- Requires Node.js 14+ (uses `child_process.spawn()` with `stdio: 'inherit'`)
+- Supports: Windows, macOS, Linux, FreeBSD, OpenBSD
+
+**Breaking Changes:**
+- Windows install directory changed from `TR100` to `TR200`
+- PowerShell function names changed from `Show-TR100Report` to `Show-TR200Report`
+- Users upgrading should run `uninstall` first, then reinstall
+
+**Tested On:**
+- Windows 11 (PowerShell 7+)
+- Raspberry Pi OS (Debian Trixie, ARM64)
+- macOS (zsh and bash shells)
+- Linux (bash and zsh shells)
+
+---
+
+### v1.2.0-RealEmmettS (2025-11-10) - **PRODUCTION READY**
+**Cross-Platform Compatibility Release**
+
+- ✅ **Full macOS Support**: Native `sysctl`, `vm_stat`, `scutil` integration
+- ✅ **Multi-Linux Support**: Works on Debian, Ubuntu, Arch, Fedora, RHEL
+- ✅ **Robust Error Handling**: Graceful fallbacks, no crashes on missing commands
+- ✅ **Fixed ZFS Bug**: Correct disk percentage calculation
+- ✅ **ARM Improvements**: CPU frequency now displays on Raspberry Pi
+- ✅ **Bash 4.0+ Support**: With Bash 3.2 compatibility warnings
+- ✅ **Enhanced install.sh**: macOS detection, Bash version checking
+- 🔧 **OS Detection Framework**: Automatic platform-specific command selection
+- 🔧 **Helper Functions**: `command_exists`, `file_readable`, `is_ipv4`
+- 📚 **Updated Documentation**: macOS installation guide, compatibility matrix
+
+**Breaking Changes:** None - fully backward compatible
+
+**Tested On:**
+- Raspberry Pi OS (Debian Trixie, ARM64)
+- macOS Sonoma (ARM64) - via analysis
+- Compatible with Debian 12/13, Ubuntu 24.04+, Arch, Fedora, RHEL
+
+### v1.1.0-RealEmmettS (2025-11-10)
+- Added `lastlog2` support for modern Debian systems
+- Added graceful fallback between `lastlog2` and `lastlog`
+- Improved non-ZFS filesystem support
+- Tested and verified on Raspberry Pi OS (ARM64)
+- Added comprehensive installation documentation
+- Added Claude Code optimized installation instructions
+- Added `report` alias for convenient on-demand execution
+
+### v1.0.0 (Original - US Graphics)
+- Initial release
+- Designed for Debian + ZFS + VMWare environments
+
+---
+
+## 🤝 Contributing
+
+This project is maintained by **ES Development LLC** (https://emmetts.dev).
+
+For the original upstream project, see: [usgraphics/usgc-machine-report](https://github.com/usgraphics/usgc-machine-report)
+
+Feel free to:
+- Fork this repository
+- Submit issues
+- Customize for your own needs (that's the philosophy!)
+
+---
+
+## 📄 License
+
+BSD 3 Clause License. Copyright 2026, ES Development LLC (https://emmetts.dev). See [`LICENSE`](LICENSE) file for license information.
+
+Based on original work by U.S. Graphics, LLC.