systeminformation vs os vs node-os-utils vs os-utils
Node.js 中获取操作系统与硬件信息的工具库选型
搜索包...
systeminformationosnode-os-utilsos-utils类似的npm包:

Node.js 中获取操作系统与硬件信息的工具库选型

os 是 Node.js 内置模块，提供基础的操作系统信息接口；node-os-utils、os-utils 和 systeminformation 是第三方 npm 包，用于扩展或简化对系统资源（如 CPU、内存、磁盘、网络等）的访问。这些工具在构建监控工具、性能分析器、DevOps 脚本或 Electron 应用时非常有用。其中 os 最轻量但功能有限，而第三方包在易用性、跨平台支持和数据粒度上各有侧重。

npm下载趋势

3 年

GitHub Stars 排名

统计详情

npm包名称
下载量
Stars
大小
Issues
发布时间
License
systeminformation6,022,5443,063846 kB1114 天前MIT
os810,73120-05 年前MIT
node-os-utils293,9021311.14 MB145 个月前MIT
os-utils40,592247-1113 年前MIT

Node.js 获取系统信息：os、node-os-utils 与 systeminformation 深度对比

在构建性能监控工具、桌面应用（如 Electron）或 DevOps 脚本时，开发者常需读取操作系统和硬件信息。Node.js 提供了内置 os 模块，社区也涌现出多个第三方库。本文将深入比较 os（内置）、node-os-utils、已弃用的 os-utils 和功能全面的 systeminformation，帮助你根据实际需求做出技术选型。

⚠️ 先说结论：os-utils 已弃用，勿用！

通过查阅 npm 页面 和 GitHub 仓库，os-utils 自 2015 年后无实质性更新，且 npm 页面明确标注 "This package has been deprecated"。新项目绝对不要使用 os-utils。以下分析将聚焦其余三个选项。

🧱 基础能力：能拿到哪些信息？

内置 os 模块：只给“原材料”

Node.js 内置的 os 模块提供最基础的系统元数据，但不包含实时资源使用率（如当前 CPU 占用）。例如，它能告诉你有 8 个 CPU 核心，但不能直接告诉你现在用了多少。

// os: 基础信息示例
const os = require('os');

console.log(os.platform());      // 'darwin', 'win32', 'linux'
console.log(os.arch());          // 'x64', 'arm64'
console.log(os.totalmem());      // 总内存（字节）
console.log(os.freemem());       // 可用内存（字节）
console.log(os.cpus().length);   // CPU 核心数
console.log(os.networkInterfaces()); // 网络接口列表

要获取 CPU 使用率，你得自己记录两次 os.cpus() 的时间差并计算：

// os: 手动计算 CPU 使用率（简化版）
function calculateCpuUsage() {
  const startMeasure = os.cpus();
  return new Promise(resolve => {
    setTimeout(() => {
      const endMeasure = os.cpus();
      let idleMs = 0, totalMs = 0;
      for (let i = 0; i < startMeasure.length; i++) {
        const start = startMeasure[i].times;
        const end = endMeasure[i].times;
        idleMs += (end.idle - start.idle);
        totalMs += (end.user - start.user) + (end.sys - start.sys) + (end.idle - start.idle);
      }
      resolve(100 * (1 - idleMs / totalMs));
    }, 1000);
  });
}

node-os-utils：轻量级实时监控

node-os-utils 封装了常见命令（如 top, free, df），以 Promise 方式返回实时使用率，API 简洁。

// node-os-utils: 实时资源使用率
const osu = require('node-os-utils');

// CPU 使用率（百分比）
osu.cpu.usage().then(usage => console.log(`CPU: ${usage}%`));

// 内存使用率
osu.mem.info().then(info => {
  console.log(`内存使用率: ${info.usedMemPercentage}%`);
});

// 磁盘使用率（指定路径）
osu.drive.info('/').then(info => {
  console.log(`磁盘使用率: ${info.availablePercentage}% 可用`);
});

但它不提供硬件详细信息（如 CPU 型号、GPU 信息），仅关注资源消耗。

systeminformation：硬件信息“百科全书”

systeminformation 提供极其详尽的系统与硬件数据，覆盖 BIOS、主板、CPU、内存条、显卡、电池、温度、进程等，且跨平台兼容性好。

// systeminformation: 全面硬件与系统信息
const si = require('systeminformation');

// CPU 详细信息（型号、频率、核心等）
si.cpu().then(data => console.log(data));

// 当前 CPU 负载（类似使用率）
si.currentLoad().then(data => console.log(`CPU 负载: ${data.currentload}%`));

// 内存详情（含物理内存条信息）
si.mem().then(data => console.log(data));

// 显卡信息（支持多 GPU）
si.graphics().then(data => console.log(data));

// 电池状态（笔记本适用）
si.battery().then(data => console.log(data));

所有方法均返回结构化对象，字段命名清晰，适合需要深度系统洞察的场景。

🛠️ 使用体验：API 设计与错误处理

  • os：同步 API，无异步操作，不会抛出运行时错误（除极端情况），但需自行处理跨平台差异（如 Windows 与 Linux 的路径分隔符）。

  • node-os-utils：统一返回 Promise，失败时 reject。例如磁盘路径不存在时，drive.info() 会 reject 错误。需用 .catch() 或 try/catch 处理。

// node-os-utils 错误处理
osu.drive.info('/nonexistent')
  .catch(err => console.error('磁盘查询失败:', err.message));
  • systeminformation：同样基于 Promise，但对无效调用更宽容（如在台式机上调用 battery() 返回空对象而非报错）。文档详尽，每个方法都有明确的返回结构说明。

🌍 跨平台支持：Windows/macOS/Linux 表现如何？

  • os：由 Node.js 官方维护，三端行为一致，是最可靠的跨平台基础。

  • node-os-utils：依赖 shell 命令，在 Windows 上通过 PowerShell 或 WMI 实现，但某些指标（如网络使用率）在 Windows 支持较弱或精度较低。

  • systeminformation：专为跨平台设计，针对各系统使用最优原生接口（如 Windows 的 WMI、Linux 的 /proc、macOS 的 system_profiler），数据一致性高，是 Electron 等跨平台桌面应用的首选。

📦 何时该用哪个？真实场景建议

场景 1：Electron 桌面应用的状态栏监控

需要显示 CPU、内存、磁盘实时使用率，但不关心硬件型号。

  • ✅ 推荐 node-os-utils：轻量、API 简单，满足基本监控需求，打包体积小。
// Electron 主进程定期更新资源使用率
setInterval(async () => {
  const cpu = await osu.cpu.usage();
  const mem = await osu.mem.info();
  mainWindow.webContents.send('system-stats', { cpu, mem: mem.usedMemPercentage });
}, 2000);

场景 2：服务器健康检查脚本

需要判断内存是否低于阈值、磁盘是否快满，并发送告警。

  • ✅ 推荐 node-os-utils：直接获取使用率百分比，逻辑清晰。
// 健康检查
const { usedMemPercentage } = await osu.mem.info();
const { availablePercentage } = await osu.drive.info('/');

if (usedMemPercentage > 90) alert('内存告警!');
if (availablePercentage < 10) alert('磁盘空间不足!');

