diff options
| author | Jordan Wiens <jordan@psifertex.com> | 2021-11-09 13:22:15 -0500 |
|---|---|---|
| committer | Jordan Wiens <jordan@psifertex.com> | 2021-11-09 13:22:15 -0500 |
| commit | c90a6d5840490a375e7e9484674c36722aab1394 (patch) | |
| tree | 50851c38a89e15cc66e620e3b23611d2a436be20 /docs | |
| parent | f9851f115b501add28b5b849821dd0525d82e960 (diff) | |
update startup.py docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/getting-started.md | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/getting-started.md b/docs/getting-started.md index dfae1d22..a5e5f56b 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -33,6 +33,7 @@ Contents of the user folder includes: - `plugins/`: Folder containing all manually installed user plugins - `repositories/`: Folder containing files and plugins managed by the [Plugin Manager API](https://api.binary.ninja/binaryninja.pluginmanager-module.html) - `settings.json`: User settings file (see [settings](#settings)) +- `startup.py`: Default python commands run once the UI is loadedd in the context of the scripting console - `keybindings.json`: Custom key bindings (see [key bindings](#custom-hotkeys))  @@ -508,14 +509,14 @@ The interactive python prompt also has several built-in functions and variables: - `write_at_cursor(data)`: function that writes data to the start of the current selection - `get_selected_data()`: function that returns the data in the current selection -The python interpreter can be customized to run scripts on startup using `startup.py` in your user folder. Simply enter commands into that file, and they will be executed every time Binary Ninja starts. By default, it comes with an import and debug helpers: +#### `startup.py` -**startup.py** +The python interpreter can be customized to run scripts on startup using `startup.py` in your user folder. Simply enter commands into that file, and they will be executed every time Binary Ninja starts. By default, it comes with an import helper: # Commands in this file will be run in the interactive python console on startup from binaryninja import * -From here, you can add any custom functions or objects you want to be available in the console. If you want to restore the original copy of `startup.py` at any time, simply delete the file and restart Binary Ninja. A fresh copy of the above will be generated for you in `startup.py`. +From here, you can add any custom functions or objects you want to be available in the console. If you want to restore the original copy of `startup.py` at any time, simply delete the file and restart Binary Ninja. A fresh copy of the above will be generated. #### Python Debugging See the [plugin development guide](dev/plugins.md#debugging-python). |