about-system 0.0.5 → 0.0.9

package/README.md

@@ -101,7 +101,7 @@ npx about-system
 
 The script uses a JSON settings file located at:
 - **Linux/macOS**: `~/.config/systeminfo-settings.json`
-- **Windows**: `%APPDATA%\Local\systeminfo-settings.json`
+- **Windows**: `%APPDATA%\systeminfo-settings.json`
 
 #### Settings Commands
 

package/package.json

@@ -1,22 +1,31 @@
 {
   "name": "about-system",
-  "version": "0.0.5",
+  "version": "0.0.9",
   "description": "A Node.js script to display key system information with emojis. Cross-platform support for Windows, macOS, and Linux with customizable output and caching.",
-  "main": "about-system.js",
+  "main": "src/about-system.js",
   "bin": {
-    "about-system": "./about-system.js"
+    "about-system": "./src/about-system.js",
+    "test-speed": "./src/test-speed-cloudflare.js"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./src/systeminfo-types.d.ts",
+      "import": "./src/about-system.js"
+    }
   },
   "scripts": {
     "ship": "npx standard-version --release-as patch; npm publish",
-    "start": "node about-system.js",
-    "install-greeting": "node about-system.js --install",
-    "show-settings": "node about-system.js --settings-show",
-    "reset-settings": "node about-system.js --settings-reset",
-    "clear-cache": "node about-system.js --cache-clear",
-    "help": "node about-system.js --help"
+    "start": "node src/about-system.js",
+    "test-speed": "node src/test-speed-cloudflare.js",
+    "install-greeting": "node src/about-system.js --install",
+    "show-settings": "node src/about-system.js --settings-show",
+    "reset-settings": "node src/about-system.js --settings-reset",
+    "clear-cache": "node src/about-system.js --cache-clear",
+    "help": "node src/about-system.js --help"
   },
   "keywords": [
-    "about-system",
+    "src/about-system",
     "system",
     "information",
     "cli",
@@ -38,7 +47,7 @@
   },
   "homepage": "https://github.com/vtempest/server-shell-setup#readme",
   "files": [
-    "about-system.js",
+    "src/about-system.js",
     "README.md",
     "package.json"
   ],
@@ -51,5 +60,8 @@
   "preferGlobal": true,
   "directories": {
     "bin": "."
+  },
+  "dependencies": {
+    "ora": "^8.2.0"
   }
 }

package/{about-system.js → src/about-system.js}

@@ -15,16 +15,15 @@
  *   Network info (ip, city, domain, isp) is fetched from ipinfo.io
  *   only if needed.
  *
- *   Author: vtempest
- *   Updated: 2025-09-01
- *   License: MIT
+ *   @author: vtempest
+ *   @license: MIT
  */
 
-const os = require('os');
-const fs = require('fs');
-const path = require('path');
-const { execSync } = require('child_process');
-const https = require('https');
+import os from 'os';
+import fs from 'fs';
+import path from 'path';
+import { execSync } from 'child_process';
+import https from 'https';
 
 // Cache configuration
 const CACHE_FILE = path.join(os.tmpdir(), 'systeminfo-cache.json');
