doc: update documentation with interactive shell functionality

Signed-off-by: Manu Bretelle <chantr4@gmail.com>
danobi · Jan 31, 2024 · c7c84d3 · c7c84d3
1 parent fe8285a
commit c7c84d3
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -103,6 +103,14 @@ $ vmtest -k ./kernels/Image-arm64 -r ./rootfs/ubuntu-lunar-arm64 -a aarch64 "una
 6.6.0-rc5-ga4a0c99f10ca-dirty
 ```
 
+It is also possible to get an interactive shell prompt in the guest by using the command `-`:
+```
+vmtest -k ./bzImage-v6.2 "-"
+...
+...
+root@(none):/#
+```
+
 See `vmtest --help` for all options and flags.
 
 ### Config file interface

diff --git a/src/main.rs b/src/main.rs
@@ -38,6 +38,7 @@ struct Args {
     /// Arch to run
     #[clap(short, long, default_value = ARCH, conflicts_with = "config")]
     arch: String,
+    /// Command to run in kernel mode. `-` to get an interactive shell.
     #[clap(conflicts_with = "config")]
     command: Vec<String>,
 }