Systeminformation

https://systeminformation.io
Admin
Systeminformation is a lightweight, dependency-free Node.js package offering 50+ functions to...
Tokens:51,448
Snippets:248
Trust Score:7.4
Update:11 months ago
Show doc for...
Tokens:
Raw
### GET /dockerInfo

Source: https://systeminformation.io/docker

Retrieves general information about the Docker installation and environment.

```APIDOC
## GET /dockerInfo

### Description
Fetches general Docker information such as ID, container counts, memory limits, CPU details, and more.

### Method
GET

### Endpoint
/dockerInfo

### Parameters
#### Query Parameters
- **cb** (function) - Optional - Callback function to handle the result.

### Request Example
```javascript
systeminformation.dockerInfo(function(data) {
  console.log(data);
});
```

### Response
#### Success Response (200)
- **id** (string) - Docker ID
- **containers** (number) - Number of containers
- **containersRunning** (number) - Number of running containers
- **containersPaused** (number) - Number of paused containers
- **containersStopped** (number) - Number of stopped containers
- **images** (number) - Number of images
- **driver** (string) - Storage driver (e.g., 'devicemapper', 'overlay2')
- **memoryLimit** (boolean) - Indicates if memory limit is enabled
- **swapLimit** (boolean) - Indicates if swap limit is enabled
- **kernelMemory** (boolean) - Indicates if kernel memory limit is enabled
- **cpuCfsPeriod** (boolean) - Indicates if CFS period is enabled
- **cpuCfsQuota** (boolean) - Indicates if CFS quota is enabled
- **cpuShares** (boolean) - Indicates if CPU shares are configured
- **cpuSet** (boolean) - Indicates if CPU sets are configured
- **ipv4Forwarding** (boolean) - Indicates if IPv4 forwarding is enabled
- **bridgeNfIptables** (boolean) - Indicates if bridge nf iptables is enabled
- **bridgeNfIp6tables** (boolean) - Indicates if bridge nf ip6tables is enabled
- **debug** (boolean) - Debug mode status
- **nfd** (string) - Named Data Networking forwarding daemon status
- **oomKillDisable** (boolean) - Out-of-memory kill disable status
- **ngoroutines** (number) - Number of Go routines
- **systemTime** (string) - Docker system time
- **loggingDriver** (string) - Logging driver (e.g., 'json-file')
- **cgroupDriver** (string) - Cgroup driver (e.g., 'cgroupfs')
- **nEventsListener** (number) - Number of event listeners
- **kernelVersion** (string) - Docker kernel version
- **operatingSystem** (string) - Docker OS (e.g., 'Docker for Mac')
- **osType** (string) - OS Type (e.g., 'linux')
- **architecture** (string) - System architecture (e.g., x86_64)
- **ncpu** (number) - Number of CPUs
- **memTotal** (number) - Total memory in bytes
- **dockerRootDir** (string) - Docker root directory path
- **httpProxy** (string) - HTTP proxy configuration
- **httpsProxy** (string) - HTTPS proxy configuration
- **noProxy** (string) - No proxy configuration
- **name** (string) - Docker daemon name
- **labels** (array) - Array of labels
- **experimentalBuild** (boolean) - Indicates if experimental build is used
- **serverVersion** (string) - Docker server version
- **clusterStore** (string) - Cluster store configuration
- **clusterAdvertise** (string) - Cluster advertise configuration
- **defaultRuntime** (string) - Default runtime (e.g., 'runc')
- **liveRestoreEnabled** (boolean) - Live restore enabled status
- **isolation** (string) - Isolation mode
- **initBinary** (string) - Path to init binary
- **productLicense** (string) - Product license information

#### Response Example
```json
{
  "id": "abcdef1234567890",
  "containers": 5,
  "containersRunning": 2,
  "containersPaused": 0,
  "containersStopped": 3,
  "images": 10,
  "driver": "overlay2",
  "memoryLimit": true,
  "swapLimit": true,
  "kernelMemory": false,
  "cpuCfsPeriod": true,
  "cpuCfsQuota": true,
  "cpuShares": 1024,
  "cpuSet": false,
  "ipv4Forwarding": true,
  "bridgeNfIptables": true,
  "bridgeNfIp6tables": true,
  "debug": false,
  "nfd": "",
  "oomKillDisable": false,
  "ngoroutines": 42,
  "systemTime": "2023-10-27T10:00:00Z",
  "loggingDriver": "json-file",
  "cgroupDriver": "cgroupfs",
  "nEventsListener": 1,
  "kernelVersion": "5.15.0-87-generic",
  "operatingSystem": "Ubuntu 22.04.3 LTS",
  "osType": "linux",
  "architecture": "x86_64",
  "ncpu": 8,
  "memTotal": 16777216000,
  "dockerRootDir": "/var/lib/docker",
  "httpProxy": "",
  "httpsProxy": "",
  "noProxy": "",
  "name": "docker-daemon",
  "labels": [],
  "experimentalBuild": false,
  "serverVersion": "24.0.5",
  "clusterStore": "",
  "clusterAdvertise": "",
  "defaultRuntime": "runc",
  "liveRestoreEnabled": false,
  "isolation": "",
  "initBinary": "/usr/bin/containerd-shim-runc-v2",
  "productLicense": ""
}
```
```

