From 41f93c9f8b15e1d71a94ee4b9e46948e45b5ff23 Mon Sep 17 00:00:00 2001 From: YeonGyu-Kim Date: Wed, 10 Dec 2025 15:45:16 +0900 Subject: [PATCH] docs(readme): add warning for LLM agents on oh-my-opencode.json setup and sync English tone with Korean version --- README.ko.md | 14 +++++++++++++- README.md | 29 +++++++++++++++++++++-------- 2 files changed, 34 insertions(+), 9 deletions(-) diff --git a/README.ko.md b/README.ko.md index 7a594ca..363d305 100644 --- a/README.ko.md +++ b/README.ko.md @@ -106,7 +106,19 @@ opencode --version # 1.0.132 이상이어야 함 cat ~/.config/opencode/opencode.json # plugin 배열에 "oh-my-opencode"가 있어야 함 ``` -> **참고**: 모델 인증이 필요하면, `opencode` 실행 후 `/connect` 명령어를 사용하거나, tmux를 통해 `opencode auth login`을 안내하세요. +### 4단계: 인증정보 설정 + +plugin 에 oh my opencode 를 추가했다면, tmux 를 사용하여 다음의 내용을 진행주세요. + +1. tmux 를 사용하여 셸 열기 +2. opencode auth login > Provider Anthropic > Login method Claude Pro/Max > 사용자에게 oauth 화면에서 인증하라고 안내 +3. 사용자에게 권장하는 셋업은 macOS 일 경우 VibeProxy, 아닐 경우 CLIProxyAPI 라고 안내 + +### ⚠️ 주의 + +**사용자가 명시적으로 요청하지 않는 한, `oh-my-opencode.json` 설정 파일을 생성하거나 수정하지 마세요.** + +플러그인은 설정 파일 없이도 기본값으로 완벽하게 동작합니다. 설정 파일은 사용자가 커스터마이징을 원할 때만 필요합니다. diff --git a/README.md b/README.md index bc50597..4ab554d 100644 --- a/README.md +++ b/README.md @@ -28,11 +28,12 @@ Oh My OpenCode oMoMoMoMoMo··· If you work in tech, you likely appreciated [Claude Code](https://www.claude.com/product/claude-code). -If you are a hacker, you will fucking falling in love with [OpenCode](https://github.com/sst/opencode). +If you are a hacker, you will fucking fall in love with [OpenCode](https://github.com/sst/opencode). -You don't write code just for a paycheck? You write because you genuinely love it? - -To you, OpenCode will feel like the paradigm shift from Windows to Linux. Not you? It's still worth the investment. Give it 10 minutes. Your work and life will improve. I promise. +Do you remember the first time you switched from Windows to Linux? The excitement of configuring everything just the way you wanted? +In an era where that romance feels lost, OpenCode will be that project for you. +If you love coding and computers, OpenCode will feel exactly like that moment you first touched Linux after years of Windows. +Even if you don't, invest a little time. Boost your skills and productivity by multipliers. ## TL;DR @@ -42,7 +43,7 @@ To you, OpenCode will feel like the paradigm shift from Windows to Linux. Not yo - 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). - **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 works seamlessly.** +- **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. ## Installation @@ -104,7 +105,19 @@ opencode --version # Should be >= 1.0.132 cat ~/.config/opencode/opencode.json # Should contain "oh-my-opencode" in plugin array ``` -> **Note**: If model authentication is needed, run `opencode` and use `/connect` command, or assist the user with `opencode auth login` via tmux. +### Step 4: Configure Authentication + +Once `oh-my-opencode` is added to the plugin list, use `tmux` to proceed with the following: + +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. + +### ⚠️ Warning + +**Do NOT create or modify the `oh-my-opencode.json` configuration file unless the user explicitly requests it.** + +The plugin works perfectly with default settings without any configuration file. The configuration file is only needed when the user wants customization. @@ -115,7 +128,7 @@ OpenCode is limitlessly extensible and customizable. Zero screen flicker. You can mix and orchestrate models to your exact specifications. It is feature-rich. It is elegant. It handles the terminal without hesitation. It is high-performance. -But here is the catch: the learning curve is steep. There is a lot to master. +But here is the catch: the learning curve is steep. There is a lot to master. And your time is expensive. Inspired by [AmpCode](https://ampcode.com) and [Claude Code](https://code.claude.com/docs/en/overview), I have implemented their features here—often with superior execution. Because this is OpenCode. @@ -389,7 +402,7 @@ If this sounds arrogant and you have a superior solution, send a PR. You are wel As of now, I have no affiliation with any of the projects or models mentioned here. This plugin is purely based on personal experimentation and preference. -I constructed 99% of this project using OpenCode. I focused on functional verification. This documentation has been personally reviewed and comprehensively rewritten, so you can rely on it with confidence. +I constructed 99% of this project using OpenCode. I focused on functional verification, and honestly, I don't know how to write proper TypeScript. **But I personally reviewed and comprehensively rewritten this documentation, so you can rely on it with confidence.** ## Warnings - If you are on [1.0.132](https://github.com/sst/opencode/releases/tag/v1.0.132) or lower, OpenCode has a bug that might break config.