https://github.com/dmontgomery40/nputop-ts
TypeScript version of nputop - Intel NPU monitoring tool
https://github.com/dmontgomery40/nputop-ts
Last synced: about 1 month ago
JSON representation
TypeScript version of nputop - Intel NPU monitoring tool
- Host: GitHub
- URL: https://github.com/dmontgomery40/nputop-ts
- Owner: DMontgomery40
- License: mit
- Created: 2024-12-15T16:14:04.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-15T16:19:20.000Z (over 1 year ago)
- Last Synced: 2025-03-14T15:57:30.315Z (about 1 year ago)
- Language: TypeScript
- Size: 6.84 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nputop-ts
**Status:** Pre-alpha prototype — expect incomplete features, rough edges, and limited functionality.
TypeScript version of nputop - A monitoring tool for Intel NPU (Neural Processing Unit). This is a TypeScript port of the original [nputop](https://github.com/DMontgomery40/nputop) Python tool.
## ⚠️ Important Warning
This is an experimental prototype and is **NOT PRODUCTION READY**. Use at your own risk and expect:
- Incomplete features
- Potential bugs
- Limited error handling
- Possible system-specific issues
## Acknowledgements
This project was inspired by and based on code from [ZoLArk173/nputop](https://github.com/ZoLArk173/nputop). Thanks for the inspiration and groundwork!
## Features
- Real-time monitoring of Intel NPU metrics
- Power consumption tracking
- Temperature monitoring
- Utilization visualization with ASCII graphics
- TypeScript implementation for better type safety and developer experience
## Prerequisites
- Node.js (v14 or higher)
- npm (comes with Node.js)
- Access to Intel NPU sysfs interface
## Installation
```bash
# Clone the repository
git clone https://github.com/DMontgomery40/nputop-ts.git
cd nputop-ts
# Install dependencies
npm install
# Build the TypeScript code
npm run build
```
## Usage
```bash
# Run the monitoring tool
npm start
```
## Development
```bash
# Watch for changes and rebuild automatically
npm run build -- --watch
```
## Docker Support
The tool can be run in a Docker container:
```bash
# Build and run with Docker Compose
docker-compose up --build
# Or using Docker directly
docker build -t nputop-ts .
docker run -it nputop-ts
```
## Structure
- `index.ts` - Main application entry point
- `npu_usage_graph.ts` - ASCII graph visualization component
- `tsconfig.json` - TypeScript configuration
- `Dockerfile` & `docker-compose.yml` - Container configuration
## License
MIT