--------------------------------

### Install systeminformation package

Source: https://systeminformation.io/gettingstarted

Installs the systeminformation package using npm. This is the initial step to use the library in your Node.js project.

```bash
$ npm install systeminformation --save

or simpler:
$ npm install systeminformation
```

--------------------------------

### Install Linux SMART Monitoring Tools

Source: https://systeminformation.io/issues

To detect S.M.A.R.T. status on Linux, install the 'smartmontools' package. Versions 7.0 and above provide full S.M.A.R.T. data for diskLayout().

```bash
$ sudo apt-get install smartmontools
```

--------------------------------

### Install Linux Sensors Package

Source: https://systeminformation.io/issues

For temperature measurements on Debian-based Linux systems, install the 'lm-sensors' package. This is a prerequisite for systeminformation to retrieve accurate temperature data.

```bash
$ sudo apt-get install lm-sensors
```

--------------------------------

### Install systeminformation (v4) via npm

Source: https://systeminformation.io/v4/gettingstarted

This command installs version 4 of the systeminformation library using npm. It's suitable for projects requiring specific older versions.

```bash
$ npm install systeminformation@4 ---save
```

--------------------------------

### GET /docker/info

Source: https://systeminformation.io/v4/docker

Retrieves general information about the Docker installation. This includes details like Docker ID, container counts, image counts, memory limits, and system configuration.

```APIDOC
## GET /docker/info

### Description
Retrieves general information about the Docker installation.

### Method
GET

### Endpoint
/docker/info

### Parameters
#### Query Parameters
- **cb** (function) - Optional - Callback function to handle the result.

### Response
#### Success Response (200)
- **id** (string) - Docker ID.
- **containers** (integer) - Number of containers.
- **containersRunning** (integer) - Number of running containers.
- **containersPaused** (integer) - Number of paused containers.
- **containersStopped** (integer) - Number of stopped containers.
- **images** (integer) - Number of images.
- **driver** (string) - Driver name (e.g., 'devicemapper', 'overlay2').
- **memoryLimit** (boolean) - Indicates if memory limit is enabled.
- **SwapLimit** (boolean) - Indicates if swap limit is enabled.
- **kernelMemory** (boolean) - Indicates if kernel memory is enabled.
- **cpuCfsPeriod** (boolean) - Indicates if CPU CFS period is enabled.
- **cpuCfsQuota** (boolean) - Indicates if CPU CFS quota is enabled.
- **cpuShares** (boolean) - Indicates if CPU shares are enabled.
- **cpuSet** (boolean) - Indicates if CPU set is enabled.
- **ipv4Forwarding** (boolean) - Indicates if IPv4 forwarding is enabled.
- **bridgeNfIptables** (boolean) - Indicates if bridge nf iptables is enabled.
- **bridgeNfIp6tables** (boolean) - Indicates if bridge nf ip6tables is enabled.
- **debug** (boolean) - Indicates if debug mode is enabled.
- **nfd** (string) - Named data networking forwarding daemon.
- **oomKillDisable** (boolean) - Indicates if out-of-memory kill is disabled.
- **ngoroutines** (integer) - Number of goroutines.
- **systemTime** (string) - Docker system time.
- **loggingDriver** (string) - Logging driver (e.g., 'json-file').
- **cgroupDriver** (string) - Cgroup driver (e.g., 'cgroupfs').
- **nEventsListener** (integer) - Number of event listeners.
- **kernelVersion** (string) - Docker kernel version.
- **operatingSystem** (string) - Docker OS name (e.g., 'Docker for Mac').
- **osType** (string) - OS Type (e.g., 'linux').
- **architecture** (string) - System architecture (e.g., 'x86_64').
- **ncpu** (integer) - Number of CPUs.
- **memTotal** (integer) - Total memory in bytes.
- **dockerRootDir** (string) - Docker root directory path.
- **httpProxy** (string) - HTTP proxy configuration.
- **httpsProxy** (string) - HTTPS proxy configuration.
- **noProxy** (string) - No proxy configuration.
- **name** (string) - Docker daemon name.
- **labels** (array) - Array of labels.
- **experimentalBuild** (boolean) - Indicates if it's an experimental build.
- **serverVersion** (string) - Docker server version.
- **clusterStore** (string) - Cluster store configuration.
- **clusterAdvertise** (string) - Cluster advertise configuration.
- **defaultRuntime** (string) - Default runtime (e.g., 'runc').
- **liveRestoreEnabled** (boolean) - Indicates if live restore is enabled.
- **isolation** (string) - Isolation mode.
- **initBinary** (string) - Path to the init binary.
- **productLicense** (string) - Product license information.

### Request Example
(No request body for this GET request)

### Response Example
```json
{
  "id": "abcdef1234567890",
  "containers": 10,
  "containersRunning": 5,
  "containersPaused": 0,
  "containersStopped": 5,
  "images": 50,
  "driver": "overlay2",
  "memoryLimit": true,
  "SwapLimit": true,
  "kernelMemory": false,
  "cpuCfsPeriod": true,
  "cpuCfsQuota": true,
  "cpuShares": 1024,
  "cpuSet": false,
  "ipv4Forwarding": true,
  "bridgeNfIptables": true,
  "bridgeNfIp6tables": true,
  "debug": false,
  "nfd": "",
  "oomKillDisable": false,
  "ngoroutines": 42,
  "systemTime": "2023-10-27T10:00:00Z",
  "loggingDriver": "json-file",
  "cgroupDriver": "cgroupfs",
  "nEventsListener": 0,
  "kernelVersion": "5.15.0-87-generic",
  "operatingSystem": "Docker Desktop",
  "osType": "linux",
  "architecture": "x86_64",
  "ncpu": 8,
  "memTotal": 17179869184,
  "dockerRootDir": "/var/lib/docker",
  "httpProxy": "",
  "httpsProxy": "",
  "noProxy": "",
  "name": "Docker Engine",
  "labels": [],
  "experimentalBuild": false,
  "serverVersion": "24.0.5",
  "clusterStore": "",
  "clusterAdvertise": "",
  "defaultRuntime": "runc",
  "liveRestoreEnabled": false,
  "isolation": "",
  "initBinary": "/usr/bin/containerd-shim-runc-v2",
  "productLicense": ""
}
```
```

