# x64dbg Automate: Reference Python Client
This is the reference client of x64dbg Automate. The library builds on x64dbg's command execution engine and plugin API to provide an expressive, modern, and easy to use Python client. x64dbg Automate is useful in a wide variety of malware analysis, reverse engineering, and vulnerability hunting tasks.
The client implements the full RPC protocol provided by [x64dbg-automate](https://github.com/dariushoule/x64dbg-automate).
## Documentation
Full project documentation is published on: [https://dariushoule.github.io/x64dbg-automate-pyclient/](https://dariushoule.github.io/x64dbg-automate-pyclient/)
See: [Installation](https://dariushoule.github.io/x64dbg-automate-pyclient/installation/) and [Quickstart](https://dariushoule.github.io/x64dbg-automate-pyclient/quickstart/)
🔔 _All examples and sample code assume x64dbg is configured to stop on entry and system breakpoints, skipping TLS breakpoints._
## Development and Testing
The client's environment is managed with [poetry](https://python-poetry.org/docs/).
Update `tests/conftest.py` or provide the requisite environment to allow tests to pass.
```powershell
poetry install
poetry env activate
python -m pytest # Test
python .\examples\assemble_and_disassemble.py C:\<you>\x64dbg\release\x64\x64dbg.exe # Run an example
```
**Documentation is built using mkdocs**
```powershell
python -m mkdocs serve # dev
python -m mkdocs build # publish
```
# Contributing
Issues, feature-requests, and pull-requests are welcome on this project ❤️🐛
My commitment to the community will be to be a responsive maintainer. Discuss with me before implementing major breaking changes or feature additions.
Raw data
{
"_id": null,
"home_page": "https://dariushoule.github.io/x64dbg-automate-pyclient/",
"name": "x64dbg_automate",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "x64dbg, debugger, instrumentation, plugin, dynamic-analysis",
"author": "Darius Houle",
"author_email": "darius@x64.ooo",
"download_url": "https://files.pythonhosted.org/packages/a7/f8/3d17bd5bd5f79ea5b261ea8f2e963257614f976f1f2f785c3972b6fcab43/x64dbg_automate-0.5.0.tar.gz",
"platform": null,
"description": "# x64dbg Automate: Reference Python Client\n\nThis is the reference client of x64dbg Automate. The library builds on x64dbg's command execution engine and plugin API to provide an expressive, modern, and easy to use Python client. x64dbg Automate is useful in a wide variety of malware analysis, reverse engineering, and vulnerability hunting tasks. \n\nThe client implements the full RPC protocol provided by [x64dbg-automate](https://github.com/dariushoule/x64dbg-automate). \n\n## Documentation\n\nFull project documentation is published on: [https://dariushoule.github.io/x64dbg-automate-pyclient/](https://dariushoule.github.io/x64dbg-automate-pyclient/)\n\nSee: [Installation](https://dariushoule.github.io/x64dbg-automate-pyclient/installation/) and [Quickstart](https://dariushoule.github.io/x64dbg-automate-pyclient/quickstart/)\n\n\ud83d\udd14 _All examples and sample code assume x64dbg is configured to stop on entry and system breakpoints, skipping TLS breakpoints._\n\n## Development and Testing\n\nThe client's environment is managed with [poetry](https://python-poetry.org/docs/). \n\nUpdate `tests/conftest.py` or provide the requisite environment to allow tests to pass. \n\n```powershell\npoetry install\npoetry env activate\npython -m pytest # Test\npython .\\examples\\assemble_and_disassemble.py C:\\<you>\\x64dbg\\release\\x64\\x64dbg.exe # Run an example\n```\n\n**Documentation is built using mkdocs**\n\n```powershell\npython -m mkdocs serve # dev\npython -m mkdocs build # publish\n```\n\n# Contributing\n\nIssues, feature-requests, and pull-requests are welcome on this project \u2764\ufe0f\ud83d\udc1b\n\nMy commitment to the community will be to be a responsive maintainer. Discuss with me before implementing major breaking changes or feature additions.",
"bugtrack_url": null,
"license": null,
"summary": "A Python library to automate x64dbg",
"version": "0.5.0",
"project_urls": {
"Homepage": "https://dariushoule.github.io/x64dbg-automate-pyclient/",
"Issues": "https://github.com/dariushoule/x64dbg-automate-pyclient/issues",
"Repository": "https://github.com/dariushoule/x64dbg-automate-pyclient"
},
"split_keywords": [
"x64dbg",
" debugger",
" instrumentation",
" plugin",
" dynamic-analysis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ef9baf78e779271494e06601c56c835636f89284c001cfb4f985b137a5992d1e",
"md5": "c16b4cd66187e55731fdf7bdfd4070f2",
"sha256": "9f4fb266907a40b73fc4a00c59f13a84ad9aab3d49eb232636fe5c81df42146c"
},
"downloads": -1,
"filename": "x64dbg_automate-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c16b4cd66187e55731fdf7bdfd4070f2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 18881,
"upload_time": "2025-07-25T21:34:41",
"upload_time_iso_8601": "2025-07-25T21:34:41.206280Z",
"url": "https://files.pythonhosted.org/packages/ef/9b/af78e779271494e06601c56c835636f89284c001cfb4f985b137a5992d1e/x64dbg_automate-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a7f83d17bd5bd5f79ea5b261ea8f2e963257614f976f1f2f785c3972b6fcab43",
"md5": "9538986e53d912ff27684deff97a3815",
"sha256": "d76516b13e2ff51fb56a6efb944c72e82ae634258bbb75e2ed0874bb7e5cba7a"
},
"downloads": -1,
"filename": "x64dbg_automate-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "9538986e53d912ff27684deff97a3815",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 16922,
"upload_time": "2025-07-25T21:34:42",
"upload_time_iso_8601": "2025-07-25T21:34:42.506126Z",
"url": "https://files.pythonhosted.org/packages/a7/f8/3d17bd5bd5f79ea5b261ea8f2e963257614f976f1f2f785c3972b6fcab43/x64dbg_automate-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-25 21:34:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dariushoule",
"github_project": "x64dbg-automate-pyclient",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "x64dbg_automate"
}
JSON
