diff options
| author | Jordan Wiens <github@psifertex.com> | 2026-03-03 13:22:53 -0500 |
|---|---|---|
| committer | Jordan Wiens <github@psifertex.com> | 2026-03-03 13:22:53 -0500 |
| commit | 585882cd807d052535054f9d7b20e4ff4da176a1 (patch) | |
| tree | b8f5915ab1806f5bfc40205c344bc76ed419ec09 /docs | |
| parent | 47c90e940e7c3eb61c5a5a3a9702ebe7cd0ea27c (diff) | |
add examples about triggering binexport headlessly
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/dev/batch.md | 9 | ||||
| -rw-r--r-- | docs/guide/binexport.md | 9 |
2 files changed, 18 insertions, 0 deletions
diff --git a/docs/dev/batch.md b/docs/dev/batch.md index ab7e1830..63772105 100644 --- a/docs/dev/batch.md +++ b/docs/dev/batch.md @@ -49,6 +49,15 @@ Note that we used the `load` method which lets you temporarily create a `bv` wit bv.file.close() #close the file handle or else leak memory ``` +### Triggering Actions + +While you might associate actions with UI based actions in the product, many actions can be triggered headlessly. For example: + +```python +cxt = PluginCommandContext(bv) +PluginCommand.get_valid_list(cxt)['BinExport (Quick)'].execute(cxt) +``` + ### Multiple files Looks good! But what if we just want to parse basic headers or stop any major analysis from happening and scan multiple files quickly? We can use the `update_analysis` named parameter to prevent the usual linear sweep and recursive descent analysis from event occurring: diff --git a/docs/guide/binexport.md b/docs/guide/binexport.md index 9e02c9c3..f5de5765 100644 --- a/docs/guide/binexport.md +++ b/docs/guide/binexport.md @@ -37,6 +37,15 @@ The resulting `.BinDiff` file can either be opened in the BinDiff Java GUI, or d { width="800" } _BD Viewer Plugin_ +### Headless + +If you want to trigger the plugin headlessly, you can use the exposed quick action which will automatically write a `.BinExport` in the same folder as the source file: + +```python +cxt = PluginCommandContext(bv) +PluginCommand.get_valid_list(cxt)['BinExport (Quick)'].execute(cxt) +``` + ### Disabling If desired, the plugin can be disabled from loading using the `corePlugins.binexport` setting. |