--------------------------------

### Install macOS Temperature Sensor Package

Source: https://systeminformation.io/issues

To enable temperature readings on macOS, install the 'osx-temperature-sensor' package. This is an optional dependency that systeminformation will detect to provide accurate CPU temperature values.

```bash
$ npm install osx-temperature-sensor --save
```

--------------------------------

### Get Service Status (Node.js)

Source: https://systeminformation.io/v4/processes

Retrieves the running status, start mode, and associated PIDs for specified services (e.g., 'mysql', 'apache2'). Supports fetching all services by passing '*'. Returns an array of service objects. Dependencies: systeminformation library.

```javascript
const si = require('systeminformation');
si.services('mysql, postgres').then(data => console.log(data));
```

--------------------------------

### Get System Information with Parameters using si.get()

Source: https://systeminformation.io/v4/general

Retrieves specific system information, allowing parameters to be passed to certain functions within the 'get' call. Parameters are provided in parentheses after the key name. Returns a promise.

```javascript
const si = require('systeminformation');

// Define the structure with parameters for processLoad
const valueObject = {
  processLoad: 'pids, cpu (postgres)' 
};

// Call si.get() with parameters and log the data
si.get(valueObject).then(data => {
  console.log(data);
}).catch(error => {
  console.error('Error fetching data:', error);
});

/*
Example Output:
{
  processLoad: {
    pids: [
      640, 643, 654,
      655, 656, 657,
      658, 659
    ],
    cpu: 0.63
  }
}
*/
```

--------------------------------

### Get System Information with Parameters

Source: https://systeminformation.io/general

Allows passing parameters to functions within the `get()` call. Parameters are specified in parentheses after the key name, enabling targeted data retrieval, such as process load for a specific process.

```javascript
const si = require('systeminformation');

// define all values, you want to get back
// here the value in paretheses goes as a parameter
// to the processLoad function

valueObject = {
  processLoad: '(postgres) pids, cpu'
}
si.get(valueObject).then(data => console.log(data));
```

--------------------------------

### Get Docker Images (Node.js)

Source: https://systeminformation.io/docker

Lists all Docker images available on the system. The output includes image ID, tags, and size. This function requires Docker to be installed and accessible.

```javascript
const si = require('systeminformation');

// Docker images
si.dockerImages().then(data => console.log(data)).catch(error => console.error(error));

```

--------------------------------

### Get System Information Library Version and Time Details

Source: https://systeminformation.io/v4/general

Retrieves the version of the systeminformation library and current time/timezone details of the machine. These functions do not return promises and are synchronous.

```javascript
const si = require('systeminformation');

// Get library version
const libVersion = si.version();
console.log(`Library Version: ${libVersion}`);

// Get time and timezone information
const timeInfo = si.time();
console.log('Time Information:', timeInfo);
```

--------------------------------

### Get Docker Information (Node.js)

Source: https://systeminformation.io/docker

Retrieves general information about the Docker installation. This function requires Docker to be running on the system. It returns an object containing details about the Docker version and server details.

```javascript
const si = require('systeminformation');

// Docker information
si.dockerInfo().then(data => console.log(data)).catch(error => console.error(error));

```

