-
Notifications
You must be signed in to change notification settings - Fork 1.1k
docs: improve OpenCode config file detection in LLM agent installation guide #512
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
base: dev
Are you sure you want to change the base?
docs: improve OpenCode config file detection in LLM agent installation guide #512
Conversation
…n guide - Add note explaining OpenCode config can be .json or .jsonc format - Update Step 3 verification script to check both formats (.jsonc takes priority) - Replace specific 'opencode.json' references with 'OpenCode config file' for clarity - Ensure all verification steps properly detect both config file formats This addresses the issue where users with opencode.jsonc were not properly covered in the installation verification steps.
|
All contributors have signed the CLA. Thank you! ✅ |
|
I have read the CLA Document and I hereby sign the CLA |
Greptile SummaryEnhanced the LLM agent installation guide in Key improvements:
The changes are documentation-only, maintain backward compatibility, and follow existing guide conventions. Confidence Score: 5/5
Important Files Changed
Sequence DiagramsequenceDiagram
participant User
participant InstallScript as Install Script
participant ConfigFile as Config File System
participant VerifyScript as Verification Script
User->>InstallScript: bunx oh-my-opencode install
InstallScript->>ConfigFile: Register plugin
ConfigFile-->>ConfigFile: Check for opencode.jsonc
alt opencode.jsonc exists
ConfigFile->>ConfigFile: Use opencode.jsonc (priority)
else opencode.json exists
ConfigFile->>ConfigFile: Use opencode.json (fallback)
end
InstallScript-->>User: Installation complete
User->>VerifyScript: Run verification script
VerifyScript->>ConfigFile: Check opencode.jsonc
alt opencode.jsonc found
ConfigFile-->>VerifyScript: Return opencode.jsonc
VerifyScript->>User: Display opencode.jsonc contents
else opencode.jsonc not found
VerifyScript->>ConfigFile: Check opencode.json
alt opencode.json found
ConfigFile-->>VerifyScript: Return opencode.json
VerifyScript->>User: Display opencode.json contents
else No config file found
VerifyScript->>User: No output (silent fail)
end
end
|
Greptile found no issues!From now on, if a review finishes and we haven't found any issues, we will not post anything, but you can confirm that we reviewed your changes in the status check section. This feature can be toggled off in your Code Review Settings by deselecting "Create a status check for each PR". |
|
recheck |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No issues found across 1 file
Confidence score: 5/5
- Automated review surfaced no issues in the provided summaries.
- No files require special attention.
|
recheck |
Summary
This PR improves the LLM agent installation guide in README.md to properly handle both
opencode.jsonandopencode.jsoncconfiguration file formats.Changes
.jsonor.jsoncformat, with.jsonctaking priority when both existopencode.jsoncfirst, then falls back toopencode.json, with proper error handlingopencode.jsonreferences with "OpenCode config file" for better clarity throughout the authentication setup sectionsMotivation
Users who configure OpenCode with
opencode.jsoncwere not properly covered in the installation verification steps. The guide only checked foropencode.json, which could lead to confusion during setup.Testing
Checklist
package.jsonSummary by cubic
Improved the LLM agent installation guide to correctly detect both opencode.json and opencode.jsonc, reducing setup confusion for users with .jsonc configs.
Added a note on config formats, updated Step 3 to check .jsonc first then .json, and replaced “opencode.json” with “OpenCode config file” across the auth setup.
Written for commit 136c703. Summary will update on new commits.