lycheex-client/README.md

System configuration and device management utilities

# lycheex-system

A comprehensive system configuration and device management utilities library for Node.js applications.

## Features

- 🔧 **System Configuration Management**: Easy-to-use configuration management for Node.js applications
- 📱 **Device Information Detection**: Retrieve detailed device and system information
- 🔒 **Secure Configuration Storage**: Encrypted configuration storage with AES-256-GCM
- 🌐 **Remote Configuration Sync**: Synchronize configurations with remote servers
- 📊 **Machine Fingerprinting**: Generate unique device identifiers for configuration binding
- ⚙️ **Cross-Platform Support**: Works on Windows, macOS, and Linux

### SystemConfigClient

#### Constructor

```javascript
const client = new SystemConfigClient(options);
```

#### Methods

##### `configure(configCode?)`

Configure the system with a configuration code.

##### `checkStatus()`

Check the current system configuration status.

##### `generateMachineCode()`

Generate a unique machine identifier for the current device.

##### `getMachineInfo()`

Get detailed information about the current machine.

##### `disable(reason?)`

Disable the current system configuration.

## Device Information

The library provides detailed device information including:

- Operating System details
- CPU information
- Memory specifications
- Platform and architecture
- Node.js version

## Security Features

- **AES-256-GCM Encryption**: All configuration data is encrypted
- **RSA Digital Signatures**: Verify configuration integrity
- **Machine Code Binding**: Configurations are bound to specific devices
- **Secure Key Management**: Public/private key infrastructure

## Cross-Platform Support

Tested and supported on:

- Windows 10/11
- macOS (Intel and Apple Silicon)
- Linux (Ubuntu, CentOS, Debian)

## Contributing

This is a proprietary library. For support or feature requests, please contact the development team.

## License

Proprietary - All rights reserved