--------------------------------

### Get Logged-in User Information with systeminformation (Node.js)

Source: https://systeminformation.io/v4/os

This snippet retrieves a list of currently logged-in users on the system. It uses the 'systeminformation' library, which needs to be installed via npm. The output is a JSON array containing details about each user session, including username, terminal, login time, and originating IP address.

```javascript
const si = require('systeminformation');
si.users().then(data => console.log(data));
```

```json
[
  {
    user: 'yourname',
    tty: 'ttys006',
    date: '2020-02-01',
    time: '21:20',
    ip: '',
    command: 'w -ih'
  },
  {
    user: 'othername',
    tty: 'ttys008',
    date: '2020-02-01',
    time: '21:20',
    ip: '',
    command: '-bash'
  }
]
```

--------------------------------

### Get Service Information

Source: https://systeminformation.io/processes

Retrieves status information for specified system services. The input is a comma-separated string of service names or '*' for all services (Linux/Windows only). The output is an array of service objects, including their name, running status, start mode, PIDs, CPU, and memory usage.

```javascript
const si = require('systeminformation');
si.services('mysql, postgres').then(data => console.log(data));
```

```json
[
  {
    name: 'mysql',
    running: true,
    startmode: '',
    pids: [ 152 ],
    cpu: 0.3,
    mem: 0
  },
  {
    name: 'postgres',
    running: true,
    startmode: '',
    pids: [ 1087, 1873 ],
    cpu: 0,
    mem: 0
  },
]

```

--------------------------------

### Get Custom System Information Data with si.get()

Source: https://systeminformation.io/v4/general

Fetches specified system information data in a single call by defining a JSON object representing the desired data structure. This function returns a promise.

```javascript
const si = require('systeminformation');

// Define the structure of the data you want to retrieve
const valueObject = {
  cpu: '*', 
  osInfo: 'platform, release',
  system: 'model, manufacturer'
};

// Call si.get() and log the data
si.get(valueObject).then(data => {
  console.log(data);
}).catch(error => {
  console.error('Error fetching data:', error);
});

/*
Example Output:
{
  cpu: {
    manufacturer: 'Intel®',
    brand: 'Core™ i7-8569U',
    vendor: 'GenuineIntel',
    family: '6',
    model: '142',
    stepping: '10',
    revision: '',
    voltage: '',
    speed: '2.80',
    speedmin: '2.80',
    speedmax: '2.80',
    governor: '',
    cores: 8,
    physicalCores: 4,
    processors: 1,
    socket: '',
    cache: { l1d: 32768, l1i: 32768, l2: 262144, l3: 8388608 }
  },
  osInfo: {
    platform: 'darwin',
    release: '10.15.4'
  },
  system: {
    model: 'MacBookPro15,2',
    manufacturer: 'Apple Inc.'
  }
}
*/
```

--------------------------------

### GET /api/system

Source: https://systeminformation.io/v4/system

Fetches general system hardware information such as manufacturer, model, version, serial number, UUID, SKU, and virtual machine status.

```APIDOC
## GET /api/system

### Description
Retrieves core system hardware details including manufacturer, model, version, serial number, UUID, SKU, and whether the system is a virtual machine.

### Method
GET

### Endpoint
/api/system

### Parameters
#### Query Parameters
- **cb** (function) - Optional - Callback function to handle the result.

### Request Example
```javascript
const si = require('systeminformation');
si.system().then(data => console.log(data));
```

### Response
#### Success Response (200)
- **manufacturer** (string) - The manufacturer of the system.
- **model** (string) - The model or product name of the system.
- **version** (string) - The version of the system hardware.
- **serial** (string) - The serial number of the system.
- **uuid** (string) - The universally unique identifier for the system.
- **sku** (string) - The stock-keeping unit number.
- **virtual** (boolean) - Indicates if the system is a virtual machine.
- **raspberry** (object) - Additional Raspberry-specific information (if applicable).
  - **manufacturer** (string)
  - **processor** (string)
  - **type** (string)
  - **revision** (string)

#### Response Example
```json
{
  "manufacturer": "Apple Inc.",
  "model": "MacBookPro13,2",
  "version": "1.0",
  "serial": "C01xxxxxxxx",
  "uuid": "F87654-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "sku": "Mac-99878xxxx...",
  "virtual": false
}
```
```

--------------------------------

### GET /osInfo

Source: https://systeminformation.io/os

Retrieves detailed information about the operating system, including platform, distribution, release, kernel, architecture, and more.

