-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
147 lines (122 loc) · 3.63 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Peekaboo</title>
<style>
body {
font-family: Arial, sans-serif;
margin: 0;
padding: 25px;
background-color: #0f0f0f;
color: #f1f1f1;
}
.container {
max-width: 800px;
margin: 20px auto;
padding: 20px;
background: white;
box-shadow: 0 0 10px rgba(0, 0, 0, 0.1);
}
h1, h2, h3 {
color: #00bec4;
}
h4, h5, h6 {
color: #25c2a0;
}
pre {
background: #333;
color: white;
padding: 10px;
overflow-x: auto;
}
code {
background: #242526;
color: #25c2a0;
padding: 2px 4px;
}
blockquote {
border-left: 4px solid #25c2a0;
padding-left: 10px;
color: #f08d49;
margin: 20px 0;
}
</style>
</head>
<body>
<h1>Peekaboo Docs</h1>
<p>Peekaboo is a <strong>System Monitoring CLI tool</strong> built in Rust. It allows you to monitor various system parameters such as CPU usage, memory usage, disk usage, and network usage.</p>
<p><img src="./assets/system.png" alt="Peekaboo" /></p>
<h2>Features</h2>
<ul>
<li>Monitor CPU usage</li>
<li>Monitor memory usage</li>
<li>Monitor disk usage</li>
<li>Monitor network usage</li>
<li>Save and display user names</li>
</ul>
<h2>Installation</h2>
<ol>
<li><p>Clone the repository:
<code>
git clone https://github.com/ashmit0920/Peekaboo.git
</code></p></li>
<li><p>Extract the cloned directory, and add it to your environment's <code>PATH</code> variable for easy access:</p>
<ol>
<li>Search for "Edit environment variables" in your Windows Search bar and click on the search result.</li>
<li>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".</li>
<li>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".</li>
<li>(For older Windows) If you didn't see a pop-up table, it is time to change your computer.</li>
</ol></li>
</ol>
<h2>Usage</h2>
<ul>
<li>To display the help menu:
<code>
peek -h
</code></li>
<li><p>To store a user name:
<code>
peek --name <name>
</code>
The user name will be stored and will be displayed on subsequent runs.</p></li>
<li><p>To display system information
<code>
peek -s
</code></p></li>
<li><p>To monitor CPU usage:
<code>
peek -c
</code></p></li>
<li><p>To monitor memory usage:
<code>
peek -m
</code></p></li>
<li><p>To monitor disk usage:
<code>
peek -d
</code></p></li>
<li><p>To monitor network usage:
<code>
peek -n
</code></p></li>
<li><p>To monitor all of the above at once:
<code>
peek --showall
</code></p></li>
</ul>
<blockquote>
The monitored stats currently dont refresh on their own. Run the commands again to get new stats.
</blockquote>
<h2>Examples</h2>
<h4>CPU Usage:</h4>
<p><img src="./assets/cpu.png" alt="CPU usage" /></p>
<h4>Memory and Disk usage:</h4>
<p><img src="./assets/memory%20and%20disk.png" alt="Memory and Disk usage" /></p>
<h4>Network usage:</h4>
<p><img src="./assets/network.png" alt="Network Usage" /></p>
<h4>Show all parameters</h4>
<p><img src="./assets/showall.png" alt="Show all" /></p>
</body>
</html>