Skip to content

Commit 67c295e

Browse files
update readme and remove sepereate debug guide
1 parent 1c72627 commit 67c295e

File tree

2 files changed

+31
-225
lines changed

2 files changed

+31
-225
lines changed

DEBUG_GUIDE.md

Lines changed: 0 additions & 225 deletions
This file was deleted.

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,37 @@ asyncio.run(main())
6767

6868
Functionality between the synchronous and asynchronous clients is otherwise identical.
6969

70+
## Debugging
71+
72+
AgentEx provides built-in debugging support for **temporal projects** during local development.
73+
74+
```bash
75+
# Basic debugging
76+
uv run agentex agents run --manifest manifest.yaml --debug-worker
77+
78+
# Wait for debugger to attach before starting
79+
uv run agentex agents run --manifest manifest.yaml --debug-worker --wait-for-debugger
80+
81+
# Custom debug port
82+
uv run agentex agents run --manifest manifest.yaml --debug-worker --debug-port 5679
83+
```
84+
85+
For **VS Code**, add this configuration to `.vscode/launch.json`:
86+
87+
```json
88+
{
89+
"name": "Attach to AgentEx Worker",
90+
"type": "debugpy",
91+
"request": "attach",
92+
"connect": { "host": "localhost", "port": 5678 },
93+
"pathMappings": [{ "localRoot": "${workspaceFolder}", "remoteRoot": "." }],
94+
"justMyCode": false,
95+
"console": "integratedTerminal"
96+
}
97+
```
98+
99+
The debug server automatically finds an available port starting from 5678 and prints connection details when starting.
100+
70101
### With aiohttp
71102

72103
By default, the async client uses `httpx` for HTTP requests. However, for improved concurrency performance you may also use `aiohttp` as the HTTP backend.

0 commit comments

Comments
 (0)