Skip to content

Fix blackbeard example urls in the README.md #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,20 +43,20 @@ Flags:
> The token noted in the flag above is used to authenticate against the provided LLM. If you are using a different service, then this token is not needed. Generate the user-to-server token by [creating a GitHub Applicatiion](https://docs.github.com/en/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps) and then following the [using the device flow to generate a user access token](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app#using-the-device-flow-to-generate-a-user-access-token) to generate the token.
2. You can alternatively set these flags as environment variables (in all caps) so you don't need to pass them in every time. The only "required" one to get this up and running is the url for your agent
```
export URL="http://localhost:8080/agent/blackbeard"
export URL="http://localhost:3000"
```
3. When you run the CLI, you will see any flags that were previously set in your environment variables as the output.
```
> gh debug-cli chat
Setting url to http://localhost:8080/agents/blackbeard
Setting url to http://localhost:3000

Start typing to chat with your assistant...
sparklyunicorn:
```
4. Type something to simulate chatting with your assistant.
```
> gh debug-cli chat
Setting url to http://localhost:8080/agents/blackbeard
Setting url to http://localhost:3000

Start typing to chat with your assistant...
sparklyunicorn: hello
Expand Down Expand Up @@ -115,7 +115,7 @@ assistant: Avast, @monalisa! Me apologies if I didn't quite understand yer reque
7. And if debug mode was set to false, then I would only see the confirmation prompt itself.
```
gh debug-cli chat --log-level none
Setting url to http://localhost:8080/agents/blackbeard
Setting url to http://localhost:3000

Start typing to chat with your assistant...
sparklyunicorn: confirmation
Expand Down