zjgcjy/pykd
1
0
Fork 0
mirror of https://github.com/ivellioscolin/pykd.git synced 2025-04-21 12:53:23 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Administrator 2019-08-04 15:06:28 -04:00
parent b5f56b61c9
commit c28dac3979
1 changed files with 36 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -1,4 +1,4 @@
# Pykd - python extension for WinDBG # Pykd - not only python extension for WinDBG
## Purpose ## Purpose
This project can help to automate debugging and crash dump analysis using Python. It allows one to take the best from both worlds: the expressiveness and convenience of Python with the power of WinDbg! This project can help to automate debugging and crash dump analysis using Python. It allows one to take the best from both worlds: the expressiveness and convenience of Python with the power of WinDbg!
@ -6,19 +6,36 @@ This project can help to automate debugging and crash dump analysis using Python
## Why do I need this? ## Why do I need this?
If you want to automate the debugger but dislike the WinDbg built-in script machine syntax it's time to try again using the handy and powerful Python language. Even if you don't want to create your own script, maybe some existing scripts will be of interest to you? If you want to automate the debugger but dislike the WinDbg built-in script machine syntax it's time to try again using the handy and powerful Python language. Even if you don't want to create your own script, maybe some existing scripts will be of interest to you?
## Pykd bootstrapper ## Getting started
Use it to run pykd within windbg. [link](https://githomelab.ru/pykd/pykd-ext) * You should have installed python. Supported python: 2.7, 3.5, 3.6 and 3.7
* Install pykd with command: 'pip install pykd'
* Use pykd bootstrapper to run pykd with windbg
## Releases: ## Pykd bootstrapper
[All Release](/../wikis/All Releases) Use it to run pykd within windbg.
[PyPi](https://pypi.org/project/pykd) [Home Page](https://githomelab.ru/pykd/pykd-ext)
Just run 'pip install pykd' to install or 'pip install pykd --upgrade' to upgrade to the last version [Download](https://githomelab.ru/pykd/pykd-ext/wikis/Downloads)
## Documentation ## Documentation
[Wiki Home](/../wikis/Home) [Wiki Home](/../wikis/Home)
[User Manual](/../wikis/User Manual rus) [User Manual](/../wikis/User Manual rus)
[API Reference](/../wikis/API Reference) [API Reference](/../wikis/API Reference)
## Useful tools for pykd and WinDBG
[windbg-pack](https://githomelab.ru/pykd/windbg-pack)
Set of python scripts for WinDBG
[pykdwin](https://githomelab.ru/pykd/pykdwin)
A library with auxiliary modules for writing small pykd scripts and daily use.
[windbg-kernel](https://githomelab.ru/pykd/windbg-kernel)
Set of pykd script for kernel debugging
## Releases
[All Releases](/../wikis/All Releases)
[PyPi](https://pypi.org/project/pykd)
Just run 'pip install pykd' to install or 'pip install pykd --upgrade' to upgrade to the last version
## How to build ? ## How to build ?
* install VS 2017 * install VS 2017
https://visualstudio.microsoft.com/downloads/ https://visualstudio.microsoft.com/downloads/
@ -36,3 +53,13 @@ git clone --recurse-submodules https://githomelab.ru/pykd/pykd.git local_dir
``` ```
* open pykd.sln * open pykd.sln
* choose a python version and a target platform then build pykd projects * choose a python version and a target platform then build pykd projects
## Projects used pykd
[mona.py](https://github.com/corelan/mona)
the exploit writer's swiss army knife
[flare-dbg](https://github.com/fireeye/flare-dbg)
flare-dbg is a project meant to aid malware reverse engineers in rapidly developing debugger scripts.
[voltron](https://github.com/snare/voltron)
Voltron is an extensible debugger UI toolkit written in Python