```APIDOC
## GET /osInfo

### Description
Fetches detailed information about the installed operating system.

### Method
GET

### Endpoint
/osInfo

### Parameters
None

### Request Example
```javascript
const si = require('systeminformation');
si.osInfo().then(data => console.log(data));
```

### Response
#### Success Response (200)
- **platform** (string) - The operating system platform (e.g., 'linux', 'darwin', 'Windows').
- **distro** (string) - The distribution name (e.g., 'Mac OS X', 'Ubuntu').
- **release** (string) - The OS release version.
- **codename** (string) - The OS codename (if applicable).
- **kernel** (string) - The kernel release version.
- **arch** (string) - The system architecture (e.g., 'x64').
- **hostname** (string) - The system's hostname.
- **fqdn** (string) - The fully qualified domain name.
- **codepage** (string) - The OS codepage.
- **logofile** (string) - Identifier for the OS logo (e.g., 'apple', 'debian').
- **serial** (string) - The OS/Host serial number.
- **build** (string) - The OS build version.
- **servicepack** (string) - The service pack version (Windows only).
- **uefi** (boolean) - Indicates if the OS uses UEFI on startup.
- **hypervizor** (boolean) - Indicates if a hyper-v hypervisor is detected (Windows only).
- **remoteSession** (boolean) - Indicates if the OS is running in a remote session (Windows only).

#### Response Example
```json
{
  "platform": "darwin",
  "distro": "Mac OS X",
  "release": "10.15.3",
  "codename": "macOS Catalina",
  "kernel": "19.3.0",
  "arch": "x64",
  "hostname": "hostname.local",
  "fqdn": "hostname.local",
  "codepage": "UTF-8",
  "logofile": "apple",
  "serial": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  "build": "19D76",
  "servicepack": "",
  "uefi": true,
  "hypervizor": false,
  "remoteSession": false
}
```
```

--------------------------------

### GET /api/bios

Source: https://systeminformation.io/v4/system

Fetches BIOS information including vendor, version, release date, and revision.

```APIDOC
## GET /api/bios

### Description
Retrieves information about the system's BIOS, including its vendor, version, release date, and revision.

### Method
GET

### Endpoint
/api/bios

### Parameters
#### Query Parameters
- **cb** (function) - Optional - Callback function to handle the result.

### Request Example
```javascript
const si = require('systeminformation');
si.bios().then(data => console.log(data));
```

### Response
#### Success Response (200)
- **vendor** (string) - The BIOS vendor (e.g., 'AMI').
- **version** (string) - The BIOS version.
- **releaseDate** (string) - The BIOS release date in YYYY-MM-DD format.
- **revision** (string) - The BIOS revision number.

#### Response Example
```json
{
  "vendor": "American Megatrends Inc.",
  "version": "P4.20",
  "releaseDate": "2019-09-05",
  "revision": "5.13"
}
```
```

--------------------------------

### GET /versions

Source: https://systeminformation.io/os

Retrieves version information for Node.js and various development software packages. Specific packages can be requested.

```APIDOC
## GET /versions

### Description
Fetches version information for Node.js and a wide range of development software packages. You can optionally specify which applications to get version information for.

### Method
GET

### Endpoint
/versions

### Parameters
#### Query Parameters
- **apps** (string) - Optional. A comma or space-separated string of application names for which to retrieve versions (e.g., 'node,npm,git').

### Request Example
```javascript
const si = require('systeminformation');
// Get all versions
si.versions().then(data => console.log(data));

// Get specific versions
si.versions('node,npm,git').then(data => console.log(data));
```

### Response
#### Success Response (200)
- **kernel** (string) - Kernel version.
- **apache** (string) - Apache version.
- **bash** (string) - Bash version.
- **bun** (string) - Bun version.
- **deno** (string) - Deno version.
- **docker** (string) - Docker version.
- **dotnet** (string) - .NET version.
- **fish** (string) - Fish shell version.
- **gcc** (string) - GCC version.
- **git** (string) - Git version.
- **grunt** (string) - Grunt version.
- **gulp** (string) - Gulp version.
- **homebrew** (string) - Homebrew version.
- **java** (string) - Java version.
- **mongodb** (string) - MongoDB version.
- **mysql** (string) - MySQL version.
- **nginx** (string) - Nginx version.
- **node** (string) - Node.js version.
- **npm** (string) - NPM version.
- **openssl** (string) - OpenSSL version.
- **perl** (string) - Perl version.
- **php** (string) - PHP version.
- **pip3** (string) - Pip3 version.
- **pip** (string) - Pip version.
- **pm2** (string) - PM2 version.
- **postfix** (string) - Postfix version.
- **postgresql** (string) - PostgreSQL version.
- **powershell** (string) - PowerShell version.
- **python3** (string) - Python 3 version.
- **python** (string) - Python version.
- **redis** (string) - Redis version.
- **systemOpenssl** (string) - System OpenSSL version.
- **systemOpensslLib** (string) - System OpenSSL library name.
- **tsc** (string) - TypeScript compiler version.
- **v8** (string) - V8 JavaScript engine version.
- **virtualbox** (string) - VirtualBox version.
- **yarn** (string) - Yarn version.
- **zsh** (string) - Zsh version.

#### Response Example
```json
{
  "kernel": "23.6.0",
  "apache": "2.4.62",
  "bash": "3.2.57",
  "bun": "1.1.21",
  "deno": "2.1.4",
  "docker": "26.1.1",
  "dotnet": "",
  "fish": "",
  "gcc": "15.0.0",
  "git": "2.39.3",
  "grunt": "",
  "gulp": "",
  "homebrew": "4.4.14",
  "java": "17.0.2",
  "mongodb": "",
  "mysql": "9.0.1",
  "nginx": "",
  "node": "22.12.0",
  "npm": "10.9.0",
  "openssl": "3.0.15+quic",
  "perl": "5.34.1",
  "php": "8.3.6",
  "pip3": "24.2",
  "pip": "20.3.4",
  "pm2": "5.1.2",
  "postfix": "3.2.2",
  "postgresql": "16.4",
  "powershell": "",
  "python3": "3.12.5",
  "python": "",
  "redis": "",
  "systemOpenssl": "3.3.1",
  "systemOpensslLib": "OpenSSL",
  "tsc": "5.2.2",
  "v8": "12.4.254.21-node.21",
  "virtualbox": "",
  "yarn": "1.22.17",
  "zsh": "5.9"
}
```
```

