Peekaboo Docs

Peekaboo is a System Monitoring CLI tool built in Rust. It allows you to monitor various system parameters such as CPU usage, memory usage, disk usage, and network usage.

Features

• Monitor CPU usage
• Monitor memory usage
• Monitor disk usage
• Monitor network usage
• Save and display user names

Installation

1. Clone the repository: git clone https://github.com/ashmit0920/Peekaboo.git

2. Extract the cloned directory, and add it to your environment's PATH variable for easy access:

   1. Search for "Edit environment variables" in your Windows Search bar and click on the search result.
   2. Under "System Variables" (for all users), select "Path" => "Edit". In case you lack the permissions to edit System variables, just edit the Path variable under "User Variables".
   3. A table pops up showing the directories included in the current PATH. Click on "New" ⇒ "Browse..." to select the cloned Peekaboo directory. Click on ⇒ "OK" (Don't "Cancel") ⇒ "OK" ⇒ "OK".
   4. (For older Windows) If you didn't see a pop-up table, it is time to change your computer.

Usage

• To display the help menu: peek -h

• To store a user name: peek --name <name> The user name will be stored and will be displayed on subsequent runs.

• To display system information peek -s

• To monitor CPU usage: peek -c

• To monitor memory usage: peek -m

• To monitor disk usage: peek -d

• To monitor network usage: peek -n

• To monitor all of the above at once: peek --showall

The monitored stats currently dont refresh on their own. Run the commands again to get new stats.

Examples

CPU Usage:

Memory and Disk usage:

Network usage:

Show all parameters