Practical overview
When it fits
Use btcdeb when you need to inspect Bitcoin Script operation-by-operation or convert a readable script into its encoded representation.
Who it is for
- Bitcoin developers inspecting script execution one operation at a time.
- Script authors who want to convert readable operations into Bitcoin Script encoding.
Documented uses
- Step through Bitcoin Script operations and inspect the stack state.
- Translate human-readable script operations into Bitcoin Script encoding.
- Build or package the tools for native, Docker or JavaScript-based workflows.
Requirements & limits
- The native build instructions cover Linux and macOS and list required dependencies.
- Docker is documented as an alternative way to use the tools.
- The JavaScript build uses Emscripten and Node.js; the btcdeb console has a documented limitation in this mode.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Build btcdeb from source on Linux or macOS
Prepare a native build of the Bitcoin Script tools.
Before you start
- The btcdeb source code
- libtool, libssl, autoconf/automake and pkg-config
- On macOS, Apple command-line tools and Homebrew
Steps
Install the required dependencies for your operating system.
From the source directory, run ./autogen.sh.
Run ./configure, then make.
Run sudo make install.
Expected outcome
The documented build and installation process produces the btcdeb tools for use on Linux or macOS.
Guide limitations
- The README notes that missing dependencies may cause build errors.
- The instructions do not specify platform versions or guarantee compatibility.
Compile btcdeb tools to JavaScript
Compile the documented tools with Emscripten and invoke btcdeb through Node.js.
Before you start
- The btcdeb source code
- The Emscripten SDK
- Node.js
Steps
Install the Emscripten SDK.
In the source directory, run make clean, emconfigure ./configure and emmake make.
Run the documented loop that renames btcdeb, btcc and tap outputs to .bc files and compiles them with emcc.
Invoke the debugger with node btcdeb.js.
Expected outcome
The tools are compiled to JavaScript; the README gives Node.js invocation as the next step.
Guide limitations
- The README says most functions work, but the btcdeb console does not.
- It describes a newline-input workaround for the console.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 14 October 2026
- Original website title
- bitcoin-core/btcdeb · Official homepage title · retained in its source language

