yetangitu/ghidra
1
0
Fork 0
mirror of https://github.com/NationalSecurityAgency/ghidra.git synced 2025-10-05 19:42:36 +02:00
Code Issues Releases Wiki Activity

GP-0: More PyGhidra doc updates

Browse source
This commit is contained in:
Ryan Kurtz 2025-01-06 17:47:26 -05:00
parent 991a784571
commit cfffcf0c13
1 changed files with 9 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

12
Ghidra/Features/PyGhidra/src/main/py/README.md
View file

@ -8,9 +8,9 @@ setting up analysis on a given sample and running a Ghidra script locally. It al
plugin to allow the use of CPython 3 from the Ghidra GUI.
## Installation and Setup
Ghidra provides an out-of-the box integraton with the PyGhidra Python library which makes
installation and usage fairly straighforward. This enables the Ghidra GUI and headless Ghidra to run
GhidraScript's written in native CPython 3, as well as interact with the Ghidra GUI through a
Ghidra provides an out-of-the box integration with the PyGhidra Python library which makes
installation and usage fairly straightforward. This enables the Ghidra GUI and headless Ghidra to
run GhidraScript's written in native CPython 3, as well as interact with the Ghidra GUI through a
built-in REPL. To launch Ghidra in PyGhidra-mode, see Ghidra's latest
[Installation Guide](https://github.com/NationalSecurityAgency/ghidra/blob/master/GhidraDocs/InstallationGuide.md#pyghidra-mode).
@ -28,6 +28,12 @@ To install the PyGhidra Python library:
* Online: `pip install pyghidra`
* Offline: `python3 -m pip install --no-index -f
<GhidraInstallDir>/Ghidra/Features/PyGhidra/pypkg/dist pyghidra`
Optionally, you can also install the Ghidra type stubs to improve your development experience
(assuming your Python editor supports it). The type stubs module is specific to each version of
Ghidra:
* Online: `pip install ghidra-stubs==<version>`
* Offline: `python3 -m pip install --no-index -f <GhidraInstallDir>/docs/ghidra_stubs ghidra-stubs`
## API
The current version of PyGhidra inherits an API from the original "Pyhidra" project that provides an