Skip to content

Commit 821a5f6

Browse files
committed
update readme
1 parent 31db883 commit 821a5f6

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The different SSE events in the [agent protocol](TODO) that the CLI gives debug
2424
gh debug-cli -h
2525
```
2626

27-
## Using the debug tool
27+
## Using the debug chat tool
2828
1. Run the following command `gh debug-cli -h` to see the different flags that it takes in.
2929
```
3030
> gh debug-cli -h
@@ -126,3 +126,16 @@ Be ye sure ye want a custom limerick 'bout petals ?
126126
Reply: [y/N]
127127
```
128128
8. Currently, the supported event types for debug mode are references, errors, and confirmations! Have fun chatting with your assistant!
129+
130+
131+
## Using the debug stream tool
132+
1. to quickly parse agent response run cmd go run `main.go stream [local file name]` for example `gh-debug-cli stream test.txt`
133+
134+
2. tool will take print out data packet for easy readability
135+
```
136+
data: {"choices":[{"delta":{"content":"A closure in JavaScript "}}],"created":1727120830,"id":"chatcmpl-AAjJW0Nz9E2Gu1P6YQMFqqmn10mdR","model":"gpt-4o-2024-05-13","system_fingerprint":"fp_80a1bad4c7"}
137+
data: {"choices":[{"delta":{"content":"is a function that retains access "}}],"created":1727120831,"id":"chatcmpl-AAjJW0Nz9E2Gu1P6YQMFqqmn10mdR","model":"gpt-4o-2024-05-13","system_fingerprint":"fp_80a1bad4c7"}
138+
data: {"choices":[{"delta":{"content":"to its lexical scope, even "}}],"created":1727120832,"id":"chatcmpl-AAjJW0Nz9E2Gu1P6YQMFqqmn10mdR","model":"gpt-4o-2024-05-13","system_fingerprint":"fp_80a1bad4c7"}
139+
data: {"choices":[{"delta":{"content":"when the function is executed "}}],"created":1727120833,"id":"chatcmpl-AAjJW0Nz9E2Gu1P6YQMFqqmn10mdR","model":"gpt-4o-2024-05-13","system_fingerprint":"fp_80a1bad4c7"}
140+
data: {"choices":[{"delta":{"content":"outside that scope. "}}],"created":1727120834,"id":"chatcmpl-AAjJW0Nz9E2Gu1P6YQMFqqmn10mdR","model":"gpt-4o-2024-05-13","system_fingerprint":"fp_80a1bad4c7"}
141+
```

0 commit comments

Comments
 (0)