--------------------------------

### Get Current System Load with Interval

Source: https://systeminformation.io/processes

Demonstrates how to get accurate CPU load statistics by calling the `currentLoad` function within an interval. The first call provides load since system uptime, while subsequent calls provide load between the calls, offering precise measurements. This is useful for real-time monitoring.

```javascript
const si = require('systeminformation');

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

```

--------------------------------

### GET /api/baseboard

Source: https://systeminformation.io/v4/system

Fetches baseboard (motherboard) information including manufacturer, model, version, serial number, and asset tag.

```APIDOC
## GET /api/baseboard

### Description
Retrieves details about the system's baseboard (motherboard), such as manufacturer, model, version, serial number, and asset tag.

### Method
GET

### Endpoint
/api/baseboard

### Parameters
#### Query Parameters
- **cb** (function) - Optional - Callback function to handle the result.

### Request Example
```javascript
const si = require('systeminformation');
si.baseboard().then(data => console.log(data));
```

### Response
#### Success Response (200)
- **manufacturer** (string) - The baseboard manufacturer (e.g., 'ASUS').
- **model** (string) - The model or product name of the baseboard.
- **version** (string) - The version of the baseboard.
- **serial** (string) - The serial number of the baseboard.
- **assetTag** (string) - The asset tag of the baseboard.

#### Response Example
```json
{
  "manufacturer": "ASRock",
  "model": "H310M-STX",
  "version": "",
  "serial": "C80-xxxxxxxxxxx",
  "assetTag": ""
}
```
```

--------------------------------

### GET /bios

Source: https://systeminformation.io/system

Retrieves BIOS information, including vendor, version, release date, revision, serial number, language, and supported features.

```APIDOC
## GET /bios

### Description
Retrieves BIOS information, including vendor, version, release date, revision, serial number, language, and supported features.

### Method
GET

### Endpoint
/bios

### Parameters
None

### Request Example
```javascript
const si = require('systeminformation');
si.bios().then(data => console.log(data));
```

### Response
#### Success Response (200)
- **vendor** (string) - The BIOS vendor (e.g., 'AMI').
- **version** (string) - The BIOS version.
- **releaseDate** (string) - The BIOS release date (YYYY-MM-DD).
- **revision** (string) - The BIOS revision.
- **serial** (string) - The serial number of the BIOS.
- **language** (string) - The BIOS language.
- **features** (array) - An array of supported BIOS features.

#### Response Example
```json
{
  "vendor": "American Megatrends Inc.",
  "version": "P4.20",
  "releaseDate": "2019-09-05",
  "revision": "5.13",
  "langage": "en",
  "features": [
    "PCI",
    "Boot from CD",
    "Selectable boot",
    "EDD",
    "Print screen service",
    "ACPI",
    "USB legacy",
    "BIOS boot specification",
    "Targeted content distribution",
    "UEFI"
  ]
}
```
```

--------------------------------

### GET /audio

Source: https://systeminformation.io/audio

Retrieves a list of detected audio devices. The results may vary across different platforms.

