![\"systeminformation](\"https://systeminformation.io/assets/logo_inv.png\"){kind=logo}
\n \n\n \n \n \n
\n System and OS information library for node.js\n
\n Explore Systeminformation docs »\n
\n
\n Report bug\n ·\n Request feature\n ·\n Changelog\n
![\"no](\"docs/assets/no-dependencies.svg\")
\n[![Sponsoring][sponsor-badge]][sponsor-url]\n[![Caretaker][caretaker-image]][caretaker-url]\n[![MIT license][license-img]][license-url]\n\n## The Systeminformation Project\n\nThis is amazing. Started as a small project just for myself, it now has > 17,000\nlines of code, > 650 versions published, up to 8 mio downloads per month, > 330\nmio downloads overall. #1 NPM ranking for backend packages. Thank you to all who\ncontributed to this project!\n\n> **Upcoming Version 6**\n>\n> With a lot of new features, improvements and a cleaned up API where will also\n> be some breaking changes. We will release the first beta soon.\n\n## Please support this project ... ☕️\n\nOver the past few years I spent **more than 3.000 hours** working on this\nproject and invested in hardware to be able to test on different platforms.\nCurrently I am working very hard on the next **new version 6.0** completely\nrewritten in TypeScript and with a lot of new features. Any support is highly\nappreciated - [Buy me a coffee](https://www.buymeacoffee.com/systeminfo).\n\n**Your contribution** make it possible for me to keep working on this project,\nadd new features and support more platforms. Thank you in advance!\n\n## Node.js ✅, Bun ✅ and Deno ✅\n\nI tested this library with Node.js, Bun and Deno (V2.x) with no issues. There\nwas only one problem on Denos side in version <= 2.1.4: os.freemem() pollyfill\nwas not correct but this is now fixed with Deno >= 2.1.5.\n\n**Attention**: This library is supposed to be used as a backend/server-side\nlibrary and **will definitely not work within a browser**.\n\n## New Version 5.0\n\nThe new Version 5 is here - this next major version release 5.0 comes with new\nfunctionality and several improvements and changes (some of them are breaking\nchanges!):\n\n- added audio: get detailed audio device information\n- added bluetooth: get detailed bluetooth device information\n- added dockerImages, dockerVolumes: get detailed information about docker\n images and volumes\n- added printer: get information from detected printers\n- added usb: get detailed usb controller and device information\n- added wifi interfaces and connections: extended wifi information\n- better uuid function to get unique hardware and OS UUIDs\n- better/extended cpu info detection\n- better/extended system info detection\n- Apple Silicon M1/M2/M3 support\n- better Raspberry-PI detection\n- systeminformation website updated and extended with full documentation and\n examples [systeminformation.io][systeminformation-url]\n- lot of minor improvements\n\nBreaking Changes in version 5: you will see several breaking changes for the\nsake of a more consistent API interface and to be future proof. Read the\n[detailed version 5 changes][changes5-url].\n\nI did a lot of testing on different platforms and machines but of course there\nmight be some issues that I am not aware of. I would be happy if you inform me\nwhen you discover any issues. Issues can be [opened here][new-issue].\n\n## Quick Start\n\nLightweight collection of 50+ functions to retrieve detailed hardware, system\nand OS information.\n\n- simple to use\n- get detailed information about system, cpu, baseboard, battery, memory,\n disks/filesystem, network, docker, software, services and processes\n- supports Linux, macOS, partial Windows, FreeBSD, OpenBSD, NetBSD, SunOS and\n Android support\n- no npm dependencies\n\n### Installation\n\n```bash\nnpm install systeminformation --save\n```\n\nor simpler\n\n```bash\nnpm i systeminformation\n```\n\n### Give it a try with `npx`?\n\nYou just want to give it a try - right from your command line without installing\nit? Here is how you can call it with `npx`:\n\n```\n# get basic system info (System, OS, CPU)\nnpx systeminformation info\n\n# obtain all static data - may take up to 30 seconds\nnpx systeminformation\n```\n\n#### Still need Version 4?\n\nIf you need version 4 (for compatibility reasons), you can install version 4\n(latest release) like this\n\n```bash\nnpm install systeminformation@4 —save\n```\n\nor simpler\n\n```bash\nnpm install systeminformation@4\n```\n\n### Usage\n\nAll functions (except `version` and `time`) are implemented as asynchronous\nfunctions. Here a small example how to use them:\n\n```js\nconst si = require(\"systeminformation\");\n\n// promises style - new since version 3\nsi.cpu()\n .then((data) => console.log(data))\n .catch((error) => console.error(error));\n```\n\n## News and Changes\n\n### Latest Activity\n\n(last 7 major and minor version releases)\n\n- Version 5.25.0: `versions()` added homebrew\n- Version 5.24.0: `versions()` added bun and deno\n- Version 5.23.0: `usb()` added serial number (linux)\n- Version 5.22.0: `wifiConnections()` added signal quality\n- Version 5.21.0: `graphics()` added subVendor (linux)\n- Version 5.20.0: `mem()` added writeback and dirty (linux)\n- Version 5.19.0: `currentLoad()` added steal and guest time (linux)\n- Version 5.18.0: `fsSize()` added optional drive parameter\n- Version 5.17.0: `graphics()` added positionX, positionY (macOS)\n- Version 5.16.0: `fsSize()` added rw property\n- Version 5.15.0: `blockDevices()` added device\n- Version 5.14.0: `blockDevices()` added raid group member (linux)\n- Version 5.13.0: `networkConnections()` added process name (macOS)\n- Version 5.12.0: `cpu()` added performance and efficiency cores\n- Version 5.11.0: `networkInterfaces()` added default property and default\n parameter\n- Version 5.10.0: basic `android` support\n- Version 5.9.0: `graphics()` added properties (macOS)\n- Version 5.8.0: `disksIO()` added waitTime, waitPercent (linux)\n- Version 5.7.0: `diskLayout()` added S.M.A.R.T for Windows (if installed)\n- Version 5.6.0: `cpuTemperature()` added socket and chipset temp (linux)\n- Version 5.5.0: `dockerVolumes()` added\n- Version 5.4.0: `dockerImages()` added\n- Version 5.3.0: `osInfo()` added remoteSession (win only)\n- Version 5.2.0: `wifiInterfaces()` and `wifiConnections()` added\n- Version 5.1.0: `memLayout()` added ECC flag, `bios()` added language, features\n (linux)\n- Version 5.0.0: new version 5 - attention there are some breaking changes. See\n [detailed version 5 changes here][changes5-url].\n- ...\n\nYou can find all changes here: [detailed changelog][changelog-url]\n\n## Core concept\n\n[Node.js][nodejs-url] comes with some basic OS information, but I always wanted\na little more. So I came up to write this little library. This library is still\na work in progress. It is supposed to be used as a backend/server-side library\n(it will definitely not work within a browser). It requires node.js version 4.0\nand above.\n\nI was able to test it on several Debian, Raspbian, Ubuntu distributions as well\nas macOS (Mavericks, Yosemite, El Captain, Sierra, High Sierra, Mojave,\nCatalina, Big Sur) and some Windows 7, Windows 8, Windows 10, FreeBSD, OpenBSD,\nNetBSD and SunOS machines. Not all functions are supported on all operating\nsystems. Have a look at the function reference in the docs to get further\ndetails.\n\nIf you have comments, suggestions & reports, please feel free to contact me!\n\nI also created a nice little command line tool called [mmon][mmon-github-url]\n(micro-monitor) for Linux and macOS, also available via\n[github][mmon-github-url] and [npm][mmon-npm-url]\n\n## Reference\n\n### Function Reference and OS Support\n\nFull function reference with examples can be found at\n[https://systeminformation.io][systeminformation-url].\n\n#### 1. General\n\n| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |\n| ------------ | ------------- | ----- | --- | --- | --- | --- | --------------------------------- |\n| si.version() | : string | X | X | X | X | X | lib version (no callback/promise) |\n| si.time() | {...} | X | X | X | X | X | (no callback/promise) |\n| | current | X | X | X | X | X | local (server) time |\n| | uptime | X | X | X | X | X | uptime in number of seconds |\n| | timezone | X | X | X | X | X | e.g. GMT+0200 |\n| | timezoneName | X | X | X | X | X | e.g. CEST |\n\n#### 2. System (HW)\n\n| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |\n| ---------------- | ------------- | ----- | --- | --- | --- | --- | -------------------------------- |\n| si.system(cb) | {...} | X | X | X | X | | hardware information |\n| | manufacturer | X | X | X | X | | e.g. 'MSI' |\n| | model | X | X | X | X | | model/product e.g. 'MS-7823' |\n| | version | X | X | X | X | | version e.g. '1.0' |\n| | serial | X | X | X | X | | serial number |\n| | uuid | X | X | X | X | | UUID |\n| | sku | X | X | X | X | | SKU number |\n| | virtual | X | X | | X | | is virtual machine |\n| | virtualHost | X | X | | X | | virtual host (if virtual) |\n| | raspberry | X | | | | | optional raspberry revision data |\n| si.bios(cb) | {...} | X | X | X | X | | bios information |\n| | vendor | X | X | X | X | | e.g. 'AMI' |\n| | version | X | X | X | X | | version |\n| | releaseDate | X | X | | X | | release date |\n| | revision | X | X | | X | | revision |\n| | serial | X | | | X | | serial |\n| si.baseboard(cb) | {...} | X | X | X | X | | baseboard information |\n| | manufacturer | X | X | X | X | | e.g. 'ASUS' |\n| | model | X | X | X | X | | model / product name |\n| | version | X | X | X | X | | version |\n| | serial | X | X | X | X | | serial number |\n| | assetTag | X | X | X | X | | asset tag |\n| | memMax | X | | X | X | | max memory in bytes |\n| | memSlots | X | | X | X | | memory slots on baseboard |\n| si.chassis(cb) | {...} | X | X | X | X | | chassis information |\n| | manufacturer | X | X | X | X | | e.g. 'MSI' |\n| | model | X | X | X | X | | model / product name |\n| | type | X | X | X | X | | model / product name |\n| | version | X | X | X | X | | version |\n| | serial | X | X | X | X | | serial number |\n| | assetTag | X | X | X | X | | asset tag |\n| | sku | | | | X | | SKU number |\n\n#### 3. CPU\n\n| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |\n| ---------------------- | ---------------- | ----- | --- | --- | --- | --- | ----------------------------------- |\n| si.cpu(cb) | {...} | X | X | X | X | | CPU information |\n| | manufacturer | X | X | X | X | | e.g. 'Intel(R)' |\n| | brand | X | X | X | X | | e.g. 'Core(TM)2 Duo' |\n| | speed | X | X | X | X | | in GHz e.g. '3.40' |\n| | speedMin | X | | X | X | | in GHz e.g. '0.80' |\n| | speedMax | X | X | X | X | | in GHz e.g. '3.90' |\n| | governor | X | | | | | e.g. 'powersave' |\n| | cores | X | X | X | X | | # cores |\n| | physicalCores | X | X | X | X | | # physical cores |\n| | efficiencyCores | X | | X | | | # efficiency cores |\n| | performanceCores | X | | X | | | # performance cores |\n| | processors | X | X | X | X | | # processors |\n| | socket | X | X | | X | | socket type e.g. \"LGA1356\" |\n| | vendor | X | X | X | X | | vendor ID |\n| | family | X | X | X | X | | processor family |\n| | model | X | X | X | X | | processor model |\n| | stepping | X | X | X | X | | processor stepping |\n| | revision | X | | X | X | | revision |\n| | voltage | | X | | | | voltage |\n| | flags | X | X | X | X | | CPU flags |\n| | virtualization | X | X | X | X | | virtualization supported |\n| | cache | X | X | X | X | | cache in bytes (object) |\n| | cache.l1d | X | X | X | X | | L1D (data) size |\n| | cache.l1i | X | X | X | X | | L1I (instruction) size |\n| | cache.l2 | X | X | X | X | | L2 size |\n| | cache.l3 | X | X | X | X | | L3 size |\n| si.cpuFlags(cb) | : string | X | X | X | X | | CPU flags |\n| si.cpuCache(cb) | {...} | X | X | X | X | | CPU cache sizes |\n| | l1d | X | X | X | X | | L1D size |\n| | l1i | X | X | X | X | | L1I size |\n| | l2 | X | X | X | X | | L2 size |\n| | l3 | X | X | X | X | | L3 size |\n| si.cpuCurrentSpeed(cb) | {...} | X | X | X | X | X | current CPU speed (in GHz) |\n| | avg | X | X | X | X | X | avg CPU speed (all cores) |\n| | min | X | X | X | X | X | min CPU speed (all cores) |\n| | max | X | X | X | X | X | max CPU speed (all cores) |\n| | cores | X | X | X | X | X | CPU speed per core (array) |\n| si.cpuTemperature(cb) | {...} | X | X | X* | X | | CPU temperature in C (if supported) |\n| | main | X | X | X | X | | main temperature (avg) |\n| | cores | X | X | X | X | | array of temperatures |\n| | max | X | X | X | X | | max temperature |\n| | socket | X | | | | | array socket temperatures |\n| | chipset | X | | | | | chipset temperature |\n\n#### 4. Memory\n\n| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |\n| ---------------- | --------------------- | ----- | --- | --- | --- | --- | -------------------------------------- |\n| si.mem(cb) | {...} | X | X | X | X | X | Memory information (in bytes) |\n| | total | X | X | X | X | X | total memory in bytes |\n| | free | X | X | X | X | X | not used in bytes |\n| | used | X | X | X | X | X | used (incl. buffers/cache) |\n| | active | X | X | X | X | X | used actively (excl. buffers/cache) |\n| | buffcache | X | X | X | | X | used by buffers+cache |\n| | buffers | X | | | | | used by buffers |\n| | cached | X | | | | | used by cache |\n| | slab | X | | | | | used by slab |\n| | available | X | X | X | X | X | potentially available (total - active) |\n| | swaptotal | X | X | X | X | X | |\n| | swapused | X | X | X | X | X | |\n| | swapfree | X | X | X | X | X | |\n| | writeback | X | | | | | |\n| | dirty | X | | | | | |\n| si.memLayout(cb) | [{...}] | X | X | X | X | | Memory Layout (array) |\n| | [0].size | X | X | X | X | | size in bytes |\n| | [0].bank | X | X | | X | | memory bank |\n| | [0].type | X | X | X | X | | memory type |\n| | [0].clockSpeed | X | X | X | X | | clock speed |\n| | [0].formFactor | X | X | | X | | form factor |\n| | [0].manufacturer | X | X | X | X | | manufacturer |\n| | [0].partNum | X | X | X | X | | part number |\n| | [0].serialNum | X | X | X | X | | serial number |\n| | [0].voltageConfigured | X | X | | X | | voltage conf. |\n| | [0].voltageMin | X | X | | X | | voltage min |\n| | [0].voltageMax | X | X | | X | | voltage max |\n\n#### 5. Battery\n\n| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |\n| -------------- | ---------------- | ----- | --- | --- | --- | --- | --------------------------------- |\n| si.battery(cb) | {...} | X | X | X | X | | battery information |\n| | hasBattery | X | X | X | X | | indicates presence of battery |\n| | cycleCount | X | | X | | | numbers of recharges |\n| | isCharging | X | X | X | X | | indicates if battery is charging |\n| | designedCapacity | X | | X | X | | max capacity of battery (mWh) |\n| | maxCapacity | X | | X | X | | max capacity of battery (mWh) |\n| | currentCapacity | X | | X | X | | current capacity of battery (mWh) |\n| | capacityUnit | X | | X | X | | capacity unit (mWh) |\n| | voltage | X | | X | X | | current voltage of battery (V) |\n| | percent | X | X | X | X | | charging level in percent |\n| | timeRemaining | X | | X | | | minutes left (if discharging) |\n| | acConnected | X | X | X | X | | AC connected |\n| | type | X | | X | | | battery type |\n| | model | X | | X | | | model |\n| | manufacturer | X | | X | | | manufacturer |\n| | serial | X | | X | | | battery serial |\n\n- See known issues if you have a problem with macOS temperature or windows\n temperature\n\n#### 6. Graphics\n\n| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |\n| --------------- | ------------------------- | ----- | --- | --- | --- | --- | ------------------------------------------- |\n| si.graphics(cb) | {...} | X | | X | X | | arrays of graphics controllers and displays |\n| | controllers[] | X | | X | X | | graphics controllers array |\n| | ...[0].vendor | X | | X | X | | e.g. NVIDIA |\n| | ...[0].subVendor | X | | | | | e.g. Gigabyte |\n| | ...[0].vendorId | | | X | | | vendor ID |\n| | ...[0].model | X | | X | X | | graphics controller model |\n| | ...[0].deviceId | | | X | | | device ID |\n| | ...[0].bus | X | | X | X | | on which bus (e.g. PCIe) |\n| | ...[0].vram | X | | X | X | | VRAM size (in MB) |\n| | ...[0].vramDynamic | X | | X | X | | true if dynamically allocated ram |\n| | ...[0].external | | | X | | | is external GPU |\n| | ...[0].cores | | | X | | | Apple silicon only |\n| | ...[0].metalVersion | | | X | | | Apple Metal Version |\n| | displays[] | X | | X | X | | monitor/display array |\n| | ...[0].vendor | | | | X | | monitor/display vendor |\n| | ...[0].vendorId | | | X | | | vendor ID |\n| | ...[0].deviceName | | | | X | | e.g. \\\\\\\\.\\\\DISPLAY1 |\n| | ...[0].model | X | | X | X | | monitor/display model |\n| | ...[0].productionYear | | | X | | | production year |\n| | ...[0].serial | | | X | | | serial number |\n| | ...[0].displayId | | | X | | | display ID |\n| | ...[0].main | X | | X | X | | true if main monitor |\n| | ...[0].builtin | X | | X | | | true if built-in monitor |\n| | ...[0].connection | X | | X | X | | e.g. DisplayPort or HDMI |\n| | ...[0].sizeX | X | | | X | | size in mm horizontal |\n| | ...[0].sizeY | X | | | X | | size in mm vertical |\n| | ...[0].pixelDepth | X | | X | X | | color depth in bits |\n| | ...[0].resolutionX | X | | X | X | | pixel horizontal |\n| | ...[0].resolutionY | X | | X | X | | pixel vertical |\n| | ...[0].currentResX | X | | X | X | | current pixel horizontal |\n| | ...[0].currentResY | X | | X | X | | current pixel vertical |\n| | ...[0].positionX | | | X | X | | display position X |\n| | ...[0].positionY | | | X | X | | display position Y |\n| | ...[0].currentRefreshRate | X | | X | X | | current screen refresh rate |\n\n#### 7. Operating System\n\n| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |\n| --------------------- | ------------- | ----- | --- | --- | --- | --- | -------------------------------------------------------------------------------------------------------------------------------------------------- |\n| si.osInfo(cb) | {...} | X | X | X | X | X | OS information |\n| | platform | X | X | X | X | X | 'linux', 'darwin', 'Windows', ... |\n| | distro | X | X | X | X | X | |\n| | release | X | X | X | X | X | |\n| | codename | X | | X | | | |\n| | kernel | X | X | X | X | X | kernel release - same as os.release() |\n| | arch | X | X | X | X | X | same as os.arch() |\n| | hostname | X | X | X | X | X | same as os.hostname() |\n| | fqdn | X | X | X | X | X | FQDN fully qualified domain name |\n| | codepage | X | X | X | X | | OS build version |\n| | logofile | X | X | X | X | X | e.g. 'apple', 'debian', 'fedora', ... |\n| | serial | X | X | X | X | | OS/Host serial number |\n| | build | X | | X | X | | OS build version |\n| | servicepack | | | | X | | service pack version |\n| | uefi | X | X | X | X | | OS started via UEFI |\n| | hypervisor | | | | X | | hyper-v enabled? (win only) |\n| | remoteSession | | | | X | | runs in remote session (win only) |\n| si.uuid(cb) | {...} | X | X | X | X | X | object of several UUIDs |\n| | os | X | X | X | X | | os specific UUID |\n| | hardware | X | X | X | X | | hardware specific UUID |\n| | macs | X | X | X | X | | MAC addresses |\n| si.versions(apps, cb) | {...} | X | X | X | X | X | version information (kernel, ssl, node, ...)