systeminformation 's direct dependencies. Data on all dependencies, including transitive ones, is available via CSV download.| Name | Version | Size | License | Type | Vulnerabilities |
|---|
Systeminformation is a powerful, lightweight system and OS information library for Node.js. It offers a collection of over 50 functions that allow you to retrieve detailed information about the hardware, system, and OS, such as CPU info, memory, battery, graphics, disks/filesystem, network, Docker, services, and processes. It supports Linux, macOS, Windows, FreeBSD, OpenBSD, NetBSD, SunOS, and Android, and doesn't have any external npm dependencies. This library operates on the backend or server-side and does not function within a browser.
To use Systeminformation, you first need to install it via npm with one of the following commands in your project directory:
npm install systeminformation --save
or
npm i systeminformation
After installation, you can import the library into your JavaScript file and utilize its functions. Given that all functions (except version and time) are implemented asynchronously, they should be used in either a promise style or an async/await style.
An example of using the cpu() function in a promise-style way would be:
const si = require('systeminformation');
si.cpu()
.then(data => console.log(data))
.catch(error => console.error(error));
The function first retrieves CPU information and then logs it to the console.
The documentation for Systeminformation is located on systeminformation.io. Here, you can find a comprehensive function reference along with examples that outline the use of each function provided by the library. The documentation also contains details about the supported OS for each function, ensuring that you have all the necessary information before you start developing with Systeminformation.