场景 3：构建系统诊断工具（如硬件检测软件）

需要收集用户设备的完整硬件配置，用于远程支持或兼容性分析。

  • ✅ 推荐 systeminformation：唯一能提供 CPU 型号、GPU 制造商、内存频率等细节的库。
// 生成完整系统报告
const report = {
  cpu: await si.cpu(),
  memory: await si.memLayout(), // 内存条详情
  graphics: await si.graphics(),
  os: await si.osInfo(),
  battery: await si.battery()
};
uploadDiagnosticReport(report);

场景 4：简单日志记录（只需平台和架构）

在日志中记录运行环境，如 “Linux x64”。

  • ✅ 推荐内置 os：零依赖，一行代码搞定。
console.log(`运行环境: ${os.platform()} ${os.arch()}`);

📊 总结对比表

能力os (内置)node-os-utilssysteminformation
实时 CPU 使用率❌（需手动计算）✅✅
实时内存/磁盘使用率❌（仅总量/空闲量）✅✅
CPU 型号/频率❌❌✅
GPU 信息❌❌✅
电池/温度/传感器❌❌✅
网络实时流量❌⚠️（Linux/macOS 为主）✅
API 风格同步PromisePromise
跨平台一致性⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐
依赖体积0（内置）小较大

💡 最终建议

  • 能用内置 os 解决的，就别加依赖 —— 它稳定、高效、无维护风险。
  • 需要简单实时监控？选 node-os-utils —— 轻量、专注、够用。
  • 需要深度硬件信息或企业级监控？选 systeminformation —— 功能全面、跨平台可靠。
  • 永远避开 os-utils —— 已弃用，存在兼容性和安全风险。

根据你的项目复杂度和信息粒度需求，选择最匹配的工具，既能避免过度工程，又能确保数据准确可靠。

如何选择: systeminformation vs os vs node-os-utils vs os-utils

  • systeminformation:

    选择 systeminformation 如果你需要全面、细粒度的系统与硬件信息（包括 BIOS 版本、GPU 型号、电池状态、温度传感器、进程树等），并支持 Windows、macOS、Linux 等多平台。它返回结构化 JSON 数据，适合构建专业级系统监控、诊断工具或需要深度硬件集成的应用。

  • os:

    选择内置的 os 模块如果你只需要基础的系统信息（如平台、架构、内存总量、CPU 核心数、网络接口列表），且希望避免任何第三方依赖。它稳定、零开销，但无法获取实时资源使用率（如当前 CPU 占用百分比），需自行计算或结合其他机制实现。

  • node-os-utils:

    选择 node-os-utils 如果你需要一个轻量、Promise 风格的 API 来快速获取 CPU、内存、磁盘和网络使用率，并且项目对依赖体积敏感。它封装了常见 shell 命令（如 top、df），适合中小型监控脚本或桌面应用，但不提供详细的硬件型号或传感器数据。

  • os-utils:

    os-utils 已在 npm 上被标记为 deprecated（弃用），其 GitHub 仓库多年未更新。不应在新项目中使用。建议评估 node-os-utils 或 systeminformation 作为替代方案。

与systeminformation类似的npm包

systeminformation 是一个用于获取系统信息的 Node.js 库。它提供了丰富的 API，可以轻松获取有关操作系统、CPU、内存、网络和其他硬件组件的详细信息。这个库非常适合需要监控系统性能或收集系统信息的应用程序。虽然 systeminformation 提供了强大的功能，但在 Node.js 生态系统中还有其他一些替代库可以实现类似的功能。以下是一些替代方案：

  • node-os-utils 是一个轻量级的 Node.js 库，旨在提供操作系统的基本信息。它可以获取 CPU 使用率、内存使用情况、磁盘空间和网络信息等。node-os-utils 的设计目标是简单易用，适合需要基本系统信息的应用程序。
  • os 是 Node.js 内置的模块，提供了一些基本的操作系统相关的功能。它可以获取系统的主机名、操作系统类型、CPU 信息和内存使用情况等。虽然 os 模块功能有限，但它是一个轻量级的选择，适合不需要额外依赖的简单应用程序。
  • os-utils 是另一个用于获取操作系统信息的库，提供了 CPU 使用率、内存使用情况和系统负载等信息。os-utils 的 API 简单易用，适合需要快速获取系统信息的开发者。

要查看 systeminformation 与其他库的比较，请访问：比较 node-os-utils vs os vs os-utils vs systeminformation。

与node-os-utils类似的npm包

node-os-utils 是一个用于获取操作系统信息的 Node.js 库。它提供了简单的 API 来访问系统的 CPU、内存、磁盘和网络等信息，使开发者能够轻松监控和管理系统资源。虽然 node-os-utils 提供了强大的功能，但在 Node.js 生态系统中还有其他一些库可以作为替代方案。以下是一些替代库：

  • os-locale 是一个用于获取操作系统语言环境的库。它可以帮助开发者获取用户的语言设置，以便在应用程序中提供本地化支持。虽然 os-locale 的功能相对较窄，但在需要处理多语言支持的应用程序中，它是一个非常有用的工具。
  • os-utils 是一个轻量级的 Node.js 库，用于获取操作系统的基本信息。它提供了 CPU 使用率、内存使用情况等基本的系统信息。与 node-os-utils 相比，os-utils 的功能更为简单，适合需要快速获取系统信息的场景。
  • systeminformation 是一个功能强大的 Node.js 库，提供了详细的系统信息，包括 CPU、内存、磁盘、网络、传感器等多种信息。它的功能比 node-os-utils 更加全面，适合需要深入监控和分析系统性能的应用程序。

要查看 node-os-utils 与其他库的比较，请访问：比较 node-os-utils、os-locale、os-utils 和 systeminformation。

与os-utils类似的npm包

os-utils 是一个用于 Node.js 的库，提供了一组简单的工具来获取操作系统的性能指标，如 CPU 使用率、内存使用情况和系统负载等。这个库对于需要监控系统性能或资源使用的应用程序非常有用。虽然 os-utils 提供了基本的系统信息获取功能，但在 Node.js 生态系统中还有其他一些库可以作为替代方案。以下是几个替代库：

  • node-os-utils 是一个功能强大的库，提供了更全面的系统信息获取功能。它可以获取 CPU、内存、磁盘、网络等多种系统性能指标。与 os-utils 相比，node-os-utils 提供了更多的功能和更详细的信息，适合需要深入监控系统状态的应用程序。
  • pidusage 是一个用于获取特定进程 CPU 和内存使用情况的库。它可以帮助开发者监控和分析特定进程的资源使用情况，非常适合需要对单个进程进行性能分析的场景。与 os-utils 和 node-os-utils 相比，pidusage 更加专注于进程级别的监控。
  • systeminformation 是一个功能强大的库，提供了丰富的系统信息，包括 CPU、内存、磁盘、网络、传感器等多种信息。它的功能非常全面，适合需要获取详细系统信息的应用程序。与其他库相比，systeminformation 提供了更广泛的系统数据，适合需要全面监控系统状态的开发者。

