Improve documentation at the CLI level

omarmhaimdat · omarmhaimdat · commit b8ffa702caa9 · 2025-02-12T20:57:13.000+01:00
Fix cleaning terminal when restarting the run

Add more info in the header
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 /target
 Cargo.lock
 build.sh
+linux_build.sh
 homebrew
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "pepe"
-version = "0.2.1"
+version = "0.2.2"
 authors = ["Omar MHAIMDAT"]
 edition = "2021"
 description = "HTTP load generator and performance testing tool"
diff --git a/install.sh b/install.sh
@@ -19,7 +19,7 @@ if [ "$(uname)" = "Darwin" ]; then
         echo "pepe installed successfully using Homebrew!"
     else
         echo "Homebrew not found, downloading pepe for macOS..."
-        curl -L -o pepe "https://pepe.mhaimdat.com/0.2.0/$(uname -m)-apple-darwin/pepe"
+        curl -L -o pepe "https://pepe.mhaimdat.com/0.2.1/$(uname -m)-apple-darwin/pepe"
         chmod +x pepe
         mv pepe /usr/local/bin/
         echo "pepe for macOS downloaded and installed successfully!"
@@ -53,8 +53,8 @@ elif [ "$(uname -s)" = "Linux" ]; then
     cd "$TEMP_DIR"
     
     echo "Downloading binary..."
-    curl -L -O "https://pepe.mhaimdat.com/0.2.0/x86_64-unknown-linux-gnu/pepe"
-    curl -L -O "https://pepe.mhaimdat.com/0.2.0/x86_64-unknown-linux-gnu/pepe.sha256"
+    curl -L -O "https://pepe.mhaimdat.com/0.2.1/x86_64-unknown-linux-gnu/pepe"
+    curl -L -O "https://pepe.mhaimdat.com/0.2.1/x86_64-unknown-linux-gnu/pepe.sha256"
     
     echo "Verifying binary integrity..."
     EXPECTED_CHECKSUM=$(cat pepe.sha256)
diff --git a/src/main.rs b/src/main.rs
@@ -1,12 +1,9 @@
 use clap::{ArgAction::HelpLong, Parser};
 use crossterm::{
-    cursor::{Hide, Show},
+    cursor::Show,
     event::KeyCode,
     execute,
-    terminal::{
-        disable_raw_mode, enable_raw_mode, Clear, ClearType, EnterAlternateScreen,
-        LeaveAlternateScreen,
-    },
+    terminal::{disable_raw_mode, enable_raw_mode, LeaveAlternateScreen},
 };
 use curl_parser;
 use hyper::{HeaderMap, Uri};
@@ -26,25 +23,47 @@ mod ui;
 // #[command(long_about = USAGE)]
 #[clap(disable_help_flag = true)]
 struct Args {
-    #[arg(long, action = HelpLong)]
+    #[arg(short, long, action = HelpLong)]
     help: Option<bool>,
-    #[clap(short = 'n', long, default_value = "100")]
+    #[clap(short = 'n', long, default_value = "100", help = "Number of requests")]
     number: u32,
-    #[clap(short = 'c', long, default_value_t = default_concurrency())]
+    #[clap(short = 'c', long, default_value_t = default_concurrency(), help = "Number of concurrent requests")]
     concurrency: u32,
-    #[clap(short = 'q', long, default_value = "0")]
+    #[clap(
+        short = 'q',
+        long,
+        default_value = "0",
+        help = "Number of requests to perform before exiting"
+    )]
     rate_limit: u32,
     #[clap(short = 'z', long)]
     duration: Option<String>,
     #[clap(short = 'o', long)]
     output: Option<String>,
-    #[clap(long = "curl", help = "Curl command to convert to HTTP request")]
+    #[clap(
+        long = "curl",
+        help = "Curl mode to parse curl command, e.g. pepe --curl -- 'curl -X POST http://localhost:8080'"
+    )]
     curl: bool,
-    #[clap(short = 'm', long, default_value = "GET")]
+    #[clap(
+        short = 'm',
+        long,
+        default_value = "GET",
+        help = "HTTP method, e.g. GET, POST, PUT, DELETE"
+    )]
     method: String,
-    #[clap(short = 'H', long)]
+    #[clap(
+        short = 'H',
+        long,
+        help = "HTTP headers, e.g. -H 'Accept: application/json'"
+    )]
     headers: Vec<String>,
-    #[clap(short = 't', long, default_value = "20")]
+    #[clap(
+        short = 't',
+        long,
+        default_value = "20",
+        help = "Time in seconds to wait for a response"
+    )]
     timeout: u32,
     #[clap(short = 'A', long)]
     accept: Option<String>,
