Skip to content

Commit 7c1d482

Browse files
committedNov 21, 2024
update readme
1 parent ebea456 commit 7c1d482

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed
 

‎README.md

+13-9
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ The different SSE events in the [agent protocol](TODO) that the CLI gives debug
2121
```
2222
1. See more info about the cli tool
2323
```shell
24-
gh debug-cli -h
24+
gh debug-cli chat -h
2525
```
2626

2727
## Using the debug chat tool
28-
1. Run the following command `gh debug-cli -h` to see the different flags that it takes in.
28+
1. Run the following command `gh debug-cli chat -h` to see the different flags that it takes in.
2929
```
30-
> gh debug-cli -h
30+
> gh debug-cli chat -h
3131
This cli tool allows you to debug your agent by chatting with it locally.
3232
3333
Usage:
@@ -47,15 +47,15 @@ export URL="http://localhost:8080/agent/blackbeard"
4747
```
4848
3. When you run the CLI, you will see any flags that were previously set in your environment variables as the output.
4949
```
50-
> gh debug-cli
50+
> gh debug-cli chat
5151
Setting url to http://localhost:8080/agents/blackbeard
5252
5353
Start typing to chat with your assistant...
5454
sparklyunicorn:
5555
```
5656
4. Type something to simulate chatting with your assistant.
5757
```
58-
> gh debug-cli
58+
> gh debug-cli chat
5959
Setting url to http://localhost:8080/agents/blackbeard
6060
6161
Start typing to chat with your assistant...
@@ -114,7 +114,7 @@ assistant: Avast, @monalisa! Me apologies if I didn't quite understand yer reque
114114
```
115115
7. And if debug mode was set to false, then I would only see the confirmation prompt itself.
116116
```
117-
gh debug-cli --log-level none
117+
gh debug-cli chat --log-level none
118118
Setting url to http://localhost:8080/agents/blackbeard
119119
120120
Start typing to chat with your assistant...
@@ -128,10 +128,14 @@ Reply: [y/N]
128128
8. Currently, the supported event types for debug mode are references, errors, and confirmations! Have fun chatting with your assistant!
129129

130130

131-
## Using the debug stream tool
132-
1. to quickly parse agent response run cmd go run `main.go stream --file [local file name]` for example `gh-debug-cli stream --file test.txt`
131+
## Using the gh debug stream tool
132+
1. To quickly parse an agent response by running command `gh debug-cli stream --file test.txt`
133+
134+
2. This tool will take llm streaming response and parse it to make it more readable
133135

134-
2. tool will take print out data packet for easy readability
136+
- In this example, if a file test.txt holds the following streamed response. Then will return the response "A closure in JavaScript is a function that retains access... " This will make repsonse more readable.
137+
138+
example of .txt file
135139
```
136140
data: {"choices":[{"delta":{"content":"A closure in JavaScript "}}],"created":1727120830,"id":"chatcmpl-AAjJW0Nz9E2Gu1P6YQMFqqmn10mdR","model":"gpt-4o-2024-05-13","system_fingerprint":"fp_80a1bad4c7"}
137141
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"}

0 commit comments

Comments
 (0)
Failed to load comments.