feat: prefer gh CLI over web scraping for GitHub URLs#2225
Open
huaiyuWangh wants to merge 1 commit intocharmbracelet:mainfrom
Open
feat: prefer gh CLI over web scraping for GitHub URLs#2225huaiyuWangh wants to merge 1 commit intocharmbracelet:mainfrom
huaiyuWangh wants to merge 1 commit intocharmbracelet:mainfrom
Conversation
Add prompt instructions to guide agents to use gh CLI instead of web_fetch when fetching GitHub content (PRs, issues, repos, commits). This provides structured JSON data with better quality and reliability than HTML parsing. Changes: - bash.tpl: Add github_integration section with gh CLI command examples - agentic_fetch.md: Add tip to prefer gh CLI for GitHub URLs - web_fetch.md: Add tip to use gh CLI as primary method for GitHub content Closes charmbracelet#2215
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add prompt instructions to guide agents to use
ghCLI instead ofweb_fetchwhen fetching GitHub content (PRs, issues, repos, commits). This provides structured JSON data with better quality and reliability than HTML parsing.Changes
<github_integration>section with gh CLI command examples for PRs, issues, repos, and commits<tips>section to prefer gh CLI for GitHub URLsBenefits
Implementation Approach
This is a prompt-driven solution with no code changes required:
Test Plan
Note on Test Failures
The test failures in
TestCoderAgentare expected because the bash tool prompt was modified (added<github_integration>section), which changes the system prompt sent to the API. The VCR cassettes need to be re-recorded with the new prompt.To fix: Delete or re-record the cassette files in
internal/agent/testdata/TestCoderAgent/*/and run tests with valid API keys.Closes #2215