Skip to content

docs: add a Build with Claude Code or Codex section to the README - #329

Merged
tezpark merged 3 commits into
mainfrom
docs/claude-code-codex-plugin
Nov 19, 2026
Merged

tezpark merged 3 commits into
mainfrom
docs/claude-code-codex-plugin

Conversation

@tezpark

@tezpark tezpark commented Nov 19, 2026

Copy link
Copy Markdown
Collaborator

Adds a short README section that shows how to add this SDK to a React Native app with the Sendbird plugins for Claude Code and Codex.

  • It installs the Sendbird Client Plugin, which writes setup and feature code, and the Sendbird CLI plugin, which signs in and picks the app whose App ID the client plugin uses.
  • The install and setup commands are the ones in sendbird/sendbird-plugins and the CLI plugin guide. /sendbird-client:setup --product uikit is the setup command for this SDK.
  • The section sits before the installation steps.

When a developer asks an AI coding agent how to add Sendbird, the agent often reads the SDK README on GitHub. None of the SDK READMEs mention these plugins today.

🤖 Generated with Claude Code

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 19, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-19T02:25:21.624408Z e06c4fb PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@upwind-code-us

upwind-code-us Bot commented Nov 19, 2026 •

Copy link
Copy Markdown

Upwind Code Scan

Upwind code scan | ⏭️ Skipped

No scans ran: this PR changes nothing Upwind scans.

Last updated: 32bc5a5 · 2026-11-19 03:25 UTC

@codecov-commenter

codecov-commenter commented Nov 19, 2026 •

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 12.31%. Comparing base (dcf1cf2) to head (32bc5a5).
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff            @@
##             main     #329    +/-   ##
========================================
  Coverage   12.31%   12.31%            
========================================
  Files         361      361            
  Lines        9108     9108            
  Branches     2563     2446   -117     
========================================
  Hits         1122     1122            
  Misses       7985     7985            
  Partials        1        1            

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: e06c4fbe1f

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
```bash
claude plugin marketplace add sendbird/sendbird-plugins
claude plugin install sendbird-client@sendbird
claude plugin install sendbird-cli@sendbird

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge State the CLI plugin's stricter Node requirement

On machines using Node 18 or 20—which satisfy this README's existing Nodejs 18 or newer requirement—installing or running the CLI plugin cannot complete because the official Sendbird CLI requirements specify Node.js 22.23.4+ or 24.22.1+. Document that prerequisite beside the CLI plugin installation so the newly advertised workflow does not fail for otherwise-supported repository setups.

Useful? React with 👍 / 👎.

Comment thread README.md Outdated
codex plugin add sendbird-cli@sendbird
```

Then call `$sendbird-cli:sendbird-setup` and `$sendbird-client:setup`.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Preserve the UIKit selector in the Codex command

When the target React Native project does not already identify a Sendbird product, this bare setup invocation does not specify that the user wants this UIKit rather than the lower-level Chat SDK. The plugin's setup skill documents --product chat|uikit|calls and treats --product uikit as the explicit UIKit selection, so the Codex example should mirror the Claude command as $sendbird-client:setup --product uikit.

Useful? React with 👍 / 👎.

Comment thread README.md Outdated
codex plugin add sendbird-cli@sendbird
```

Then call `$sendbird-cli:sendbird-setup` and `$sendbird-client:setup`.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Tell Codex users to start a fresh session

If these install commands are run from a terminal inside an existing Codex session, immediately calling the listed skills leaves them unavailable because the client plugin guide states that plugins load when a session starts and explicitly requires starting a new session after installation. Add the same restart instruction already given for Claude Code before telling Codex users to invoke the skills.

Useful? React with 👍 / 👎.

@OnestarLee OnestarLee left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sendbird CLI 설치 요건

Comment thread README.md
In Claude Code:

```bash
claude plugin marketplace add sendbird/sendbird-plugins

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

README의 UIKit 요구사항에는 Node.js 18 이상으로 되어 있어서, 같은 환경에서 CLI 설정도 가능하다고 읽힐 수 있습니다. 플러그인 설치 명령 앞에 Sendbird CLI의 Node.js 요구사항을 별도로 적어주세요. CLI 요구사항

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

반영했습니다 (32bc5a5). 설치 명령 앞에 CLI 플러그인의 Node.js 요건(22.23.4 이상의 22.x, 24.22.1 이상의 24.x)을 넣었습니다.

@tezpark
tezpark added this pull request to the merge queue Nov 19, 2026
Merged via the queue into main with commit bee5b75 Nov 19, 2026
11 checks passed
@tezpark
tezpark deleted the docs/claude-code-codex-plugin branch November 19, 2026 03:32
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.

3 participants