要查看 os-utils 与其他库的比较，请访问：比较 node-os-utils vs os-utils vs pidusage vs systeminformation。

systeminformation的README

systeminformation logo

systeminformation

System and OS information library for node.js
Explore Systeminformation docs »

Report bug · Request feature · Changelog

NPM Version NPM Downloads Git Issues Closed Issues no dependencies Sponsoring Caretaker MIT license

The Systeminformation Project

This is amazing. Started as a small project just for myself, it now has > 19,000 lines of code, > 700 versions published, up to 20 mio downloads per month, > 490 mio downloads overall. Top 10 NPM ranking for backend packages. Thank you to all who contributed to this project!

Upcoming Version 6 ⭐️⭐️⭐️

The upcoming version 6 of this package (written completely in TypeScript) will come with a lot of new features and improvements. I also cleaned up the API so there will also be some breaking changes. I will release the first beta soon.

Please support this project ... ☕️

Over the past few years I spent more than 3.000 hours working 💻 😓 ☕️ on this project and invested in hardware to be able to test on different platforms. Currently I am working very hard on the next new version 6.0 completely rewritten in TypeScript and with a lot of new features. Any support is highly appreciated - Buy me a coffee... ☕️

Your contribution make it possible for me to keep working on this project, add new features and support more platforms. Thank you in advance!

Node.js ✅, Bun ✅ and Deno ✅

I tested this library with Node.js, Bun and Deno (V2.x) with no issues. There was only one problem on Denos side in version <= 2.1.4: os.freemem() pollyfill was not correct but this is now fixed with Deno >= 2.1.5.

Attention: This library is supposed to be used as a backend/server-side library and will definitely not work within a browser.

Current Version 5.0

The current Version 5 - this major version release 5.0 - came with new functionality and several improvements and changes (some of them are breaking changes!):

  • added audio: get detailed audio device information
  • added bluetooth: get detailed bluetooth device information
  • added dockerImages, dockerVolumes: get detailed information about docker images and volumes
  • added printer: get information from detected printers
  • added usb: get detailed usb controller and device information
  • added wifi interfaces and connections: extended wifi information
  • better uuid function to get unique hardware and OS UUIDs
  • better/extended cpu info detection
  • better/extended system info detection
  • Apple Silicon M1/M2/M3/M4/M5 support
  • better Raspberry-PI detection
  • systeminformation website updated and extended with full documentation and examples systeminformation.io
  • lot of minor improvements

Breaking Changes in version 5 (compared to version 4.x): you will see several breaking changes for the sake of a more consistent API interface and to be future proof. Read the detailed version 5 changes.

I did a lot of testing on different platforms and machines but of course there might be some issues that I am not aware of. I would be happy if you inform me when you discover any issues. Issues can be opened here.

Quick Start

Lightweight collection of 50+ functions to retrieve detailed hardware, system and OS information.

  • simple to use
  • get detailed information about system, cpu, baseboard, battery, memory, disks/filesystem, network, docker, software, services and processes
  • supports Linux, macOS, partial Windows, FreeBSD, OpenBSD, NetBSD, SunOS and Android support
  • no npm dependencies

Installation

npm install systeminformation --save

or simpler

npm i systeminformation

Give it a try with npx?

You just want to give it a try - right from your command line without installing it? Here is how you can call it with npx:

# get basic system info (System, OS, CPU)
npx systeminformation info

# obtain all static data - may take up to 30 seconds
npx systeminformation

Still need Version 4?

If you need version 4 (for compatibility reasons), you can install version 4 (latest release) like this

npm install systeminformation@4 —save

or simpler

npm install systeminformation@4

Usage

All functions (except version and time) are implemented as asynchronous functions. Here a small example how to use them:

const si = require("systeminformation");

// promises style - new since version 3
si.cpu()
  .then((data) => console.log(data))
  .catch((error) => console.error(error));

News and Changes

Latest Activity

(last 7 major and minor version releases)

  • Version 5.31.0: diskLayout() added smartmontools support (macOS)
  • Version 5.30.0: processes() added user (windows) - needed to be reverted
  • Version 5.29.0: osInfo() added OS code name (windows)
  • Version 5.28.0: cpuTemperature() added suppurt for macos-temperature-sensor (macOS)
  • Version 5.27.0: mem() added reclaimable memory
  • Version 5.26.0: getStatic(), getAll() added usb, audio, bluetooth, printer
  • Version 5.25.0: versions() added homebrew
  • Version 5.24.0: versions() added bun and deno
  • Version 5.23.0: usb() added serial number (linux)
  • Version 5.22.0: wifiConnections() added signal quality
  • Version 5.21.0: graphics() added subVendor (linux)
  • Version 5.20.0: mem() added writeback and dirty (linux)
  • Version 5.19.0: currentLoad() added steal and guest time (linux)
  • Version 5.18.0: fsSize() added optional drive parameter
  • Version 5.17.0: graphics() added positionX, positionY (macOS)
  • Version 5.16.0: fsSize() added rw property
  • Version 5.15.0: blockDevices() added device
  • Version 5.14.0: blockDevices() added raid group member (linux)
  • Version 5.13.0: networkConnections() added process name (macOS)
  • Version 5.12.0: cpu() added performance and efficiency cores
  • Version 5.11.0: networkInterfaces() added default property and default parameter
  • Version 5.10.0: basic android support
  • Version 5.9.0: graphics() added properties (macOS)
  • Version 5.8.0: disksIO() added waitTime, waitPercent (linux)
  • Version 5.7.0: diskLayout() added S.M.A.R.T for Windows (if installed)
  • Version 5.6.0: cpuTemperature() added socket and chipset temp (linux)
  • Version 5.5.0: dockerVolumes() added
  • Version 5.4.0: dockerImages() added
  • Version 5.3.0: osInfo() added remoteSession (win only)
  • Version 5.2.0: wifiInterfaces() and wifiConnections() added
  • Version 5.1.0: memLayout() added ECC flag, bios() added language, features (linux)
  • Version 5.0.0: new version 5 - attention there are some breaking changes. See detailed version 5 changes here.
  • ...

You can find all changes here: detailed changelog

Activity

Alt

Core concept

Node.js comes with some basic OS information, but I always wanted a little more. So I came up to write this little library. This library is still a work in progress. It is supposed to be used as a backend/server-side library (it will definitely not work within a browser). It requires node.js version 4.0 and above.

I was able to test it on several Debian, Raspbian, Ubuntu distributions as well as macOS (Mavericks, Yosemite, El Captain, Sierra, High Sierra, Mojave, Catalina, Big Sur, Monterey, Ventura, Sonoma, Sequoia, Tahoe) and some Windows 7, Windows 8, Windows 10, Windows 11, FreeBSD, OpenBSD, NetBSD and SunOS machines. Not all functions are supported on all operating systems. Have a look at the function reference in the docs to get further details.

If you have comments, suggestions & reports, please feel free to contact me!

I also created a nice little command line tool called mmon (micro-monitor) for Linux and macOS, also available via github and npm

Reference

Function Reference and OS Support

Full function reference with examples can be found at https://systeminformation.io.

1. General