@@ -54,7 +73,7 @@ struct Args {
     body_file: Option<String>,
     #[clap(short = 'T', long, default_value = "text/html")]
     content_type: String,
-    #[clap(short, long, default_value = concat!("pepe/", env!("CARGO_PKG_VERSION")))]
+    #[clap(short, long, default_value = concat!("pepe/", env!("CARGO_PKG_VERSION")), help = "User-Agent string, default is pepe/{version}")]
     user_agent: String,
     #[clap(short, long)]
     basic_auth: Option<String>,
@@ -72,7 +91,7 @@ struct Args {
     disable_keepalive: bool,
     #[clap(long)]
     disable_redirects: bool,
-    #[clap(default_value = "")]
+    #[clap(default_value = "", help = "URL to request")]
     url: String,
     #[clap(last = true, default_value = "")]
     args: Vec<String>,
@@ -118,7 +137,6 @@ impl Args {
                 })
                 .collect::<Vec<_>>()
                 .join(" ");
-            println!("Curl command: {}", curl_command);
             let parsed_request = curl_parser::ParsedRequest::load(&curl_command, Some(()));
             if parsed_request.is_err() {
                 eprintln!("Error: {}", parsed_request.err().unwrap());
@@ -471,7 +489,6 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
 
     enable_raw_mode()?;
     let mut stdout = stdout();
-    execute!(stdout, EnterAlternateScreen, Clear(ClearType::All), Hide)?;
 
     let interrupted = Arc::new(tokio::sync::Notify::new());
 
diff --git a/src/ui.rs b/src/ui.rs
@@ -164,6 +164,8 @@ impl Dashboard {
         enable_raw_mode()?;
         let mut terminal = Terminal::new(CrosstermBackend::new(std::io::stdout()))?;
 
+        terminal.clear()?;
+
         loop {
             // Update stats
             while let Ok(stat) = rx.try_recv() {
@@ -188,6 +190,7 @@ impl Dashboard {
                             | KeyCode::Enter
                             | KeyCode::Char('i')
                     ) {
+                        terminal.clear()?;
                         return Ok(key.code);
                     }
                 }
@@ -345,7 +348,8 @@ impl Dashboard {
             .direction(Direction::Horizontal)
             .constraints([
                 Constraint::Percentage(20),
-                Constraint::Percentage(20),
+                Constraint::Percentage(10),
+                Constraint::Percentage(10),
                 Constraint::Percentage(60),
             ])
             .split(area);
@@ -356,7 +360,43 @@ impl Dashboard {
                 .unwrap_or(NonZeroUsize::new(8).unwrap_or(default_n_threads))
                 .get();
         }
+
         // Logo section
+        f.render_widget(
+            Paragraph::new(LOGO)
+                .style(Style::default().fg(Color::Cyan))
+                .block(Block::default().borders(Borders::ALL)),
+            chunks[0],
+        );
+
+        // Commands section
+        let commands: Vec<Line<'_>> = vec![
+            Line::from(vec![
+                Span::styled("Quit: ", Style::default().fg(Color::Yellow)),
+                Span::raw("q"),
+            ]),
+            Line::from(vec![
+                Span::styled("Restart: ", Style::default().fg(Color::Yellow)),
+                Span::raw("r"),
+            ]),
+            Line::from(vec![
+                Span::styled("Interrupt: ", Style::default().fg(Color::Yellow)),
+                Span::raw("i"),
+            ]),
+        ];
+
+        f.render_widget(
+            Paragraph::new(commands).block(
+                Block::default()
+                    .title("Commands")
+                    .borders(Borders::ALL)
+                    .style(Style::default().fg(Color::Cyan))
+                    .title_style(Style::default().fg(Color::White)),
+            ),
+            chunks[1],
+        );
+
+        // Info section
         let version_info = vec![
             Line::from(vec![
                 Span::styled("Version: ", Style::default().fg(Color::Yellow)),
@@ -378,15 +418,12 @@ impl Dashboard {
                 Span::styled("Cores: ", Style::default().fg(Color::Yellow)),
                 Span::raw(n_threads.to_string()),
             ]),
+            Line::from(vec![
+                Span::styled("PID: ", Style::default().fg(Color::Yellow)),
+                Span::raw(std::process::id().to_string()),
+            ]),
         ];
 
-        f.render_widget(
-            Paragraph::new(LOGO)
-                .style(Style::default().fg(Color::Cyan))
-                .block(Block::default().borders(Borders::ALL)),
-            chunks[0],
-        );
-
         f.render_widget(
             Paragraph::new(version_info)
                 .block(
@@ -396,7 +433,7 @@ impl Dashboard {
                         .title_style(Style::default().fg(Color::White)),
                 )
                 .style(Style::default().fg(Color::Cyan)),
-            chunks[1],
+            chunks[2],
         );
 
         // Parameters section
@@ -417,6 +454,10 @@ impl Dashboard {
                 Span::styled("Total Requests: ", Style::default().fg(Color::Yellow)),
                 Span::raw(self.args.number.to_string()),
             ]),
+            Line::from(vec![
+                Span::styled("Timeout: ", Style::default().fg(Color::Yellow)),
+                Span::raw(self.args.timeout.to_string()),
+            ]),
         ];
 
         f.render_widget(
@@ -427,7 +468,7 @@ impl Dashboard {
                     .style(Style::default().fg(Color::Cyan))
                     .title_style(Style::default().fg(Color::White)),
             ),
-            chunks[2],
+            chunks[3],
         );
     }
 
@@ -618,7 +659,7 @@ impl Dashboard {
         self.render_stat_widget(
             f,
             stats_chunks[1],
-            "RPS",
+            "Request per Second",
             self.stats.rps.to_string(),
             Color::Magenta,
         );
