rudism
/
sicli
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

updated readme

This commit is contained in:
Rudis Muiznieks 2024-06-13 17:07:05 -05:00
parent 8fdd8176fa
commit 50baaadfbc
Signed by: rudism
GPG Key ID: CABF2F86EF7884F9
1 changed files with 20 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -1,8 +1,21 @@
## System Information CLI
# sicli: System Information CLI
Simple CLI to retrieve CPU, memory, and disk usage details as percentages.
### CPU usage
## 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
Prints the total usage across all cores as a percentage, then the number of cores, then the usage of each core as a percentage.
@ -11,7 +24,7 @@ Prints the total usage across all cores as a percentage, then the number of core
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
```
### Hard drive usage
### Hard drive
Prints the total usage as a percentage, the total disk size, then the total available space.
@ -20,7 +33,7 @@ Prints the total usage as a percentage, the total disk size, then the total avai
63.0 1.968 0.728
```
### Memory usage
### Memory
Prints the total usage as a percentage, the total memory, then the available memory.
@ -34,6 +47,9 @@ Prints the total usage as a percentage, the total memory, then the available mem
Passing `--include-icons` as the first argument will precede each usage value with a Unicode bar glyph as a visual approximation of the percentage.
```
> 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
> sicli -i disk -r /home -u tb -p 1 -z 3
▅ 63.0 1.968 0.728