FunctionResult objectLinuxBSDMacWinSunComments
si.version(): stringXXXXXlib version (no callback/promise)
si.time(){...}XXXXX(no callback/promise)
currentXXXXXlocal (server) time
uptimeXXXXXuptime in number of seconds
timezoneXXXXXe.g. GMT+0200
timezoneNameXXXXXe.g. CEST

2. System (HW)

FunctionResult objectLinuxBSDMacWinSunComments
si.system(cb){...}XXXXhardware information
manufacturerXXXXe.g. 'MSI'
modelXXXXmodel/product e.g. 'MS-7823'
versionXXXXversion e.g. '1.0'
serialXXXXserial number
uuidXXXXUUID
skuXXXXSKU number
virtualXXXis virtual machine
virtualHostXXXvirtual host (if virtual)
raspberryXoptional raspberry revision data
si.bios(cb){...}XXXXbios information
vendorXXXXe.g. 'AMI'
versionXXXXversion
releaseDateXXXrelease date
revisionXXXrevision
serialXXserial
si.baseboard(cb){...}XXXXbaseboard information
manufacturerXXXXe.g. 'ASUS'
modelXXXXmodel / product name
versionXXXXversion
serialXXXXserial number
assetTagXXXXasset tag
memMaxXXXmax memory in bytes
memSlotsXXXmemory slots on baseboard
si.chassis(cb){...}XXXXchassis information
manufacturerXXXXe.g. 'MSI'
modelXXXXmodel / product name
typeXXXXmodel / product name
versionXXXXversion
serialXXXXserial number
assetTagXXXXasset tag
skuXSKU number

3. CPU

FunctionResult objectLinuxBSDMacWinSunComments
si.cpu(cb){...}XXXXCPU information
manufacturerXXXXe.g. 'Intel(R)'
brandXXXXe.g. 'Core(TM)2 Duo'
speedXXXXin GHz e.g. '3.40'
speedMinXXXin GHz e.g. '0.80'
speedMaxXXXXin GHz e.g. '3.90'
governorXe.g. 'powersave'
coresXXXX# cores
physicalCoresXXXX# physical cores
efficiencyCoresXX# efficiency cores
performanceCoresXX# performance cores
processorsXXXX# processors
socketXXXsocket type e.g. "LGA1356"
vendorXXXXvendor ID
familyXXXXprocessor family
modelXXXXprocessor model
steppingXXXXprocessor stepping
revisionXXXrevision
voltageXvoltage
flagsXXXXCPU flags
virtualizationXXXXvirtualization supported
cacheXXXXcache in bytes (object)
cache.l1dXXXXL1D (data) size
cache.l1iXXXXL1I (instruction) size
cache.l2XXXXL2 size
cache.l3XXXXL3 size
si.cpuFlags(cb): stringXXXXCPU flags
si.cpuCache(cb){...}XXXXCPU cache sizes
l1dXXXXL1D size
l1iXXXXL1I size
l2XXXXL2 size
l3XXXXL3 size
si.cpuCurrentSpeed(cb){...}XXXXXcurrent CPU speed (in GHz)
avgXXXXXavg CPU speed (all cores)
minXXXXXmin CPU speed (all cores)
maxXXXXXmax CPU speed (all cores)
coresXXXXXCPU speed per core (array)
si.cpuTemperature(cb){...}XXX*XCPU temperature in C (if supported)
mainXXXXmain temperature (avg)
coresXXXXarray of temperatures
maxXXXXmax temperature
socketXarray socket temperatures
chipsetXXchipset temperature

4. Memory

FunctionResult objectLinuxBSDMacWinSunComments
si.mem(cb){...}XXXXXMemory information (in bytes)
totalXXXXXtotal memory in bytes
freeXXXXXnot used in bytes
usedXXXXXused (incl. buffers/cache)
activeXXXXXused actively (excl. buffers/cache)
buffcacheXXXXused by buffers+cache
buffersXused by buffers
cachedXused by cache
slabXused by slab
reclaimableXXreclaimable (SReclaimable)
availableXXXXXpotentially available (total - active)
swaptotalXXXXX
swapusedXXXXX
swapfreeXXXXX
writebackX
dirtyX
si.memLayout(cb)[{...}]XXXXMemory Layout (array)
[0].sizeXXXXsize in bytes
[0].bankXXXmemory bank
[0].typeXXXXmemory type
[0].clockSpeedXXXXclock speed
[0].formFactorXXXform factor
[0].manufacturerXXXXmanufacturer
[0].partNumXXXXpart number
[0].serialNumXXXXserial number
[0].voltageConfiguredXXXvoltage conf.
[0].voltageMinXXXvoltage min
[0].voltageMaxXXXvoltage max

5. Battery

FunctionResult objectLinuxBSDMacWinSunComments
si.battery(cb){...}XXXXbattery information
hasBatteryXXXXindicates presence of battery
cycleCountXXnumbers of recharges
isChargingXXXXindicates if battery is charging
designedCapacityXXXmax capacity of battery (mWh)
maxCapacityXXXmax capacity of battery (mWh)
currentCapacityXXXcurrent capacity of battery (mWh)
capacityUnitXXXcapacity unit (mWh)
voltageXXXcurrent voltage of battery (V)
percentXXXXcharging level in percent
timeRemainingXXminutes left (if discharging)
acConnectedXXXXAC connected
typeXXbattery type
modelXXmodel
manufacturerXXmanufacturer
serialXXbattery serial
  • See known issues if you have a problem with macOS temperature or windows temperature

6. Graphics

FunctionResult objectLinuxBSDMacWinSunComments
si.graphics(cb){...}XXXarrays of graphics controllers and displays
controllers[]XXXgraphics controllers array
...[0].vendorXXXe.g. NVIDIA
...[0].subVendorXe.g. Gigabyte
...[0].vendorIdXvendor ID
...[0].modelXXXgraphics controller model
...[0].deviceIdXdevice ID
...[0].busXXXon which bus (e.g. PCIe)
...[0].vramXXXVRAM size (in MB)
...[0].vramDynamicXXXtrue if dynamically allocated ram
...[0].externalXis external GPU
...[0].coresXApple silicon only
...[0].metalVersionXApple Metal Version
displays[]XXXmonitor/display array
...[0].vendorXmonitor/display vendor
...[0].vendorIdXvendor ID
...[0].deviceNameXe.g. \\.\DISPLAY1
...[0].modelXXXmonitor/display model
...[0].productionYearXproduction year
...[0].serialXserial number
...[0].displayIdXdisplay ID
...[0].mainXXXtrue if main monitor
...[0].builtinXXtrue if built-in monitor
...[0].connectionXXXe.g. DisplayPort or HDMI
...[0].sizeXXXsize in mm horizontal
...[0].sizeYXXsize in mm vertical
...[0].pixelDepthXXXcolor depth in bits
...[0].resolutionXXXXpixel horizontal
...[0].resolutionYXXXpixel vertical
...[0].currentResXXXXcurrent pixel horizontal
...[0].currentResYXXXcurrent pixel vertical
...[0].positionXXXdisplay position X
...[0].positionYXXdisplay position Y
...[0].currentRefreshRateXXXcurrent screen refresh rate

7. Operating System