@@ -337,9 +336,9 @@ const infoFunctions = {
     const addresses = [];
     
     for (const name of Object.keys(interfaces)) {
-      for (const interface of interfaces[name]) {
-        if (interface.family === 'IPv4' && !interface.internal) {
-          addresses.push(interface.address);
+      for (const device of interfaces[name]) {
+        if (device.family === 'IPv4' && !device.internal) {
+          addresses.push(device.address);
         }
       }
     }
@@ -439,7 +438,26 @@ const infoFunctions = {
     
     let cpuName = '';
     
-    if (IS_LINUX) {
+    if (IS_WINDOWS) {
+      // Windows-specific CPU detection using WMIC
+      try {
+        const wmic = execCommand('wmic cpu get name /format:list');
+        const nameMatch = wmic.match(/Name=(.+)/);
+        if (nameMatch) {
+          cpuName = nameMatch[1].trim();
+        }
+      } catch {}
+      
+      // Fallback to PowerShell if WMIC fails
+      if (!cpuName) {
+        try {
+          const ps = execCommand('powershell.exe -Command "Get-WmiObject -Class Win32_Processor | Select-Object -ExpandProperty Name"');
+          if (ps.trim()) {
+            cpuName = ps.trim();
+          }
+        } catch {}
+      }
+    } else if (IS_LINUX) {
       // Try lscpu first (like bash script)
       try {
         const lscpu = execCommand('lscpu');
@@ -467,7 +485,7 @@ const infoFunctions = {
       // Use Node.js os module for other platforms
       const cpus = os.cpus();
       if (cpus.length > 0) {
-        cpuName = cpus[0].model;
+        cpuName = cpus[0].model.trim().replace(/[\r\n]+/g, ' ');
       }
     }
     
@@ -477,7 +495,7 @@ const infoFunctions = {
     }
 
     //remove "with ..." from cpuName
-    cpuName = cpuName.replace(/with .*/, '');
+    cpuName = cpuName.trim().replace(/with .*/, '');
     
     const color = colors[settings.colors.cpu] || colors.orange;
     const emoji = settings.display.show_emojis ? '📈 ' : '';
@@ -490,7 +508,36 @@ const infoFunctions = {
     const cached = getCachedValue(this.cache, 'gpu', settings);
     if (cached) return cached;
     
-    if (IS_LINUX) {
+    if (IS_WINDOWS) {
+      try {
+        // Get GPU information using WMIC
+        const wmic = execCommand('wmic path win32_VideoController get name /format:list');
+        const nameMatch = wmic.match(/Name=(.+)/);
+        if (nameMatch) {
+          const gpu = nameMatch[1].trim();
+          if (gpu && gpu !== '' && !gpu.includes('Microsoft Basic')) {
+            const color = colors[settings.colors.gpu] || colors.yellow;
+            const emoji = settings.display.show_emojis ? '🎮 ' : '';
+            const result = `${color}${emoji}${gpu}`;
+            setCachedValue(this.cache, 'gpu', result);
+            return result;
+          }
+        }
+      } catch {}
+      
+      // Fallback using PowerShell
+      try {
+        const ps = execCommand('powershell.exe -Command "Get-WmiObject -Class Win32_VideoController | Where-Object {$_.Name -notlike \'*Microsoft Basic*\'} | Select-Object -First 1 -ExpandProperty Name"');
+        if (ps.trim()) {
+          const gpu = ps.trim();
+          const color = colors[settings.colors.gpu] || colors.yellow;
+          const emoji = settings.display.show_emojis ? '🎮 ' : '';
+          const result = `${color}${emoji}${gpu}`;
+          setCachedValue(this.cache, 'gpu', result);
+          return result;
+        }
+      } catch {}
+    } else if (IS_LINUX) {
       try {
         const lspci = execCommand('lspci');
         // Look for VGA and specific GPU brands like the bash script
@@ -526,7 +573,40 @@ const infoFunctions = {
     const cached = getCachedValue(this.cache, 'disk_used', settings);
     if (cached) return cached;
     
-    if (IS_LINUX) {
+    if (IS_WINDOWS) {
+      try {
+        // Get disk usage for C: drive using PowerShell
+        const ps = execCommand('powershell.exe -Command "Get-WmiObject -Class Win32_LogicalDisk -Filter \'DeviceID="C:"\' | Select-Object @{Name=\'PercentFree\';Expression={[math]::Round((($_.FreeSpace / $_.Size) * 100), 0)}} | Select-Object -ExpandProperty PercentFree"');
+        if (ps.trim()) {
+          const percentFree = parseInt(ps.trim());
+          const percentUsed = 100 - percentFree;
+          const color = colors[settings.colors.disk_used] || colors.purple;
+          const emoji = settings.display.show_emojis ? '📁 ' : '';
+          const result = `${color}${emoji}${percentUsed}%`;
+          setCachedValue(this.cache, 'disk_used', result);
+          return result;
+        }
+      } catch {}
+      
+      // Fallback using WMIC
+      try {
+        const wmic = execCommand('wmic logicaldisk where "DeviceID=\'C:\'" get Size,FreeSpace /format:list');
+        const sizeMatch = wmic.match(/Size=(\d+)/);
+        const freeMatch = wmic.match(/FreeSpace=(\d+)/);
+        
+        if (sizeMatch && freeMatch) {
+          const size = parseInt(sizeMatch[1]);
+          const free = parseInt(freeMatch[1]);
+          const used = size - free;
+          const percentUsed = Math.round((used / size) * 100);
+          const color = colors[settings.colors.disk_used] || colors.purple;
+          const emoji = settings.display.show_emojis ? '📁 ' : '';
+          const result = `${color}${emoji}${percentUsed}%`;
+          setCachedValue(this.cache, 'disk_used', result);
+          return result;
+        }
+      } catch {}
+    } else if (IS_LINUX) {
       try {
         const df = execCommand('df -h');
         let diskUsage = '';
@@ -618,7 +698,44 @@ const infoFunctions = {
     const cached = getCachedValue(this.cache, 'top_process', settings);
     if (cached) return cached;
     
-    if (IS_LINUX) {
+    if (IS_WINDOWS) {
+      try {
+        // Get top process using PowerShell performance counters
+        const ps = execCommand('powershell.exe -Command "Get-Counter \'\\Process(*)\\% Processor Time\' | Select-Object -ExpandProperty CounterSamples | Where-Object {$_.InstanceName -notin @(\'_Total\', \'Idle\')} | Sort-Object CookedValue -Descending | Select-Object -First 1 | Select-Object InstanceName, @{Name=\'CPU%\'; Expression={[math]::Round($_.CookedValue, 1)}}"');
+        const lines = ps.split('\n').filter(line => line.trim());
+        if (lines.length > 0) {
+          const parts = lines[0].trim().split(/\s+/);
+          if (parts.length >= 2) {
+            const processName = parts[0];
+            const cpuPercent = parts[1];
+            const color = colors[settings.colors.top_process] || colors.magenta;
+            const emoji = settings.display.show_emojis ? '🔝 ' : '';
+            const result = `${color}${emoji}${cpuPercent}% ${processName}`;
+            setCachedValue(this.cache, 'top_process', result);
+            return result;
+          }
+        }
+      } catch {}
+      
+      // Fallback using tasklist
+      try {
+        const tasklist = execCommand('tasklist /fo csv | findstr /v "Image Name" | sort /r /+5');
+        const lines = tasklist.split('\n').filter(line => line.trim());
+        if (lines.length > 0) {
+          const line = lines[0];
+          const parts = line.split(',');
+          if (parts.length >= 5) {
+            const processName = parts[0].replace(/"/g, '').split('.')[0];
+            const memoryUsage = parts[4].replace(/"/g, '').replace(/[,\s]/g, '');
+            const color = colors[settings.colors.top_process] || colors.magenta;
+            const emoji = settings.display.show_emojis ? '🔝 ' : '';
+            const result = `${color}${emoji}${memoryUsage}KB ${processName}`;
+            setCachedValue(this.cache, 'top_process', result);
+            return result;
+          }
+        }
+      } catch {}
+    } else if (IS_LINUX) {
       try {
         const ps = execCommand('ps -eo pcpu,comm --sort=-%cpu --no-headers');
         const lines = ps.split('\n');
@@ -654,7 +771,36 @@ const infoFunctions = {
     const cached = getCachedValue(this.cache, 'device', settings);
     if (cached) return cached;
     
-    if (IS_LINUX) {
+    if (IS_WINDOWS) {
+      try {
+        // Get computer model using WMIC
+        const wmic = execCommand('wmic csproduct get name /format:list');
+        const nameMatch = wmic.match(/Name=(.+)/);
+        if (nameMatch) {
+          const device = nameMatch[1].trim();
+          if (device && device !== '') {
+            const color = colors[settings.colors.device] || colors.blue;
+            const emoji = settings.display.show_emojis ? '💻 ' : '';
+            const result = `${color}${emoji}${device}`;
+            setCachedValue(this.cache, 'device', result);
+            return result;
+          }
+        }
+      } catch {}
+      
+      // Fallback using PowerShell
+      try {
+        const ps = execCommand('powershell.exe -Command "Get-WmiObject -Class Win32_ComputerSystem | Select-Object -ExpandProperty Model"');
+        if (ps.trim()) {
+          const device = ps.trim();
+          const color = colors[settings.colors.device] || colors.blue;
+          const emoji = settings.display.show_emojis ? '💻 ' : '';
+          const result = `${color}${emoji}${device}`;
+          setCachedValue(this.cache, 'device', result);
+          return result;
+        }
+      } catch {}
+    } else if (IS_LINUX) {
       try {
         // Check for Android
         if (commandExists('getprop')) {
@@ -1240,17 +1386,15 @@ function handleSettingsCommand(args) {
     return true;
   }
   
-  const cacheResetIndex = args.indexOf('--cache-clear');
+  const cacheResetIndex = args.indexOf('--refresh');
   if (cacheResetIndex !== -1) {
     try {
       if (fs.existsSync(CACHE_FILE)) {
         fs.unlinkSync(CACHE_FILE);
       }
-      console.log('Cache cleared');
     } catch (error) {
       console.error('Error clearing cache:', error.message);
     }
-    return true;
   }
   
   const setIndex = args.indexOf('--set');
@@ -1430,7 +1574,7 @@ Options:
   --settings-init      Initialize settings file with defaults
   --settings-show      Display current settings
   --settings-reset     Reset settings to defaults
-  --cache-clear        Clear the cache file
+  --refresh        Clear the cache file
   --set <key> <value>  Set a configuration value (use dot notation)
 
 Examples:
@@ -1490,11 +1634,11 @@ Linux-specific features:
 }
 
 // Run the script
-if (require.main === module) {
+// if (import.meta.url === `file://${process.argv[1]}`) {
   main().catch(error => {
     console.error('Error:', error.message);
     process.exit(1);
   });
-}
+// }
 
-module.exports = { displaySystemInfo, installShellGreeting };
+export { displaySystemInfo, installShellGreeting };

package/src/test-speed-cloudflare.js

@@ -0,0 +1,51 @@
+import ora from 'ora';
+import { spawn, execSync } from 'child_process';
+
+
+/**
+ * Tests the download speed in MB/s using Cloudflare's speed test.
+ * Optionally displays a spinner message during the test.
+ * Their official package is @cloudflare/speedtest and it shows errors and too much output.
+ * This script uses a process to hide the errors and give speed in MB/s via CLI or import.
+ * @param {boolean} [showMessage=true] - Whether to show explanation message while testing.
+ * @returns {Promise<string>} The measured download speed in MB/s as a string (e.g., "12.3").
+ *
+ * @example
+ * import { testDownloadSpeed } from './test-speed-cloudflare.js';
+ * const downloadSpeed = await testDownloadSpeed(false);
+ * console.log(downloadSpeed); // e.g., "12.3"
+ */
+export async function testDownloadSpeed(showMessage = true) {
+  var spinner;
+  if (showMessage) 
+    spinner = ora('Testing download speed in MB/s using Cloudflare, runs for 1 minute').start();
+
+  // globally install @cloudflare/speedtest
+  await execSync('npm i -g @cloudflare/speedtest');
+
+  const result = await new Promise((resolve) => {
+    const child = spawn('node', [
+      '-e',
+      "import SpeedTest from '@cloudflare/speedtest'; new SpeedTest({iterations: 1}).onFinish = r => console.log((r.getDownloadBandwidth() / 8388608).toFixed(1))"
+    ]);
+
+    let output = '';
+    child.stdout.on('data', (data) => {
+      output += data.toString();
+    });
+    // Extract last number from output
+    child.on('close', () => {
+      resolve(output.trim().split('\n').pop().match(/(\d+(\.\d+)?)/)?.[0]);
+    });
+
+  });
+
+  if (showMessage) spinner.succeed(result + ' MB/s');
+  return result;
+}
+
+// try{
+// run if file is executed directly
+// if (process?.env.npm_lifecycle_event?.length > 0 || import.meta.url === `file://${process.argv[1]}` || import.meta.url === process.argv[1] || import.meta.url === `file://${process.cwd()}/${process.argv[1]}`) 
+  testDownloadSpeed();
+// } catch { }