augustarchive / sysinfo

:gear: | Shows system information (based on os-utils)

@augu/sysinfo

Shows extended information from Node's os module

Based (and updated version!) of os-utils

Documentation | NPM | GitHub

Usage

const sys = require('@augu/sysinfo');
sys.getCPUInfo();

Using in an IDE

[If you're using VSCode], you'll see a @works annotation label in JSDoc when hovered/looking in this repository, it lists the Operating Systems that will work with that function. It'll also show warnings in the JSDoc by listing the warnings to you or emits a warning in the console if not used properly

Contributing

Thanks for contributing! Here's how to

• Fork this repository!
• Clone it to your PC and create your branch (git checkout -b branch)
• Code your heart out!~
• Lint the package for any code errors (npm run lint or yarn lint)
• Run (or add) tests in the tests/test.js file and run it
• Push to your branch (git push -u origin branch)
• Submit a pull request

Is this harmful?!

No it's not, most of the Unix and Windows only commands are executed from your computer itself. This library runs a command and returns an output from that command, so if you don't want that, then don't install this library.

LICENSE

sysinfo is released under the MIT License, view here for more information.

sysinfo's Issues

Roadmap: v0.2.0

What to add to v0.2.0

• CPU uptime in sys#getCpuInfo
• Uppercase Cpu in function names (i.e: getCPUInfo)
• Add Windows-exclusive commands
  • Since some commands are Unix-exclusive