Getting Started

SystemInspector is a lightweight collection of 58 core inspection functions to retrieve detailed hardware, system, and OS information for Node.js.

Installation

npm install @ambicuity/systeminspector

Usage Example

All functions (except version and time) are implemented as asynchronous functions. You can use standard Promises or async / await.

Using Promises

const si = require('@ambicuity/systeminspector');

si.cpu()
  .then(data => console.log(data))
  .catch(error => console.error(error));

Using Async / Await

const si = require('@ambicuity/systeminspector');

async function getSystemInfo() {
  try {
    const data = await si.cpu();
    console.log(data);
  } catch (e) {
    console.error(e);
  }
}

getSystemInfo();

Command Line

SystemInspector includes a CLI for quick terminal inspection.

# Full static data as JSON for scripts and pipes
npx @ambicuity/systeminspector

# Readable system report
npx @ambicuity/systeminspector info

# Interactive terminal inspector
npx @ambicuity/systeminspector interactive

# Command reference
npx @ambicuity/systeminspector --help

Security Advisories

Please review our security advisories before deploying to production environments.