FunctionResult objectLinuxBSDMacWinSunComments
si.osInfo(cb){...}XXXXXOS information
platformXXXXX'linux', 'darwin', 'Windows', ...
distroXXXXX
releaseXXXXX
codenameXXX
kernelXXXXXkernel release - same as os.release()
archXXXXXsame as os.arch()
hostnameXXXXXsame as os.hostname()
fqdnXXXXXFQDN fully qualified domain name
codepageXXXXOS build version
logofileXXXXXe.g. 'apple', 'debian', 'fedora', ...
serialXXXXOS/Host serial number
buildXXXOS build version
servicepackXservice pack version
uefiXXXXOS started via UEFI
hypervisorXhyper-v enabled? (win only)
remoteSessionXruns in remote session (win only)
si.uuid(cb){...}XXXXXobject of several UUIDs
osXXXXos specific UUID
hardwareXXXXhardware specific UUID
macsXXXXMAC addresses
si.versions(apps, cb){...}XXXXXversion information (kernel, ssl, node, ...)
apps param is optional for detecting
only specific apps/libs
(string, comma separated)
si.shell(cb): stringXXXXstandard shell
si.users(cb)[{...}]XXXXXarray of users online
[0].userXXXXXuser name
[0].ttyXXXXXterminal
[0].dateXXXXXlogin date
[0].timeXXXXXlogin time
[0].ipXXXXip address (remote login)
[0].commandXXXXlast command or shell

8. Current Load, Processes & Services

FunctionResult objectLinuxBSDMacWinSunComments
si.currentLoad(cb){...}XXXXCPU-Load
avgLoadXXXaverage load
currentLoadXXXXCPU load in %
currentLoadUserXXXXCPU load user in %
currentLoadSystemXXXXCPU load system in %
currentLoadNiceXXXXCPU load nice in %
currentLoadIdleXXXXCPU load idle in %
currentLoadIrqXXXXCPU load system in %
rawCurrentLoad...XXXXCPU load raw values (ticks)
cpus[]XXXXcurrent loads per CPU in % + raw ticks
si.fullLoad(cb): integerXXXCPU full load since bootup in %
si.processes(cb){...}XXXXX# running processes
allXXXXX# of all processes
runningXXXX# of all processes running
blockedXXXX# of all processes blocked
sleepingXXXX# of all processes sleeping
unknownX# of all processes unknown status
list[]XXXXXlist of all processes incl. details
...[0].pidXXXXXprocess PID
...[0].parentPidXXXXXparent process PID
...[0].nameXXXXXprocess name
...[0].cpuXXXXXprocess % CPU usage
...[0].cpuuXXXprocess % CPU usage (user)
...[0].cpusXXXprocess % CPU usage (system)
...[0].memXXXXXprocess memory %
...[0].priorityXXXXXprocess priority
...[0].memVszXXXXXprocess virtual memory size
...[0].memRssXXXXXprocess mem resident set size
...[0].niceXXXXprocess nice value
...[0].startedXXXXXprocess start time
...[0].stateXXXXXprocess state (e.g. sleeping)
...[0].ttyXXXXtty from which process was started
...[0].userXXXXuser who started process
...[0].commandXXXXXprocess starting command
...[0].paramsXXXXprocess params
...[0].pathXXXXXprocess path
procXXXXprocess name
pidXXXXPID
pidsXXXXadditional pids
cpuXXXXprocess % CPU
memXXXXprocess % MEM
si.services('mysql, apache2', cb)[{...}]XXXXpass comma separated string of services
pass "*" for ALL services (linux/win only)
[0].nameXXXXname of service
[0].runningXXXXtrue / false
[0].startmodeXmanual, automatic, ...
[0].pidsXXXXpids
[0].cpuXXXprocess % CPU
[0].memXXXprocess % MEM
si.processLoad('mysql, apache2', cb)[{...}]XXXXpass comma separated string of processes
pass "*" for ALL processes (linux/win only)
[0].procXXXXname of process
[0].pidsXXXXpids
[0].cpuXXXprocess % CPU
[0].memXXXprocess % MEM

9. File System

FunctionResult objectLinuxBSDMacWinSunComments
si.diskLayout(cb)[{...}]XXXphysical disk layout (array)
[0].deviceXXe.g. /dev/sda
[0].typeXXXHD, SSD, NVMe
[0].nameXXXdisk name
[0].vendorXXvendor/producer
[0].sizeXXXsize in bytes
[0].bytesPerSectorXbytes per sector
[0].totalCylindersXtotal cylinders
[0].totalHeadsXtotal heads
[0].totalSectorsXtotal sectors
[0].totalTracksXtotal tracks
[0].tracksPerCylinderXtracks per cylinder
[0].sectorsPerTrackXsectors per track
[0].firmwareRevisionXXXfirmware revision
[0].serialNumXXXserial number
[0].interfaceTypeXXXSATA, PCIe, ...
[0].smartStatusXXXS.M.A.R.T Status (see Known Issues)
[0].temperatureXXXS.M.A.R.T temperature
[0].smartDataXXXfull S.M.A.R.T data from smartctl
requires at least smartmontools 7.0
si.blockDevices(cb)[{...}]XXXreturns array of disks, partitions,
raids and roms
[0].nameXXXname
[0].typeXXXtype
[0].fstypeXXXfile system type (e.g. ext4)
[0].mountXXXmount point
[0].sizeXXXsize in bytes
[0].physicalXXXphysical type (HDD, SSD, CD/DVD)
[0].uuidXXXUUID
[0].labelXXXlabel
[0].modelXXmodel
[0].serialXXserial
[0].removableXXXserial
[0].protocolXXprotocol (SATA, PCI-Express, ...)
[0].groupXRaid group member (e.g. md1)
[0].deviceXXXphysical device mapped to (e.g. /dev/sda)
si.disksIO(cb){...}XXcurrent transfer stats
rIOXXread IOs on all mounted drives
wIOXXwrite IOs on all mounted drives
tIOXXwrite IOs on all mounted drives
rIO_secXXread IO per sec (* see notes)
wIO_secXXwrite IO per sec (* see notes)
tIO_secXXtotal IO per sec (* see notes)
rWaitTimeXread IO request time (* see notes)
wWaitTimeXwrite IO request time (* see notes)
tWaitTimeXtotal IO request time (* see notes)
rWaitPercentXread IO request time percent (* see notes)
wWaitPercentXwrite IO request time percent (* see notes)
tWaitPercentXtotal IO request time percent (* see notes)
msXXinterval length (for per second values)
si.fsSize(drive, cb)[{...}]XXXXreturns array of mounted file systems
drive param is optional
[0].fsXXXXname of file system
[0].typeXXXXtype of file system
[0].sizeXXXXsizes in bytes
[0].usedXXXXused in bytes
[0].availableXXXXused in bytes
[0].useXXXXused in %
[0].mountXXXXmount point
[0].rwXXXXread and write (false if read only)
si.fsOpenFiles(cb){...}XXXcount max/allocated file descriptors
maxXXXmax file descriptors
allocatedXXXcurrent open files count
availableXXXcount available
si.fsStats(cb){...}XXcurrent transfer stats
rxXXbytes read since startup
wxXXbytes written since startup
txXXtotal bytes read + written since startup
rx_secXXbytes read / second (* see notes)
wx_secXXbytes written / second (* see notes)
tx_secXXtotal bytes reads + written / second
msXXinterval length (for per second values)