```APIDOC
## GET /audio

### Description
Retrieves information about detected audio devices and interfaces. The availability and details of devices may differ across operating systems.

### Method
GET

### Endpoint
/audio

### Parameters
None

### Request Example
```javascript
const si = require('systeminformation');
si.audio().then(data => console.log(data));
```

### Response
#### Success Response (200)
- **Array of Objects**: Each object represents an audio device with the following properties:
  - **id** (number) - Internal ID of the audio device.
  - **name** (string) - The name of the audio device.
  - **manufacturer** (string) - The manufacturer of the audio device.
  - **revision** (string) - The revision number of the audio device (may be null).
  - **driver** (string) - The driver associated with the audio device (may be null).
  - **default** (boolean) - Indicates if this is the default audio device.
  - **channel** (string) - The type of audio channel (e.g., 'Built-In', 'HDMI', 'USB').
  - **type** (string) - The type of audio device (e.g., 'Microphone', 'Speaker').
  - **in** (boolean) - Indicates if the device is an input device.
  - **out** (boolean) - Indicates if the device is an output device.
  - **status** (string) - The current status of the audio device (e.g., 'online').

#### Response Example
```json
[
  {
    "id": 0,
    "name": "MacBook Microphone",
    "manufacturer": "Apple Inc.",
    "revision": null,
    "driver": null,
    "default": true,
    "channel": "Built-In",
    "type": "Microphone",
    "in": true,
    "out": false,
    "status": "online"
  },
  {
    "id": 1,
    "name": "MacBook Speaker",
    "manufacturer": "Apple Inc.",
    "revision": null,
    "driver": null,
    "default": true,
    "channel": "Built-In",
    "type": "Speaker",
    "in": false,
    "out": true,
    "status": "online"
  }
]
```
```

--------------------------------

### GET /chassis

Source: https://systeminformation.io/system

Retrieves chassis information, including manufacturer, model, type, version, serial number, asset tag, and SKU.

```APIDOC
## GET /chassis

### Description
Retrieves chassis information, including manufacturer, model, type, version, serial number, asset tag, and SKU.

### Method
GET

### Endpoint
/chassis

### Parameters
None

### Request Example
```javascript
const si = require('systeminformation');
si.chassis().then(data => console.log(data));
```

### Response
#### Success Response (200)
- **manufacturer** (string) - The chassis manufacturer (e.g., 'ASUS').
- **model** (string) - The model or product name of the chassis.
- **type** (string) - The chassis type (e.g., 'desktop', 'Laptop').
- **version** (string) - The version of the chassis.
- **serial** (string) - The serial number of the chassis.
- **assetTag** (string) - The asset tag of the chassis.
- **sku** (string) - The SKU number of the chassis.

#### Response Example
```json
{
  "manufacturer": "Apple Inc.",
  "model": "MacBookPro13,2",
  "type": "Laptop",
  "version": "1.0",
  "serial": "C01xxxxxxxx",
  "assetTag": "Mac-99878xxxx...",
  "sku": "A1706"
}
```
```

--------------------------------

### GET /api/chassis

Source: https://systeminformation.io/v4/system

Fetches chassis information including manufacturer, model, type, version, serial number, asset tag, and SKU.

```APIDOC
## GET /api/chassis

### Description
Retrieves information about the system's chassis (case), including manufacturer, model, type, version, serial number, asset tag, and SKU.

### Method
GET

### Endpoint
/api/chassis

### Parameters
#### Query Parameters
- **cb** (function) - Optional - Callback function to handle the result.

### Request Example
```javascript
const si = require('systeminformation');
si.chassis().then(data => console.log(data));
```

### Response
#### Success Response (200)
- **manufacturer** (string) - The chassis manufacturer (e.g., 'ASUS').
- **model** (string) - The model or product name of the chassis.
- **type** (string) - The type of chassis (e.g., 'desktop').
- **version** (string) - The version of the chassis.
- **serial** (string) - The serial number of the chassis.
- **assetTag** (string) - The asset tag of the chassis.
- **sku** (string) - The SKU number of the chassis.

#### Response Example
```json
{
  "manufacturer": "Apple Inc.",
  "model": "MacBookPro13,2",
  "type": "",
  "version": "1.0",
  "serial": "C01xxxxxxxx",
  "assetTag": "Mac-99878xxxx...",
  "sku": ""
}
```
```

--------------------------------

### Get System Information Library Version

Source: https://systeminformation.io/general

Retrieves the version number of the systeminformation library. This function does not return a promise and is synchronous.

```javascript
const si = require('systeminformation');

console.log(si.version());
```

--------------------------------

### GET /baseboard

Source: https://systeminformation.io/system

Retrieves baseboard (motherboard) information, including manufacturer, model, version, serial number, asset tag, maximum memory, and memory slots.

```APIDOC
## GET /baseboard

### Description
Retrieves baseboard (motherboard) information, including manufacturer, model, version, serial number, asset tag, maximum memory, and memory slots.

### Method
GET

### Endpoint
/baseboard

### Parameters
None

### Request Example
```javascript
const si = require('systeminformation');
si.baseboard().then(data => console.log(data));
```

### Response
#### Success Response (200)
- **manufacturer** (string) - The baseboard manufacturer (e.g., 'ASUS').
- **model** (string) - The model or product name of the baseboard.
- **version** (string) - The version of the baseboard.
- **serial** (string) - The serial number of the baseboard.
- **assetTag** (string) - The asset tag of the baseboard.
- **memMax** (number) - The maximum memory capacity in bytes (where available).
- **memSlots** (number) - The number of memory slots on the baseboard.

#### Response Example
```json
{
  "manufacturer": "ASRock",
  "model": "H310M-STX",
  "version": "",
  "serial": "C80-xxxxxxxxxxx",
  "assetTag": "",
  "memMax": 68719476736,
  "memSlots": 2
}
```
```

