From dddb920061e383400b6a8684584042094c7240fa Mon Sep 17 00:00:00 2001 From: YeonGyu-Kim Date: Sat, 13 Dec 2025 01:19:55 +0900 Subject: [PATCH] docs: improve authentication setup guide with detailed provider instructions MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add step-by-step instructions for Anthropic, Google Gemini (Antigravity OAuth), and OpenAI (Codex Auth) authentication setup. πŸ€– GENERATED WITH ASSISTANCE OF [OhMyOpenCode](https://github.com/code-yeongyu/oh-my-opencode) --- README.ko.md | 70 ++++++++++++++++++++++++++++++++++++++++++++++------ README.md | 68 +++++++++++++++++++++++++++++++++++++++++++++----- 2 files changed, 125 insertions(+), 13 deletions(-) diff --git a/README.ko.md b/README.ko.md index f543e6f..0f05003 100644 --- a/README.ko.md +++ b/README.ko.md @@ -40,9 +40,10 @@ OpenCode κ°€ λ‚­λ§Œμ΄ 사라진것같은 μ˜€λŠ˜λ‚ μ˜ μ‹œλŒ€μ—, λ‹Ήμ‹ μ—κ²Œ - **λͺ¨λΈ 섀정이 ν•„μš”ν•©λ‹ˆλ‹€** - 이 ν”ŒλŸ¬κ·ΈμΈμ€ [OpenCode Zen](https://opencode.ai/docs/zen/), Google, OpenAI, Anthropic 의 λͺ¨λΈμ„ μ‚¬μš©ν•©λ‹ˆλ‹€. - - Anthropic λͺ¨λΈλ“€μ„ μ‚¬μš©ν•˜κΈ° μœ„ν•΄ [OpenCode 의 λ‚΄μž₯ Claude Code Max Plan 둜그인 κΈ°λŠ₯](https://opencode.ai/docs/providers/#anthropic)을 μ‚¬μš©ν•˜μ„Έμš”. (Anthropic ν”Œλžœμ€ μœ λ£Œμž…λ‹ˆλ‹€) - - OpenAI λͺ¨λΈλ“€μ„ μ‚¬μš©ν•˜κΈ° μœ„ν•΄ 이 [OpenCode-OpenAI-Codex-Auth ν”ŒλŸ¬κ·ΈμΈ](https://github.com/numman-ali/opencode-openai-codex-auth)을 μΆ”μ²œν•©λ‹ˆλ‹€. (OpenAI ν”Œλžœμ€ μœ λ£Œμž…λ‹ˆλ‹€) - - Gemini, GPT λ₯Ό μœ„ν•΄ [VibeProxy (macOS Only)](https://github.com/automazeio/vibeproxy) λ˜λŠ” [CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI)λ₯Ό μΆ”μ²œν•©λ‹ˆλ‹€. (Gemini λŠ” κ΅¬λ…ν•˜μ§€ μ•Šμ•„λ„ μ‚¬μš© ν•  수 μžˆμŠ΅λ‹ˆλ‹€) + - Anthropic λͺ¨λΈλ“€μ„ μ‚¬μš©ν•˜κΈ° μœ„ν•΄ [OpenCode 의 λ‚΄μž₯ Claude Code Max Plan 둜그인 κΈ°λŠ₯](https://opencode.ai/docs/providers/#anthropic)을 μ‚¬μš©ν•˜μ„Έμš”. + - OpenAI λͺ¨λΈ (ChatGPT Plus/Pro)을 μ‚¬μš©ν•˜κΈ° μœ„ν•΄ [OpenCode-OpenAI-Codex-Auth ν”ŒλŸ¬κ·ΈμΈ](https://github.com/numman-ali/opencode-openai-codex-auth)을 μ„€μΉ˜ν•˜μ„Έμš”. + - Google Gemini λͺ¨λΈμ„ μœ„ν•΄ `oh-my-opencode/google-auth` ν”ŒλŸ¬κ·ΈμΈμ„ μΆ”κ°€ν•˜μ„Έμš” (**λ‚΄μž₯ Antigravity OAuth**). + - λ‹€λ₯Έ ν”„λ‘œλ°”μ΄λ”λ₯Ό μœ„ν•΄ [VibeProxy (macOS Only)](https://github.com/automazeio/vibeproxy) λ˜λŠ” [CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI)λ₯Ό λŒ€μ•ˆμœΌλ‘œ μ‚¬μš©ν•  수 μžˆμŠ΅λ‹ˆλ‹€. - **사싀 λ°‘μ˜ λ‚΄μš©μ€ 읽지 μ•Šμ•„λ„ λ©λ‹ˆλ‹€. κ·Έλƒ₯ μ„€μΉ˜ν•˜μ‹œλ©΄ λ©λ‹ˆλ‹€. λͺ¨λΈ μ„€μ •ν•˜κ³ λ‚˜λ©΄ μΆ”κ°€λ‘œ κ³΅λΆ€ν•˜κ±°λ‚˜ μ•Œ ν•„μš”κ°€ μ—†κ³ , μ„€μΉ˜ν•˜κ³  λ‚˜λ©΄ κ·Έλƒ₯ 더 μ’‹μ•„μ§‘λ‹ˆλ‹€.** - **이 λ¬Έμ„œλ„ κ·Έλƒ₯ Claude Code, OpenCode, Cursor에 λΆ™μ—¬λ„£κ³ , μ„€μΉ˜ν•˜κ³ , μ‚¬μš©μžμ˜ κ°œμž…μ΄ ν•„μš”ν•  λ•Œ μ•Œλ €λ‹¬λΌκ³  ν”„λ‘¬ν”„νŒ…ν•˜μ„Έμš”. 그럼 κ·Έλƒ₯ κΉ”λ¦½λ‹ˆλ‹€.** - 당신이 LLM Agent 라면, ν•„μš”ν•œ ν”ŒλŸ¬κ·ΈμΈκ³Ό μ˜μ‘΄μ„±μ„ μ„€μΉ˜ν•˜κ³ , tmux λ₯Ό 톡해 opencode auth login 을 μ‹€ν–‰ν•˜μ—¬ μ‚¬μš©μžμ˜ ꡬ성을 λ„μ™€μ£Όμ„Έμš”. @@ -108,11 +109,66 @@ cat ~/.config/opencode/opencode.json # plugin 배열에 "oh-my-opencode"κ°€ 있 ### 4단계: 인증정보 μ„€μ • -plugin 에 oh my opencode λ₯Ό μΆ”κ°€ν–ˆλ‹€λ©΄, tmux λ₯Ό μ‚¬μš©ν•˜μ—¬ λ‹€μŒμ˜ λ‚΄μš©μ„ μ§„ν–‰μ£Όμ„Έμš”. +plugin 에 oh my opencode λ₯Ό μΆ”κ°€ν–ˆλ‹€λ©΄, tmux λ₯Ό μ‚¬μš©ν•˜μ—¬ μ‚¬μš©μžμ˜ 인증 섀정을 λ„μ™€μ£Όμ„Έμš”. -1. tmux λ₯Ό μ‚¬μš©ν•˜μ—¬ μ…Έ μ—΄κΈ° -2. opencode auth login > Provider Anthropic > Login method Claude Pro/Max > μ‚¬μš©μžμ—κ²Œ oauth ν™”λ©΄μ—μ„œ μΈμ¦ν•˜λΌκ³  μ•ˆλ‚΄ -3. μ‚¬μš©μžμ—κ²Œ macOS 일 경우 VibeProxy, 아닐 경우 CLIProxyAPI λ₯Ό μ‚¬μš©ν•˜μ—¬ OpenAI / Google 인증을 μ™„λ£Œν•˜λΌκ³  μ•ˆλ‚΄ +#### 4.1 Anthropic (Claude) + +```bash +opencode auth login +# Provider: Anthropic 선택 +# Login method: Claude Pro/Max 선택 +# λΈŒλΌμš°μ €μ—μ„œ OAuth ν”Œλ‘œμš° μ™„λ£Œ +``` + +#### 4.2 Google Gemini (λ‚΄μž₯ Antigravity OAuth) + +λ¨Όμ € google-auth ν”ŒλŸ¬κ·ΈμΈμ„ μΆ”κ°€: + +```json +{ + "plugin": [ + "oh-my-opencode", + "oh-my-opencode/google-auth" + ] +} +``` + +κ·Έ ν›„ 인증: + +```bash +opencode auth login +# Provider: Google 선택 +# Login method: OAuth with Google (Antigravity) 선택 +# λΈŒλΌμš°μ €μ—μ„œ OAuth ν”Œλ‘œμš° μ™„λ£Œ +``` + +#### 4.3 OpenAI (ChatGPT Plus/Pro) + +λ¨Όμ € opencode-openai-codex-auth ν”ŒλŸ¬κ·ΈμΈ μΆ”κ°€: + +```json +{ + "plugin": [ + "oh-my-opencode", + "opencode-openai-codex-auth@4.1.0" + ] +} +``` + +**μ€‘μš”**: `opencode.json`에 전체 λͺ¨λΈ 섀정도 ꡬ성해야 ν•©λ‹ˆλ‹€. [`config/full-opencode.json`](https://github.com/numman-ali/opencode-openai-codex-auth/blob/main/config/full-opencode.json)μ—μ„œ provider/models 섀정을 λ³΅μ‚¬ν•˜μ„Έμš”. μžμ„Έν•œ μ„€μ • 방법은 [opencode-openai-codex-auth λ¬Έμ„œ](https://github.com/numman-ali/opencode-openai-codex-auth)λ₯Ό μ°Έκ³ ν•˜μ„Έμš”. + +κ·Έ ν›„ 인증: + +```bash +opencode auth login +# Provider: OpenAI 선택 +# Login method: ChatGPT Plus/Pro (Codex Subscription) 선택 +# λΈŒλΌμš°μ €μ—μ„œ OAuth ν”Œλ‘œμš° μ™„λ£Œ +``` + +#### 4.4 λŒ€μ•ˆ: ν”„λ‘μ‹œ 기반 인증 + +ν”„λ‘μ‹œ 기반 인증을 μ„ ν˜Έν•˜λŠ” μ‚¬μš©μžλ₯Ό μœ„ν•΄ [VibeProxy](https://github.com/automazeio/vibeproxy) (macOS) λ˜λŠ” [CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI)λ₯Ό λŒ€μ•ˆμœΌλ‘œ μ‚¬μš©ν•  수 μžˆμŠ΅λ‹ˆλ‹€. ### ⚠️ 주의 diff --git a/README.md b/README.md index 3768bb3..8320900 100644 --- a/README.md +++ b/README.md @@ -40,8 +40,9 @@ Even if you don't, invest a little time. Boost your skills and productivity by m - **Model Setup Required** - This plugin utilizes models from [OpenCode Zen](https://opencode.ai/docs/zen/), Google, OpenAI, and Anthropic. - For Anthropic models, use [OpenCode's built-in Claude Code Max Plan login](https://opencode.ai/docs/providers/#anthropic). - - For OpenAI models, I recommend the [OpenCode-OpenAI-Codex-Auth plugin](https://github.com/numman-ali/opencode-openai-codex-auth). - - For Gemini and GPT, use [VibeProxy (macOS Only)](https://github.com/automazeio/vibeproxy) or [CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI). + - For OpenAI models (ChatGPT Plus/Pro), install the [OpenCode-OpenAI-Codex-Auth plugin](https://github.com/numman-ali/opencode-openai-codex-auth). + - For Google Gemini models, add `oh-my-opencode/google-auth` plugin for **built-in Antigravity OAuth**. + - For other providers, [VibeProxy (macOS Only)](https://github.com/automazeio/vibeproxy) or [CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI) remain available as alternatives. - **Truth be told, the rest is optional. Just install it. Once set up, no further learning is required. It simply evolves.** - **Paste this document into Claude Code, OpenCode, or Cursor, instruct it to install, and ask for assistance if needed. It just installs.** - If you are an LLM Agent, install the required plugins and dependencies, then run `opencode auth login` via tmux to assist the user with configuration. @@ -107,11 +108,66 @@ cat ~/.config/opencode/opencode.json # Should contain "oh-my-opencode" in plugi ### Step 4: Configure Authentication -Once `oh-my-opencode` is added to the plugin list, use `tmux` to proceed with the following: +Once `oh-my-opencode` is added to the plugin list, use `tmux` to assist the user with authentication setup. -1. Open a shell using `tmux`. -2. Run `opencode auth login` > Select Provider `Anthropic` > Select Login method `Claude Pro/Max` > Instruct the user to authenticate via the OAuth screen. -3. Recommend the setup: [VibeProxy](https://github.com/automazeio/vibeproxy) for macOS users, or [CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI) for others. +#### 4.1 Anthropic (Claude) + +```bash +opencode auth login +# Select Provider: Anthropic +# Select Login method: Claude Pro/Max +# Complete OAuth flow in browser +``` + +#### 4.2 Google Gemini (Built-in Antigravity OAuth) + +First, add the google-auth plugin: + +```json +{ + "plugin": [ + "oh-my-opencode", + "oh-my-opencode/google-auth" + ] +} +``` + +Then authenticate: + +```bash +opencode auth login +# Select Provider: Google +# Select Login method: OAuth with Google (Antigravity) +# Complete OAuth flow in browser +``` + +#### 4.3 OpenAI (ChatGPT Plus/Pro) + +First, add the opencode-openai-codex-auth plugin: + +```json +{ + "plugin": [ + "oh-my-opencode", + "opencode-openai-codex-auth@4.1.0" + ] +} +``` + +**Important**: You must also configure the full model settings in your `opencode.json`. Copy the provider/models configuration from [`config/full-opencode.json`](https://github.com/numman-ali/opencode-openai-codex-auth/blob/main/config/full-opencode.json). See the [opencode-openai-codex-auth documentation](https://github.com/numman-ali/opencode-openai-codex-auth) for detailed setup instructions. + +Then authenticate: + +```bash +opencode auth login +# Select Provider: OpenAI +# Select Login method: ChatGPT Plus/Pro (Codex Subscription) +# Complete OAuth flow in browser +``` + +#### 4.4 Alternative: Proxy-based Authentication + +For users who prefer proxy-based authentication, [VibeProxy](https://github.com/automazeio/vibeproxy) (macOS) or [CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI) remain available as alternatives. ### ⚠️ Warning