Refactor RAPx CLI with enhanced argument parsing and help messages (#229)

* Refactor RAPx CLI

- Added Clap for command-line argument parsing, enhancing usability and consistency with Cargo.
- Introduced a new configuration module to manage command options and analysis types.
- Removed deprecated help file and integrated help messages directly into the CLI structure.
- Streamlined the analysis process by consolidating various analysis options into a unified command structure.
- Updated the main execution flow to accommodate new command parsing and analysis initiation.
- Removed unused functions and cleaned up the codebase for better maintainability.
- Enhanced logging and error handling throughout the application.

* feat: add CLI argument parsing with color-print support and enhance help messages

* remove redundant imports

* fix all tests

* update README.md

* fix typo errors

* rename config to args

* update rapx version to 0.7.0

Author: WIZeaz

README.md

@@ -35,51 +35,39 @@ rustup default nightly-2025-12-06
 Check out supported options with `-help`:
 
 ```shell
-$ cargo rapx -help
-
-Usage:
-    cargo rapx [rapx options or rustc options] -- [cargo check options]
-
-RAPx Options:
-
-Application:
-    -F or -uaf      use-after-free/double free detection.
-    -M or -mleak    memory leakage detection.
-    -O or -opt      automatically detect code optimization chances.
-    -I or -infer    (under development) infer the safety properties required by unsafe APIs.
-    -V or -verify   (under development) verify if the safety requirements of unsafe API are satisfied.
-
-Analysis:
-    -alias          perform alias analysis (meet-over-paths by default)
-    -adg            generate API dependency graphs
-    -upg            generate unsafety propagation graphs for each module.
-    -upg-std        generate unsafety propagation graphs for each module of the Rust standard library
-    -callgraph      generate callgraphs
-    -dataflow       generate dataflow graphs
-    -ownedheap      analyze if the type holds a piece of memory on heap
-    -pathcond       extract path constraints
-    -range          perform range analysis
-
-General command: 
-    -help           show help information
-    -version        show the version of RAPx
+$ cargo rapx --help
+
+Usage: cargo rapx [OPTIONS] <COMMAND> [-- [CARGO_FLAGS]]
+
+Commands:
+  analyze  perform various analyses on the crate, e.g., alias analysis, callgraph generation
+  check    check potential vulnerabilities in the crate, e.g., use-after-free, memory leak
+  help     Print this message or the help of the given subcommand(s)
+
+Options:
+      --timeout <TIMEOUT>        specify the timeout seconds in running rapx
+      --test-crate <TEST_CRATE>  specify the tested package in the workspace
+  -h, --help                     Print help
+  -V, --version                  Print version
 
 NOTE: multiple detections can be processed in single run by 
-appending the options to the arguments. Like `cargo rapx -F -M`
+appending the options to the arguments. Like `cargo rapx -f -m`
 will perform two kinds of detection in a row.
 
-e.g.
+Examples:
+
 1. detect use-after-free and memory leak for a riscv target:
-   cargo rapx -F -M -- --target riscv64gc-unknown-none-elf
+   cargo rapx check -f -m -- --target riscv64gc-unknown-none-elf
 2. detect use-after-free and memory leak for tests:
-   cargo rapx -F -M -- --tests
+   cargo rapx check -f -m -- --tests
 3. detect use-after-free and memory leak for all members:
-   cargo rapx -F -M -- --workspace
+   cargo rapx check -f -m -- --workspace
 
 Environment Variables (Values are case insensitive):
+
     RAP_LOG          verbosity of logging: trace, debug, info, warn
                      trace: print all the detailed RAP execution traces.
-                     debug: display intermidiate analysis results.
+                     debug: display intermediate analysis results.
                      warn: show bugs detected only.
 
     RAP_CLEAN        run cargo clean before check: true, false
@@ -98,7 +86,7 @@ If RAPx gets stuck after executing `cargo clean`, try manually downloading metad
 
 RAPx supports the following environment variables (values are case insensitive):
 
-| var             | default when absent | one of these values | description                  |
+| var             | default when absent | possible values     | description                  |
 |-----------------|---------------------|---------------------|------------------------------|
 | `RAP_LOG`       | info                | debug, info, warn   | verbosity of logging         |
 | `RAP_CLEAN`     | true                | true, false         | run cargo clean before check |

rapx/Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "rapx"
-version = "0.6.252"
+version = "0.7.0"
 edition = "2024"
 authors = ["Artisan-Lab <xuh@fudan.edu.cn>"]
 default-run = "rapx"
@@ -47,6 +47,10 @@ itertools = "0.14.0"
 safety-parser = "0.4.1"
 syn = { version = "2", features = ["extra-traits", "full"] }
 rust_intervals = "0.3.0"
+clap = { version = "4.5.60"}
+clap-cargo = "0.18.3"
+shlex = "1.3.0"
+color-print = "0.3.7"
 [features]
 backtraces = ["snafu/backtraces", "snafu/backtraces-impl-backtrace-crate"]
 

rapx/Cargo.toml

@@ -203,7 +203,7 @@ impl<'tcx> MopGraph<'tcx> {
     pub fn sync_field_alias(&mut self, lv: usize, rv: usize, depth: usize, clear_left: bool) {
         rap_debug!("sync field aliases for lv:{} rv:{}", lv, rv);
 
-        let max_field_depth =15;
+        let max_field_depth = 15;
 
         if depth > max_field_depth {
             return;