--replace example in symbex --help, refs #31

simonw · Jun 29, 2023 · ccc55da · ccc55da
1 parent 3f474c5
commit ccc55da
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -395,6 +395,12 @@ Usage: symbex [OPTIONS] [SYMBOLS]...
       # Count the number of --async functions in the project
       symbex --async --count
 
+      # Replace my_function with a new implementation:
+      echo "def my_function(a, b):
+          # This is a replacement implementation
+          return a + b + 3
+      " | symbex my_function --replace
+
 Options:
   --version                  Show the version and exit.
   -f, --file FILE            Files to search

diff --git a/symbex/cli.py b/symbex/cli.py
@@ -213,6 +213,13 @@ def cli(
     \b
         # Count the number of --async functions in the project
         symbex --async --count
+
+    \b
+        # Replace my_function with a new implementation:
+        echo "def my_function(a, b):
+            # This is a replacement implementation
+            return a + b + 3
+        " | symbex my_function --replace
     """
     if modules:
         module_dirs = []