https://github.com/aspedm/spci-libs

The project consists of a set of libraries for obtaining system information.
https://github.com/aspedm/spci-libs

cross-platform library linux macos nodejs npm-package ram system system-information systeminfo systeminformation typescript usb windows

Last synced: 15 days ago
JSON representation

The project consists of a set of libraries for obtaining system information.

• Host: GitHub
• URL: https://github.com/aspedm/spci-libs
• Owner: Aspedm
• License: mit
• Created: 2024-03-05T19:13:07.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-03-26T18:46:56.000Z (8 months ago)
• Last Synced: 2024-04-29T09:01:38.637Z (7 months ago)
• Topics: cross-platform, library, linux, macos, nodejs, npm-package, ram, system, system-information, systeminfo, systeminformation, typescript, usb, windows
• Language: TypeScript
• Homepage:
• Size: 240 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# spci-libs

[![NPM](https://img.shields.io/badge/NPM-%23CB3837.svg?style=for-the-badge&logo=npm&logoColor=white)](https://www.npmjs.com/package/spci-libs)

![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white)

![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black)

![macOS](https://img.shields.io/badge/mac%20os-000000?style=for-the-badge&logo=macos&logoColor=F0F0F0)

![Windows](https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white)

### About

The project consists of a set of libraries for obtaining system information. Each library includes a collection of methods designed to gather various parameters and characteristics of the system.

> This project doesn't include all parts of the system. If you want more info about the system, i suggest using [systeminformation](https://github.com/sebhildebrandt/systeminformation).

### Supported modules

#### USB

- The documentation for USB devices can be found [here](https://github.com/Aspedm/spci-libs/blob/main/src/system/usb/README.md)

#### RAM

- The documentation for RAM can be found [here](https://github.com/Aspedm/spci-libs/blob/main/src/system/ram/README.md)

#### PCI

- The documentation for PCI devices can be found [here](https://github.com/Aspedm/spci-libs/blob/main/src/system/pci/README.md)

#### Wallpapers

- The documentation for RAM can be found [here](https://github.com/Aspedm/spci-libs/blob/main/src/system/wallpaper/README.md)

### Install

```sh

yarn install spci-libs

```

### Usage in code

```ts

import { Usb } from 'spci-libs';

const myUsbDevices = async() => {

    const usb = new Usb();

    const devices = await usb.getDevices();

    console.log(devices);

};

```

### Usage in terminal

1. Install dependencies ```yarn```

2. Build lib ```yarn build```

3. Run playground ```yarn start```

### License

Further details see [LICENSE](LICENSE) file.

### Contact

If you have any questions, suggestions, or issues, please create an issue in the GitHub repository or contact me at [[email protected]](mailto:[email protected]).

### Credits

A big thanks to:

- [systeminformation](https://github.com/sebhildebrandt/systeminformation) - Library based and inspired on systeminformation