Merge pull request #28 from FuzzingLabs/feat/detectors-help

Add a flag to list all available detectors

Author: Rog3rSm1th

README.md

@@ -98,6 +98,9 @@ cargo run -- -f ./examples/sierra/fib_unary.sierra --callgraph --function 'examp
 
 ```
 cargo run -- -f ./examples/sierra/fib_array.sierra  -d
+
+// Print all available detectors with their description  
+cargo run -- --detector-help
 ```
 
 <p align="center">

bin/sierra-decompiler/src/main.rs

@@ -72,12 +72,22 @@ struct Args {
     /// Run sierra-analyzer in a repo that uses Scarb
     #[clap(long)]
     scarb: bool,
+
+    /// List all available detector names
+    #[clap(long)]
+    detector_help: bool,
 }
 
 #[tokio::main]
 async fn main() {
     let args = Args::parse();
 
+    // Handle the --detector-help flag
+    if args.detector_help {
+        print_available_detectors();
+        return;
+    }
+
     // Ensure either remote, Sierra file, or scarb is provided
     if args.remote.is_empty() && args.sierra_file.is_none() && !args.scarb {
         eprintln!("Error: Either remote, Sierra file, or --scarb flag must be provided");
@@ -377,3 +387,17 @@ fn handle_detectors(decompiler: &mut Decompiler, detector_names: Vec<String>) {
         println!("{}", output.trim());
     }
 }
+
+/// Print all available detector names with their types and descriptions
+fn print_available_detectors() {
+    let detectors = get_detectors();
+    println!("Available detectors:");
+    for detector in detectors {
+        println!(
+            "- [{}] {} : {}",
+            detector.detector_type().as_str(),
+            detector.id(),
+            detector.description()
+        );
+    }
+}