sicli/README.md

59 lines
1.5 KiB
Markdown
Raw Normal View History

2024-06-13 17:07:05 -05:00
# sicli: System Information CLI
2024-06-13 17:02:58 -05:00
Simple CLI to retrieve CPU, memory, and disk usage details as percentages.
2024-06-13 17:07:05 -05:00
## Installing
Just clone, build, and copy the binary somewhere on your path. For example:
```
git clone https://code.sitosis.com/rudism/sicli.git
cd sicli
cargo build --release
sudo cp target/release/sicli /usr/bin/
```
## Example Usage
### CPU
2024-06-13 17:02:58 -05:00
Prints the total usage across all cores as a percentage, then the number of cores, then the usage of each core as a percentage.
```
> sicli cpu --delay-ms 250 --precision 1
1.2 16 0.0 3.8 0.0 0.0 0.0 0.0 0.0 4.0 0.0 0.0 0.0 7.4 3.8 0.0 0.0 0.0
```
2024-06-13 17:07:05 -05:00
### Hard drive
2024-06-13 17:02:58 -05:00
Prints the total usage as a percentage, the total disk size, then the total available space.
```
> sicli disk --root /home --unit tb --usage-precision 1 --size-precision 3
63.0 1.968 0.728
```
2024-06-13 17:07:05 -05:00
### Memory
2024-06-13 17:02:58 -05:00
Prints the total usage as a percentage, the total memory, then the available memory.
```
> sicli memory --unit gib --usage-precision 1 --size-precision 2
29.4 30.70 21.68
```
### Unicode icons
Passing `--include-icons` as the first argument will precede each usage value with a Unicode bar glyph as a visual approximation of the percentage.
```
2024-06-13 17:07:05 -05:00
> sicli -i cpu
░ 1.8 16 ░ 4.8 ░ 0.0 ░ 0.0 ░ 0.0 ░ 0.0 ░ 0.0 ░ 0.0 ░ 5.0 ░ 0.0 ░ 0.0 ░ 0.0 ░ 4.8 ░ 0.0 ░ 9.5 ░ 0.0 ░ 4.8
2024-06-13 17:02:58 -05:00
> sicli -i disk -r /home -u tb -p 1 -z 3
▅ 63.0 1.968 0.728
> sicli --include-icons memory --unit gib --usage-precision 1 --size-precision 2
▂ 29.4 30.70 21.68
```