10. USB

FunctionResult objectLinuxBSDMacWinSunComments
si.usb(cb)[{...}]XXXXget detected USB devices
[0].busXUSB bus
[0].deviceIdXbus device id
[0].idXXXinternal id
[0].nameXXXname
[0].typeXXXname
[0].removableXis removable
[0].vendorXXvendor
[0].manufacturerXXXmanufacturer
[0].maxPowerXmax power
[0].defaultXXXis default printer
[0].serialNumberXXserial number

11. Printer

FunctionResult objectLinuxBSDMacWinSunComments
si.printer(cb)[{...}]XXXXget printer information
[0].idXXXinternal id
[0].nameXXXname
[0].modelXXXmodel
[0].uriXXprinter URI
[0].uuidXprinter UUID
[0].statusXXXprinter status (e.g. idle)
[0].localXXXis local printer
[0].defaultXXis default printer
[0].sharedXXXis shared printer

12. Audio

FunctionResult objectLinuxBSDMacWinSunComments
si.audio(cb)[{...}]XXXXget printer information
[0].idXXXinternal id
[0].nameXXXname
[0].manufacturerXXXmanufacturer
[0].revisionXrevision
[0].driverXdriver
[0].defaultXXis default
[0].channelXXchannel e.g. USB, HDMI, ...
[0].typeXXXtype e.g. Speaker
[0].inXXis input channel
[0].outXXis output channel
[0].interfaceTypeXXXinterface type (PCIe, USB, HDMI, ...)
[0].statusXXXprinter status (e.g. idle)

13. Network related functions

FunctionResult objectLinuxBSDMacWinSunComments
si.networkInterfaces(cb)[{...}]XXXXXarray of network interfaces
With the 'default' parameter it returns
only the default interface
[0].ifaceXXXXXinterface
[0].ifaceNameXXXXXinterface name (differs on Windows)
[0].defaultXXXXXtrue if this is the default interface
[0].ip4XXXXXip4 address
[0].ip4subnetXXXXXip4 subnet mask
[0].ip6XXXXXip6 address
[0].ip6subnetXXXXXip6 subnet mask
[0].macXXXXXMAC address
[0].internalXXXXXtrue if internal interface
[0].virtualXXXXXtrue if virtual interface
[0].operstateXXXup / down
[0].typeXXXwireless / wired
[0].duplexXXduplex
[0].mtuXXmaximum transmission unit
[0].speedXXXspeed in MBit / s
[0].dhcpXXXIP address obtained by DHCP
[0].dnsSuffixXXDNS suffix
[0].ieee8021xAuthXXIEEE 802.1x auth
[0].ieee8021xStateXXIEEE 802.1x state
[0].carrierChangesX# changes up/down
si.networkInterfaceDefault(cb): stringXXXXXget name of default network interface
si.networkGatewayDefault(cb): stringXXXXXget default network gateway
si.networkStats(ifaces,cb)[{...}]XXXXcurrent network stats of given interfaces
iface list: space or comma separated
iface parameter is optional
defaults to first external network interface,
Pass '*' for all interfaces
[0].ifaceXXXXinterface
[0].operstateXXXXup / down
[0].rx_bytesXXXXreceived bytes overall
[0].rx_droppedXXXXreceived dropped overall
[0].rx_errorsXXXXreceived errors overall
[0].tx_bytesXXXXtransferred bytes overall
[0].tx_droppedXXXXtransferred dropped overall
[0].tx_errorsXXXXtransferred errors overall
[0].rx_secXXXXreceived bytes / second (* see notes)
[0].tx_secXXXXtransferred bytes per second (* see notes)
[0].msXXXXinterval length (for per second values)
si.networkConnections(cb)[{...}]XXXXcurrent network network connections
returns an array of all connections
[0].protocolXXXXtcp or udp
[0].localAddressXXXXlocal address
[0].localPortXXXXlocal port
[0].peerAddressXXXXpeer address
[0].peerPortXXXXpeer port
[0].stateXXXXlike ESTABLISHED, TIME_WAIT, ...
[0].pidXXXXprocess ID
[0].processXXXprocess name
si.inetChecksite(url, cb){...}XXXXXresponse-time (ms) to fetch given URL
urlXXXXXgiven url
okXXXXXstatus code OK (2xx, 3xx)
statusXXXXXstatus code
msXXXXXresponse time in ms
si.inetLatency(host, cb): numberXXXXXresponse-time (ms) to external resource
host parameter is optional (default 8.8.8.8)

14. Wifi

FunctionResult objectLinuxBSDMacWinSunComments
si.wifiNetworks(cb)[{...}]XXXarray of available wifi networks
[0].ssidXXXWifi network SSID
[0].bssidXXXBSSID (mac)
[0].modeXmode
[0].channelXXXchannel
[0].frequencyXXXfrequency in MHz
[0].signalLevelXXXsignal level in dB
[0].qualityXXXquality in %
[0].securityXXXarray e.g. WPA, WPA-2
[0].wpaFlagsXXXarray of WPA flags
[0].rsnFlagsXarray of RDN flags
si.wifiInterfaces(cb)[{...}]XXXarray of detected wifi interfaces
[0].idXXXID
[0].ifaceXXXinterface
[0].modelXXXmodel
[0].vendorXXXvendor
[0].macXXXMAC address
si.wifiConnections(cb)[{...}]XXXarray of active wifi connections
[0].idXXXID
[0].ifaceXXXinterface
[0].modelXXXmodel
[0].ssidXXXSSID
[0].bssidX(X)XBSSID (mac) - macOS only on older os versions
[0].channelXXXchannel
[0].frequencyXXXfrequency in MHz
[0].typeXXXe.g. 802.11
[0].securityXXXarray e.g. WPA, WPA-2
[0].signalLevelXXXsignal level in dB
[0].qualityXXXquality in %
[0].txRateXXXtransfer rate MBit/s

15. Bluetooth

FunctionResult objectLinuxBSDMacWinSunComments
si.bluetoothDevices(cb)[{...}]XXX...
[0].deviceXdevice name
[0].nameXXXname
[0].macDeviceXXMAC address device
[0].macHostXXMAC address host
[0].batteryPercentXbattery level percent
[0].manufacturerXXmanufacturer
[0].typeXXXtype of bluetooth device
[0].connectedXXis connected

16. Docker

