Skip to content

Conversation

@luosky
Copy link

@luosky luosky commented Jan 5, 2026

Summary

This PR improves the LLM agent installation guide in README.md to properly handle both opencode.json and opencode.jsonc configuration file formats.

Changes

  • Added clarification note: Explains that OpenCode's config can be either .json or .jsonc format, with .jsonc taking priority when both exist
  • Updated Step 3 verification script: Now checks for opencode.jsonc first, then falls back to opencode.json, with proper error handling
  • Improved terminology: Replaced specific opencode.json references with "OpenCode config file" for better clarity throughout the authentication setup sections

Motivation

Users who configure OpenCode with opencode.jsonc were not properly covered in the installation verification steps. The guide only checked for opencode.json, which could lead to confusion during setup.

Testing

  • Verified the bash script syntax for checking both file formats
  • Confirmed all references are updated consistently
  • Documentation follows existing style and conventions

Checklist

  • Code follows project conventions
  • Documentation updated appropriately
  • No version changes in package.json
  • Changes are backward compatible

Summary 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.

…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.
@github-actions
Copy link
Contributor

github-actions bot commented Jan 5, 2026

All contributors have signed the CLA. Thank you! ✅
Posted by the CLA Assistant Lite bot.

@luosky
Copy link
Author

luosky commented Jan 5, 2026

I have read the CLA Document and I hereby sign the CLA

@greptile-apps
Copy link

greptile-apps bot commented Jan 5, 2026

Greptile Summary

Enhanced the LLM agent installation guide in README.md to properly support both opencode.json and opencode.jsonc configuration formats.

Key improvements:

  • Added clarification note explaining that .jsonc takes priority when both formats exist
  • Updated Step 3 verification script to check both file formats with proper fallback logic
  • Replaced specific opencode.json references with generic "OpenCode config file" terminology throughout authentication sections
  • Improved user experience for those using JSONC format

The changes are documentation-only, maintain backward compatibility, and follow existing guide conventions.

Confidence Score: 5/5

  • This PR is completely safe to merge with no risk
  • Documentation-only changes that improve clarity and accuracy. The bash script syntax is correct, the logic properly handles both config file formats with correct priority (.jsonc first), and all terminology updates are consistent throughout. No code changes, no breaking changes, and the improvements directly address a real user pain point.
  • No files require special attention

Important Files Changed

Filename Overview
README.md Improved config file detection to handle both opencode.json and opencode.jsonc formats with proper priority handling

Sequence Diagram

sequenceDiagram
    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
Loading

@greptile-apps
Copy link

greptile-apps bot commented Jan 5, 2026

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".

@luosky
Copy link
Author

luosky commented Jan 5, 2026

recheck

Copy link

@cubic-dev-ai cubic-dev-ai bot left a 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.

@luosky
Copy link
Author

luosky commented Jan 5, 2026

recheck

github-actions bot added a commit that referenced this pull request Jan 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant