Skip to main content

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.

Documentation

Full project documentation is published on: https://dariushoule.github.io/x64dbg-automate-pyclient/

See: Installation and Quickstart

🔔 All examples and sample code assume x64dbg is configured to stop on entry and system breakpoints, skipping TLS breakpoints.

MCP Server (Claude Code Integration)

The MCP server exposes x64dbg automation as Model Context Protocol tools for LLM clients like Claude Code.

Installation

pip install x64dbg_automate[mcp] --upgrade

Configuration

Add to your .mcp.json (project or user level):

{
  "mcpServers": {
    "x64dbg": {
      "command": "x64dbg-automate-mcp",
      "env": {
        "X64DBG_PATH": "C:\\path\\to\\x96dbg.exe"
      }
    }
  }
}

Setting X64DBG_PATH lets the MCP tools resolve x64dbg automatically — no need to pass the path on every start_session or connect_to_session call.

For local development, install from source with poetry and point .mcp.json at the entry point:

cd C:\path\to\x64dbg-automate-pyclient
poetry install --extras mcp
{
  "mcpServers": {
    "x64dbg": {
      "command": "poetry",
      "args": [
        "-C", "C:\\path\\to\\x64dbg-automate-pyclient",
        "run", "x64dbg-automate-mcp"
      ],
      "env": {
        "X64DBG_PATH": "C:\\path\\to\\x96dbg.exe"
      }
    }
  }
}

See the MCP Server documentation for the full tool reference and usage walkthrough.

Development and Testing

The client's environment is managed with poetry.

Update tests/conftest.py or provide the requisite environment to allow tests to pass.

poetry install --extras mcp --with dev
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

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.

Metadata

Release files for x64dbg_automate 0.9.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for x64dbg_automate 0.9.2
File Size Uploaded
x64dbg_automate-0.9.2.tar.gz 36.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for x64dbg_automate 0.9.2
File Interpreter ABI Platform
x64dbg_automate-0.9.2-py3-none-any.whl Python 3 none any Details

Total release size: 74.7 kB

Release files / x64dbg_automate-0.9.2.tar.gz

Download URL x64dbg_automate-0.9.2.tar.gz
Size 36.0 kB
Tags Source
SHA-256 checksum
How to use checksums
9ce8339fb230cda8690d41ef48c5bb29305cdb18d6d492bce4c3c7e41509b9ba
BLAKE2b-256 checksum
How to use checksums
d51a7234606f29ae20340720572cfc97c7462be361249b950c4dfd0eaa950cdf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.0.1 CPython/3.13.14 Windows/11

Release files / x64dbg_automate-0.9.2-py3-none-any.whl

Download URL x64dbg_automate-0.9.2-py3-none-any.whl
Size 38.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
75fa9f900c9fe946fc4bb4939836de9a0f0d6db23d8a1f258ac6c4796a36509a
BLAKE2b-256 checksum
How to use checksums
f1fdca7416e4648a446c8a65cb9cb64555ce3513186eb4d440cdf1d29139d075
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.0.1 CPython/3.13.14 Windows/11

Release history Release notifications | RSS feed

This release

0.9.2 This release

2 release files

0.9.1

2 release files

0.9.0

2 release files

0.8.0

2 release files

0.7.6

2 release files

0.7.5

2 release files

0.7.4

2 release files

0.7.3

2 release files

0.7.1

2 release files

0.7.0

2 release files

0.6.3

2 release files

0.6.2

2 release files

0.6.1

2 release files

0.6.0

2 release files

0.5.0

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page