FunctionResult objectLinuxBSDMacWinSunComments
si.dockerInfo(cb){...}XXXXXreturns general docker info
idXXXXXDocker ID
containersXXXXXnumber of containers
containersRunningXXXXXnumber of running containers
containersPausedXXXXXnumber of paused containers
containersStoppedXXXXXnumber of stopped containers
imagesXXXXXnumber of images
driverXXXXXdriver (e.g. 'devicemapper', 'overlay2')
memoryLimitXXXXXhas memory limit
swapLimitXXXXXhas swap limit
kernelMemoryXXXXXhas kernel memory
cpuCfsPeriodXXXXXhas CpuCfsPeriod
cpuCfsQuotaXXXXXhas CpuCfsQuota
cpuSharesXXXXXhas CPUShares
cpuSetXXXXXhas CPUShares
ipv4ForwardingXXXXXhas IPv4Forwarding
bridgeNfIptablesXXXXXhas BridgeNfIptables
bridgeNfIp6tablesXXXXXhas BridgeNfIp6tables
debugXXXXXDebug on
nfdXXXXXnamed data networking forwarding daemon
oomKillDisableXXXXXout-of-memory kill disabled
ngoroutinesXXXXXnumber NGoroutines
systemTimeXXXXXdocker SystemTime
loggingDriverXXXXXlogging driver e.g. 'json-file'
cgroupDriverXXXXXcgroup driver e.g. 'cgroupfs'
nEventsListenerXXXXXnumber NEventsListeners
kernelVersionXXXXXdocker kernel version
operatingSystemXXXXXdocker OS e.g. 'Docker for Mac'
osTypeXXXXXOSType e.g. 'linux'
architectureXXXXXarchitecture e.g. x86_64
ncpuXXXXXnumber of CPUs
memTotalXXXXXmemory total
dockerRootDirXXXXXdocker root directory
httpProxyXXXXXhttp proxy
httpsProxyXXXXXhttps proxy
noProxyXXXXXNoProxy
nameXXXXXName
labelsXXXXXarray of labels
experimentalBuildXXXXXis experimental build
serverVersionXXXXXserver version
clusterStoreXXXXXcluster store
clusterAdvertiseXXXXXcluster advertise
defaultRuntimeXXXXXdefault runtime e.g. 'runc'
liveRestoreEnabledXXXXXlive store enabled
isolationXXXXXisolation
initBinaryXXXXXinit binary
productLicenseXXXXXproduct license
si.dockerImages(all, cb)[{...}]XXXXXreturns array of top level/all docker images
[0].idXXXXXimage ID
[0].containerXXXXXcontainer ID
[0].commentXXXXXcomment
[0].osXXXXXOS
[0].architectureXXXXXarchitecture
[0].parentXXXXXparent ID
[0].dockerVersionXXXXXdocker version
[0].sizeXXXXXimage size
[0].sharedSizeXXXXXshared size
[0].virtualSizeXXXXXvirtual size
[0].authorXXXXXauthor
[0].createdXXXXXcreated date / time
[0].containerConfigXXXXXcontainer config object
[0].graphDriverXXXXXgraph driver object
[0].repoDigestsXXXXXrepo digests array
[0].repoTagsXXXXXrepo tags array
[0].configXXXXXconfig object
[0].rootFSXXXXXroot fs object
si.dockerContainers(all, cb)[{...}]XXXXXreturns array of active/all docker containers
[0].idXXXXXID of container
[0].nameXXXXXname of container
[0].imageXXXXXname of image
[0].imageIDXXXXXID of image
[0].commandXXXXXcommand
[0].createdXXXXXcreation time (unix)
[0].startedXXXXXcreation time (unix)
[0].finishedXXXXXcreation time (unix)
[0].createdAtXXXXXcreation date time string
[0].startedAtXXXXXcreation date time string
[0].finishedAtXXXXXcreation date time string
[0].stateXXXXXcreated, running, exited
[0].portsXXXXXarray of ports
[0].mountsXXXXXarray of mounts
si.dockerContainerStats(ids, cb)[{...}]XXXXXstatistics for specific containers
container IDs: space or comma separated,
pass '*' for all containers
[0].idXXXXXContainer ID
[0].memUsageXXXXXmemory usage in bytes
[0].memLimitXXXXXmemory limit (max mem) in bytes
[0].memPercentXXXXXmemory usage in percent
[0].cpuPercentXXXXXcpu usage in percent
[0].pidsXXXXXnumber of processes
[0].netIO.rxXXXXXreceived bytes via network
[0].netIO.wxXXXXXsent bytes via network
[0].blockIO.rXXXXXbytes read from BlockIO
[0].blockIO.wXXXXXbytes written to BlockIO
[0].cpuStatsXXXXXdetailed cpu stats
[0].percpuStatsXXXXXdetailed per cpu stats
[0].memoryStatsXXXXXdetailed memory stats
[0].networksXXXXXdetailed network stats per interface
si.dockerContainerProcesses(id, cb)[{...}]XXXXXarray of processes inside a container
[0].pidHostXXXXXprocess ID (host)
[0].ppidXXXXXparent process ID
[0].pgidXXXXXprocess group ID
[0].userXXXXXeffective user name
[0].ruserXXXXXreal user name
[0].groupXXXXXeffective group name
[0].rgroupXXXXXreal group name
[0].statXXXXXprocess state
[0].timeXXXXXaccumulated CPU time
[0].elapsedXXXXXelapsed running time
[0].niceXXXXXnice value
[0].rssXXXXXresident set size
[0].vszXXXXXvirtual size in Kbytes
[0].commandXXXXXcommand and arguments
si.dockerVolumes(cb)[{...}]returns array of all docker volumes
[0].nameXXXXXvolume name
[0].driverXXXXXdriver
[0].labelsXXXXXlabels object
[0].mountpointXXXXXmountpoint
[0].optionsXXXXXoptions
[0].scopeXXXXXscope
[0].createdXXXXXcreated at
si.dockerAll(cb){...}XXXXXlist of all containers including their stats
and processes in one single array

17. Virtual Box

FunctionResult objectLinuxBSDMacWinSunComments
si.vboxInfo(cb)[{...}]XXXXXreturns array general virtual box info
[0].idXXXXXvirtual box ID
[0].nameXXXXXname
[0].runningXXXXXvbox is running
[0].startedXXXXXstarted date time
[0].runningSinceXXXXXrunning since (secs)
[0].stoppedXXXXXstopped date time
[0].stoppedSinceXXXXXstopped since (secs)
[0].guestOSXXXXXGuest OS
[0].hardwareUUIDXXXXXHardware UUID
[0].memoryXXXXXMemory in MB
[0].vramXXXXXVRAM in MB
[0].cpusXXXXXCPUs
[0].cpuExepCapXXXXXCPU exec cap
[0].cpuProfileXXXXXCPU profile
[0].chipsetXXXXXchipset
[0].firmwareXXXXXfirmware
[0].pageFusionXXXXXpage fusion
[0].configFileXXXXXconfig file
[0].snapshotFolderXXXXXsnapshot folder
[0].logFolderXXXXXlog folder path
[0].hpetXXXXXHPET
[0].paeXXXXXPAE
[0].longModeXXXXXlong mode
[0].tripleFaultResetXXXXXtriple fault reset
[0].apicXXXXXAPIC
[0].x2ApicXXXXXX2APIC
[0].acpiXXXXXACPI
[0].ioApicXXXXXIOAPIC
[0].biosApicModeXXXXXBIOS APIC mode
[0].bootMenuModeXXXXXboot menu Mode
[0].bootDevice1XXXXXbootDevice1
[0].bootDevice2XXXXXbootDevice2
[0].bootDevice3XXXXXbootDevice3
[0].bootDevice4XXXXXbootDevice4
[0].timeOffsetXXXXXtime Offset
[0].rtcXXXXXRTC

