This is a thin wrapper around systeminformation to expose it as a REST API. There is also a gRPC server and a sample client

You have to have node.js and npm setup. Uses express to create minimal web service and minimist to process command line argument. For testing I rely on mocha/chai/chai-http. All the dependencies are automatically installed by npm - see below.

Clone or download it from git hub:

git clone https://github.com/asokolsky/systeminformation-api.git

Run in the shell in the directory where you cloned systeminformation-api:

npm install
npm run build

in the shell:

npm run test

and then in the shell

npm run start

Finally, point your browser http:https://localhost:3000/api/systeminformation/cpu

node ./dist/index.js [{-p|--port}:<portnumber>] [-z|--zip] [-h|--help] [-v|--version]

• {-p|--port}:<port> - specifies port on which the service will listen for incoming HTTP connections
• -z|--zip - will force express to use gzip encoding - experimental, not for production
• -h|--help - display command line spec
• -v|--version - show package version

Only HTTP GET is supported.
The URIs start with /api/systeminformation followed by:

• empty string - returns systeminformation package version
• time - returns time JSON
• system
• bios
• baseboard
• cpu
• cpuFlags
• cpuCache
• cpuCurrentSpeed
• cpuTemperature
• mem
• memLayout
• diskLayout
• battery
• graphics
• osInfo
• versions
• shell
• users
• fsSize
• blockDevices
• fsStats
• disksIO
• networkInterfaces
• networkInterfaceDefault
• networkStats
• networkConnections
• currentLoad
• fullLoad
• processes
• dockerContainers
• dockerAll
• getStaticData
• getDynamicData

For a full description of the underlying functionality see the systeminformation documentation.

Here are the Best Practices.

The package relies on (almost standard) debug package. Command line to enable this app trace on Windows (powershell, default in vscode):

$env:DEBUG='siapi';node .\index.js

Try this to learn more about express:

$env:DEBUG='*';node .\index.js

To start the server:

node ./dist/grpc-server.js

To start the sample client:

node ./dist/grpc-client.js

The gRPC interface is defined in systeminformation.proto

systeminformation by Sebastian Hildebrandt

If you have an opinion or ideas on the below list - please do tell.

Decide on the logging facility to use: https://strongloop.com/strongblog/compare-node-js-logging-winston-bunyan/

https://github.com/coreybutler/node-windows

https://github.com/tallesl/qckwinsvc

https://nodesource.com/blog/8-protips-to-start-killing-it-when-dockerizing-node-js

The service is now implemented in TypeScript.

Use debug package instead of console.

DONE: https://www.npmjs.com/package/systeminformation-api

Followed the best practices suggestions, adopted optional gzip encoding. Did not benchmark the impact though.