--------------------------------

### Get Network Stats per Second with systeminformation.js

Source: https://systeminformation.io/v4/statsfunctions

This example demonstrates how to correctly retrieve network statistics per second using the `networkStats()` function. It highlights that per-second values are accurate starting from the second call. The code uses `setInterval` to poll the network stats every second.

```javascript
const si = require('systeminformation');

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

```

--------------------------------

### GET /graphics

Source: https://systeminformation.io/v4/graphics

Retrieves information about installed graphics controllers and connected displays.

```APIDOC
## GET /graphics

### Description
Retrieves an array of graphics controllers and connected displays installed on the system.

### Method
GET

### Endpoint
/graphics

### Parameters
None

### Request Example
```javascript
const si = require('systeminformation');
si.graphics().then(data => console.log(data));
```

### Response
#### Success Response (200)
- **controllers** (array) - An array of graphics controller objects.
  - **model** (string) - Graphics controller model.
  - **vendor** (string) - Graphics controller vendor (e.g., ATI).
  - **bus** (string) - The bus the controller is on (e.g., PCIe).
  - **vram** (integer) - VRAM size in MB.
  - **vramDynamic** (boolean) - True if VRAM is dynamically allocated.
  - **subDeviceId** (string) - (Optional, nvidia-smi) Sub device ID.
  - **driverVersion** (string) - (Optional, nvidia-smi) Driver version.
  - **name** (string) - (Optional, nvidia-smi) Controller name.
  - **pciBus** (string) - (Optional, nvidia-smi) PCI bus ID.
  - **fanSpeed** (integer) - (Optional, nvidia-smi) Fan speed.
  - **memoryTotal** (integer) - (Optional, nvidia-smi) Total memory.
  - **memoryUsed** (integer) - (Optional, nvidia-smi) Used memory.
  - **memoryFree** (integer) - (Optional, nvidia-smi) Free memory.
  - **utilizationGpu** (number) - (Optional, nvidia-smi) GPU utilization.
  - **utilizationMemory** (number) - (Optional, nvidia-smi) Memory utilization.
  - **temperatureGpu** (integer) - (Optional, nvidia-smi) GPU temperature.
  - **temperatureMemory** (integer) - (Optional, nvidia-smi) Memory temperature.
  - **powerDraw** (integer) - (Optional, nvidia-smi) Power draw.
  - **powerLimit** (integer) - (Optional, nvidia-smi) Power limit.
  - **clockCore** (integer) - (Optional, nvidia-smi) Core clock speed.
  - **clockMemory** (integer) - (Optional, nvidia-smi) Memory clock speed.
- **displays** (array) - An array of display objects.
  - **vendor** (string) - Monitor/display vendor.
  - **deviceName** (string) - Device name (e.g., \\.\DISPLAY1).
  - **model** (string) - Monitor/display model.
  - **main** (boolean) - True if this is the main monitor.
  - **builtin** (boolean) - True if this is a built-in monitor.
  - **connection** (string) - Connection type (e.g., DisplayPort, HDMI).
  - **sizex** (integer) - Size in mm horizontal.
  - **sizey** (integer) - Size in mm vertical.
  - **pixeldepth** (integer) - Color depth in bits.
  - **resolutionx** (integer) - Resolution horizontal in pixels.
  - **resolutiony** (integer) - Resolution vertical in pixels.
  - **currentResX** (integer) - Current resolution horizontal in pixels.
  - **currentResY** (integer) - Current resolution vertical in pixels.
  - **positionX** (integer) - Screen position X.
  - **positionY** (integer) - Screen position Y.
  - **currentRefreshRate** (integer) - Current screen refresh rate.

#### Response Example
```json
{
  "controllers": [
    {
      "vendor": "Intel",
      "model": "Intel Iris Plus Graphics 655",
      "bus": "Built-In",
      "vram": 1536,
      "vramDynamic": true
    }
  ],
  "displays": [
    {
      "vendor": "",
      "model": "Color LCD",
      "main": true,
      "builtin": false,
      "connection": "Internal",
      "sizex": -1,
      "sizey": -1,
      "pixeldepth": 24,
      "resolutionx": 2560,
      "resolutiony": 1600,
      "currentResX": 2560,
      "currentResY": 1600,
      "positionX": 0,
      "positionY": 0,
      "currentRefreshRate": -1
    }
  ]
}
```
```

--------------------------------

### Retrieve CPU Info using Promises (Detailed)

Source: https://systeminformation.io/v4/gettingstarted

An expanded example of fetching CPU details using promises, logging specific attributes like manufacturer, brand, speed, cores, and physical cores. Handles potential errors. Requires the 'systeminformation' library.

```javascript
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));

```
Tokens:
Raw