16. "Get All / Observe" - functions

FunctionResult objectLinuxBSDMacWinSunComments
si.getStaticData(cb){...}XXXXXall static data at once
si.getDynamicData(srv,iface,cb){...}XXXXXall dynamic data at once
Specify services and interfaces to monitor
Defaults to first external network interface
Pass "" for ALL services (linux/win only)
Pass "" for ALL network interfaces
si.getAllData(srv,iface,cb){...}XXXXXall data at once
Specify services and interfaces to monitor
Defaults to first external network interface
Pass "" for ALL services (linux/win only)
Pass "" for ALL network interfaces
si.get(valueObject,cb){...}XXXXXget partial system info data at once
In valueObject you can define
all values, you want to get back
(see documentation for details)
si.observe(valueObject,interval,cb)-XXXXXObserve a defined value object
call callback on changes
polling interval in milliseconds

cb: Asynchronous Function Calls (callback)

Remember: all functions (except version and time) are implemented as asynchronous functions! There are now three ways to consume them:

Callback Style

const si = require("systeminformation");

si.cpu(function (data) {
  console.log("CPU Information:");
  console.log("- manufacturer: " + data.manufacturer);
  console.log("- brand: " + data.brand);
  console.log("- speed: " + data.speed);
  console.log("- cores: " + data.cores);
  console.log("- physical cores: " + data.physicalCores);
  console.log("...");
});

Promises

Promises Style is new in version 3.0.

When omitting callback parameter (cb), then you can use all function in a promise oriented way. All functions (except of version and time) are returning a promise, that you can consume:

const si = require("systeminformation");

si.cpu()
  .then((data) => {
    console.log("CPU Information:");
    console.log("- manufacturer: " + data.manufacturer);
    console.log("- brand: " + data.brand);
    console.log("- speed: " + data.speed);
    console.log("- cores: " + data.cores);
    console.log("- physical cores: " + data.physicalCores);
    console.log("...");
  })
  .catch((error) => console.error(error));

Async / Await

Using async / await (available since node v7.6)

Since node v7.6 you can also use the async / await pattern. The above example would then look like this:

const si = require("systeminformation");

async function cpuData() {
  try {
    const data = await si.cpu();
    console.log("CPU Information:");
    console.log("- manufacturer: " + data.manufacturer);
    console.log("- brand: " + data.brand);
    console.log("- speed: " + data.speed);
    console.log("- cores: " + data.cores);
    console.log("- physical cores: " + data.physicalCores);
    console.log("...");
  } catch (e) {
    console.log(e);
  }
}

Known Issues

macOS - Temperature Sensor

To be able to measure temperature on macOS I created two little additional packages. Due to some difficulties in NPM with optionalDependencies I unfortunately was getting unexpected warnings on other platforms. So I decided to drop this optional dependency for macOS - so by default, you will not get correct values.

But if you need to detect macOS temperature just run the following additional installation command:

For Intel based machines (deprecated lib) install

$ npm install osx-temperature-sensor --save

For Apple Silicon (ARM) based machines install

$ npm install macos-temperature-sensor --save

systeminformation will then detect this additional library and return the temperature when calling systeminformations standard function cpuTemperature()

Windows Temperature, Battery, ...

get-WmiObject - which is used to determine temperature and battery sometimes needs to be run with admin privileges. So if you do not get any values, try to run it again with according privileges. If you still do not get any values, your system might not support this feature. In some cases we also discovered that get-WmiObject returned incorrect temperature values.

Linux Temperature

In some cases you need to install the Linux sensors package to be able to measure temperature e.g. on DEBIAN based systems by running sudo apt-get install lm-sensors

Linux S.M.A.R.T. Status

To be able to detect S.M.A.R.T. status on Linux you need to install smartmontools. On DEBIAN based Linux distributions you can install it by running sudo apt-get install smartmontools

Windows Encoding Issues

I now reimplemented all windows functions to avoid encoding problems (special chacarters). And as Windows 11 now dropped wmic support, I had to move completely to powershell. Be sure that powershell version 5+ is installed on your machine. On older Windows versions (7, 8) you might still see encoding problems due to the old powershell version.

*: Additional Notes

In fsStats(), disksIO() and networkStats() the results / sec. values (rx_sec, IOPS, ...) are calculated correctly beginning with the second call of the function. It is determined by calculating the difference of transferred bytes / IOs divided by the time between two calls of the function.

The first time you are calling one of these functions, you will get null for transfer rates. The second time, you should then get statistics based on the time between the two calls ...

So basically, if you e.g. need a value for network stats every second, your code should look like this:

const si = require("systeminformation");

setInterval(function () {
  si.networkStats().then((data) => {
    console.log(data);
  });
}, 1000);

Beginning with the second call, you get network transfer values per second.

Finding new issues

I am happy to discuss any comments and suggestions. Please feel free to contact me if you see any possibility of improvement!

Comments

If you have ideas or comments, please do not hesitate to contact me.

Happy monitoring!

Sincerely,

Sebastian Hildebrandt, +innovations

Credits

Written by Sebastian Hildebrandt sebhildebrandt

Contributors

OSX Temperature: credits here are going to:

Powered by

Alt Text       Alt Text

Copyright Information

Linux is a registered trademark of Linus Torvalds. Apple, macOS, OS X are registered trademarks of Apple Inc., Windows is a registered trademark of Microsoft Corporation. Node.js is a trademark of OpenJS Foundation, Intel is a trademark of Intel Corporation, AMD is a trademark of Advanced Micro Devices Inc., Raspberry Pi is a trademark of the Raspberry Pi Foundation, Debian is a trademark owned by Software in the Public Interest, Inc., Ubuntu is a trademark of Canonical Ltd., FreeBSD is a registered trademark of The FreeBSD Foundation, NetBSD is a registered trademark of The NetBSD Foundation, Docker is a trademark of Docker, Inc., Sun, Solaris, OpenSolaris and registered trademarks of Sun Microsystems, VMware is a trademark of VMware Inc, Virtual Box is a trademark of Oracle Corporation, Xen is a registered trademark of Xen Project, QEMU is a trademark of Fabrice Bellard, bochs is a trademark of The Bochs Project, USB and USB Logo are trademarks of USB Implementation Forum, Bluetooth and Bluetooth Logo are trademarks of Bluetooth SIG, Android is a trademark of Google LLC, Parallels is a trademarks of Parallels International GmbH. Bun is a trademark of Codeblog Corp. Deno is a trademark of Deno Land Inc. Arm is a trademark of Arm Limited.

All other trademarks are the property of their respective owners.

License MIT license

The MIT License (MIT)

Copyright © 2014-2026 Sebastian Hildebrandt, +innovations.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Further details see LICENSE file.

npm-compare.com is an independent website designed to help developers choose the most suitable npm packages. We are not affiliated with npm, Inc, the official website for the npm registry. Note that npm is a registered trademark of npm, Inc. Please share your feedback via our GitHub repository. For more details, please refer to our Terms & Privacy.