|
| 1 | +# goasitop |
| 2 | + |
| 3 | +`goasitop` is a terminal-based monitoring tool designed to display real-time power metrics for Apple Silicon chips. It provides a simple and efficient way to monitor CPU and GPU usage, E-Cores and P-Cores, power consumption, and other system metrics directly from your terminal. |
| 4 | + |
| 5 | + |
| 6 | + |
| 7 | +## Features |
| 8 | + |
| 9 | +- Apple Silicon Monitor Top written in Go Lang (Under 1,000 lines of code) |
| 10 | +- Real-time CPU and GPU power usage display. |
| 11 | +- Detailed metrics for different CPU clusters (E-Cores and P-Cores). |
| 12 | +- Memory usage and swap information. |
| 13 | +- Easy-to-read terminal UI |
| 14 | +- Support for all Apple Silicon models. |
| 15 | + |
| 16 | +## Known Bugs |
| 17 | + |
| 18 | +- Cannot exit cleanly with Ctrl + C etc. must kill terminal process for goasitop exit. |
| 19 | + |
| 20 | +## Installation |
| 21 | + |
| 22 | +To install `goasitop`, follow these steps: |
| 23 | + |
| 24 | +1. Ensure you have Go installed on your machine. If not, you can install it by following the instructions here: [Go Installation Guide](https://go.dev/doc/install). |
| 25 | + |
| 26 | +2. Clone the repository: |
| 27 | + ```bash |
| 28 | + git clone https://github.com/context-labs/goasitop.git |
| 29 | + cd goasitop |
| 30 | + ``` |
| 31 | + |
| 32 | +3. Build the application: |
| 33 | + ```bash |
| 34 | + go build |
| 35 | + ``` |
| 36 | + |
| 37 | +4. Run the application: |
| 38 | + ```bash |
| 39 | + ./goasitop |
| 40 | + ``` |
| 41 | + |
| 42 | +## Usage |
| 43 | + |
| 44 | +After installation, you can start `goasitop` by simply running: |
| 45 | +```bash |
| 46 | +./goasitop |
| 47 | +``` |
| 48 | + |
| 49 | +Use the following keys to interact with the application: |
| 50 | +- `q`: Quit the application. |
| 51 | +- `r`: Refresh the data manually. |
| 52 | + |
| 53 | +## Contributing |
| 54 | + |
| 55 | +Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. |
| 56 | + |
| 57 | +1. Fork the Project |
| 58 | +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) |
| 59 | +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) |
| 60 | +4. Push to the Branch (`git push origin feature/AmazingFeature`) |
| 61 | +5. Open a Pull Request |
| 62 | + |
| 63 | +## License |
| 64 | + |
| 65 | +Distributed under the MIT License. See `LICENSE` for more information. |
| 66 | + |
| 67 | +## Contact |
| 68 | + |
| 69 | +Carsen Klock - [@carsenklock](https://twitter.com/carsenklock) |
| 70 | + |
| 71 | +Project Link: [https://github.com/context-labs/goasitop](https://github.com/context-labs/goasitop) |
| 72 | + |
| 73 | +## Acknowledgements |
| 74 | + |
| 75 | +- [termui](https://github.com/gizak/termui) for the terminal UI framework. |
| 76 | +- [gopsutil](https://github.com/shirou/gopsutil) for system memory monitoring. |
| 77 | +``` |
0 commit comments