Skip to content

Commit 7b6fcfd

Browse files
committed
tdlv: add doc
1 parent d1d6d49 commit 7b6fcfd

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

custom-debugger/README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Custom Debugger
2+
3+
A multi-language debugger for Temporal workflows that supports Go, Python, and JavaScript.
4+
5+
## Overview
6+
7+
The custom debugger provides debugging capabilities for Temporal workflows by:
8+
- Starting appropriate language-specific debuggers (Delve for Go, DebugPy for Python, JS Debug for JavaScript)
9+
- Acting as a proxy between IDEs and language debuggers
10+
- Supporting both DAP (Debug Adapter Protocol) and JSON-RPC protocols
11+
- Enabling workflow debugging from history files
12+
13+
## Usage
14+
15+
```bash
16+
# Start with default settings (Go language, port 60000)
17+
./custom-debugger
18+
19+
# Specify language and port
20+
./custom-debugger -lang python -p 60001
21+
22+
# Auto-install missing debuggers
23+
./custom-debugger -lang js -install
24+
25+
# Suppress dependency check messages
26+
./custom-debugger -quiet
27+
```
28+
29+
## Supported Languages
30+
31+
- **Go**: Uses Delve debugger
32+
- **Python**: Uses DebugPy debugger
33+
- **JavaScript**: Uses VS Code JS Debug
34+
35+
## Ports
36+
37+
- **60000**: Main debugger proxy port (configurable with `-p`)
38+
- **2345**: Language-specific debugger port
39+
40+
## Dependencies
41+
42+
The debugger automatically checks for and can install required language-specific debuggers:
43+
- Delve for Go workflows
44+
- DebugPy for Python workflows
45+
- JS Debug for JavaScript workflows

0 commit comments

Comments
 (0)