docs: document --codex installer, lazycodex shortcut, omo_codex_daily_active telemetry
This commit is contained in:
@@ -22,6 +22,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
- Per-agent `displayName` for i18n. Agents can present localized names in UI and logs. (PR #4081)
|
||||
- Grok family models registered with `reasoningEffort` support. (PR #4186)
|
||||
- CLI `setup` alias for `install`. Either command runs the interactive setup wizard. (PR #4174)
|
||||
- Codex harness adapter (`omo-codex`): one-command install via `bunx omo install --codex=yes` or the new `lazycodex` bin entry. Vendored Codex plugin namespace `omo` with rules, comment-checker, LSP, ultrawork, and ultragoal components. Plugin lands in `~/.codex/plugins/cache/code-yeongyu-codex-plugins/omo/` and is enabled in `~/.codex/config.toml`. Idempotent installer (re-running is safe).
|
||||
- Three new bin entries: `omo` (short alias) and `lazycodex` (auto-defaults `--codex=yes`). Existing `oh-my-opencode` and `oh-my-openagent` continue to work unchanged.
|
||||
- New PostHog telemetry stream `omo_codex_daily_active` distinguishing omo-codex installations from omo-opencode. Independent opt-out via `OMO_CODEX_DISABLE_POSTHOG=1` or `OMO_CODEX_SEND_ANONYMOUS_TELEMETRY=0`; global `OMO_DISABLE_POSTHOG` and `OMO_SEND_ANONYMOUS_TELEMETRY` still suppress both products.
|
||||
- Triple-publish to npm: `oh-my-opencode`, `oh-my-openagent`, and the new `lazycodex` package with the same compiled CLI and four bin commands. See `docs/reference/lazycodex-npm-reservation.md` for the first-publish playbook.
|
||||
|
||||
### Changed
|
||||
|
||||
|
||||
@@ -123,6 +123,8 @@ curl -s https://raw.githubusercontent.com/code-yeongyu/oh-my-openagent/refs/head
|
||||
|
||||
匿名のテレメトリは、アクティブなインストール数(DAU/WAU/MAU)の集計のためにデフォルトで有効になっています。マシン1台につきUTC日あたり最大1回イベントが送信され、ハッシュ化されたインストール識別子を使用し、生のホスト名は使用せず、PostHog person profile も作成されません。無効化するには `OMO_SEND_ANONYMOUS_TELEMETRY=0` または `OMO_DISABLE_POSTHOG=1` を設定してください。[プライバシーポリシー](docs/legal/privacy-policy.md)と[利用規約](docs/legal/terms-of-service.md)をご覧ください。
|
||||
|
||||
OpenAI Codex CLI も使う場合は、オプションの Codex アダプターを `bunx omo install --codex=yes` かショートカットの `bunx lazycodex install` で追加できます。Codex 専用テレメトリは `OMO_CODEX_DISABLE_POSTHOG=1` または `OMO_CODEX_SEND_ANONYMOUS_TELEMETRY=0` で無効化できます。
|
||||
|
||||
---
|
||||
|
||||
## この README をスキップする
|
||||
@@ -153,6 +155,7 @@ Read this and tell me why it's not just another boilerplate: https://raw.githubu
|
||||
| | 機能 | 何をするのか |
|
||||
| :---: | :------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| 🤖 | **規律あるエージェント (Discipline Agents)** | Sisyphus が Hephaestus、Oracle、Librarian、Explore をオーケストレーションします。完全な AI 開発チームが並列で動きます。 |
|
||||
| 🧩 | **Codex Harness Adapter** | OpenAI Codex CLI でも同じ OMO 機能を利用できます。`bunx lazycodex install` または `bunx omo install --codex=yes` で導入できます。 |
|
||||
| 👥 | **Team Mode** (v4.0, オプトイン) | リードエージェント + 最大 8 メンバーの並列実行、リアルタイム tmux 可視化、専用 `team_*` ツール群。`hyperplan`(5 人の敵対的批評家)と `security-research`(3 人のハンター + 2 人の PoC エンジニア)を駆動します。[ドキュメント →](docs/guide/team-mode.md) |
|
||||
| ⚡ | **`ultrawork` / `ulw`** | 一言で OK。すべてのエージェントがアクティブになり、終わるまで止まりません。 |
|
||||
| 🚪 | **[IntentGate](https://factory.ai/news/terminal-bench)** | ユーザーの真の意図を分析してから分類・行動します。もう文字通りに誤解して的外れなことをすることはありません。 |
|
||||
@@ -339,6 +342,14 @@ oh-my-openagent を削除するには:
|
||||
# プラグインがロードされなくなっているはずです
|
||||
```
|
||||
|
||||
4. **omo-codex (Codex アダプター) を削除する**
|
||||
|
||||
```bash
|
||||
rm -rf ~/.codex/plugins/cache/code-yeongyu-codex-plugins
|
||||
```
|
||||
|
||||
その後 `~/.codex/config.toml` を開き、`[plugins."omo@code-yeongyu-codex-plugins"]` ブロックと `[hooks.state.\"omo@...\"]` ブロックを削除してください。
|
||||
|
||||
## Features
|
||||
|
||||
最初から存在していて当然だと感じる機能たち。一度使うと戻れなくなります。
|
||||
|
||||
@@ -124,6 +124,8 @@ curl -s https://raw.githubusercontent.com/code-yeongyu/oh-my-openagent/refs/head
|
||||
|
||||
익명 텔레메트리는 활성 설치 수(DAU/WAU/MAU) 집계를 위해 기본적으로 활성화되어 있습니다. 머신당 UTC 하루에 최대 1회만 이벤트가 전송되며, 해시된 설치 식별자를 사용하고 원시 호스트명은 절대 사용하지 않으며 PostHog person profile은 생성되지 않습니다. `OMO_SEND_ANONYMOUS_TELEMETRY=0` 또는 `OMO_DISABLE_POSTHOG=1`로 비활성화할 수 있습니다. [개인정보처리방침](docs/legal/privacy-policy.md)과 [서비스 이용약관](docs/legal/terms-of-service.md)을 참조하세요.
|
||||
|
||||
OpenAI Codex CLI도 사용한다면 선택 사항인 Codex 어댑터를 `bunx omo install --codex=yes` 또는 바로가기 `bunx lazycodex install`로 함께 설치하세요. Codex 전용 텔레메트리는 `OMO_CODEX_DISABLE_POSTHOG=1` 또는 `OMO_CODEX_SEND_ANONYMOUS_TELEMETRY=0`으로 비활성화할 수 있습니다.
|
||||
|
||||
---
|
||||
|
||||
## 이 README 건너뛰기
|
||||
@@ -154,6 +156,7 @@ Read this and tell me why it's not just another boilerplate: https://raw.githubu
|
||||
| | 기능 | 하는 일 |
|
||||
| :---: | :------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| 🤖 | **Discipline Agents** | Sisyphus가 Hephaestus, Oracle, Librarian, Explore를 지휘합니다. 병렬로 도는 풀스택 AI 개발팀. |
|
||||
| 🧩 | **Codex Harness Adapter** | OpenAI Codex CLI에서도 동일한 OMO 기능을 제공합니다. `bunx lazycodex install` 또는 `bunx omo install --codex=yes`로 설치하세요. |
|
||||
| 👥 | **Team Mode** (v4.0, opt-in) | 리드 에이전트 + 최대 8명의 병렬 멤버, 실시간 tmux 시각화, 전용 `team_*` 도구. `hyperplan`(5명의 적대적 비평가)과 `security-research`(3명의 헌터 + 2명의 PoC 엔지니어)를 구동합니다. [문서 →](docs/guide/team-mode.md) |
|
||||
| ⚡ | **`ultrawork` / `ulw`** | 한 단어. 모든 에이전트가 켜집니다. 끝날 때까지 멈추지 않습니다. |
|
||||
| 🚪 | **[IntentGate](https://factory.ai/news/terminal-bench)** | 분류하거나 행동하기 전에 사용자의 진짜 의도부터 분석합니다. 문자 그대로 오해하는 일은 끝. |
|
||||
@@ -340,6 +343,14 @@ oh-my-openagent를 제거하려면:
|
||||
# 더 이상 플러그인이 로드되지 않아야 합니다
|
||||
```
|
||||
|
||||
4. **omo-codex (Codex 어댑터) 제거**
|
||||
|
||||
```bash
|
||||
rm -rf ~/.codex/plugins/cache/code-yeongyu-codex-plugins
|
||||
```
|
||||
|
||||
그런 다음 `~/.codex/config.toml`을 열어 `[plugins."omo@code-yeongyu-codex-plugins"]` 블록과 `[hooks.state.\"omo@...\"]` 블록들을 삭제하세요.
|
||||
|
||||
## Features
|
||||
|
||||
진작 있었어야 했다고 느낄 기능들입니다. 한 번 쓰면 되돌아갈 수 없습니다.
|
||||
|
||||
@@ -124,6 +124,8 @@ curl -s https://raw.githubusercontent.com/code-yeongyu/oh-my-openagent/refs/head
|
||||
|
||||
Anonymous telemetry is enabled by default to track active installations (DAU/WAU/MAU). A single event is sent at most once per UTC day per machine using a hashed installation identifier, never the raw hostname, and PostHog person profiles are not created. Disable with `OMO_SEND_ANONYMOUS_TELEMETRY=0` or `OMO_DISABLE_POSTHOG=1`. See [Privacy Policy](docs/legal/privacy-policy.md) and [Terms of Service](docs/legal/terms-of-service.md).
|
||||
|
||||
If you also use OpenAI Codex CLI, add the optional Codex adapter with `bunx omo install --codex=yes` or the shortcut `bunx lazycodex install`. Codex-only telemetry can be disabled with `OMO_CODEX_DISABLE_POSTHOG=1` or `OMO_CODEX_SEND_ANONYMOUS_TELEMETRY=0`.
|
||||
|
||||
---
|
||||
|
||||
## Skip This README
|
||||
@@ -160,6 +162,7 @@ Even with only the following subscriptions, `ultrawork` works well (this project
|
||||
| | Feature | What it does |
|
||||
| :---: | :------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| 🤖 | **Discipline Agents** | Sisyphus orchestrates Hephaestus, Oracle, Librarian, Explore. A full AI dev team in parallel. |
|
||||
| 🧩 | **Codex Harness Adapter** | Same OMO features for OpenAI Codex CLI. Install via `bunx lazycodex install` or `bunx omo install --codex=yes`. |
|
||||
| 👥 | **Team Mode** (v4.0, opt-in) | Lead agent + up to 8 parallel members, real-time tmux visualization, dedicated `team_*` tools. Powers `hyperplan` (5 hostile critics) and `security-research` (3 hunters + 2 PoC engineers). [Docs →](docs/guide/team-mode.md) |
|
||||
| ⚡ | **`ultrawork` / `ulw`** | One word. Every agent activates. Doesn't stop until done. |
|
||||
| 🚪 | **[IntentGate](https://factory.ai/news/terminal-bench)** | Analyzes true user intent before classifying or acting. No more literal misinterpretations. |
|
||||
@@ -346,6 +349,14 @@ To remove oh-my-openagent:
|
||||
# Plugin should no longer be loaded
|
||||
```
|
||||
|
||||
4. **Remove omo-codex (Codex adapter)**
|
||||
|
||||
```bash
|
||||
rm -rf ~/.codex/plugins/cache/code-yeongyu-codex-plugins
|
||||
```
|
||||
|
||||
Then open `~/.codex/config.toml` and remove the `[plugins."omo@code-yeongyu-codex-plugins"]` block and any `[hooks.state.\"omo@...\"]` blocks.
|
||||
|
||||
## Features
|
||||
|
||||
Features you'll think should've always existed. Once you use them, you can't go back.
|
||||
|
||||
@@ -121,6 +121,8 @@ curl -s https://raw.githubusercontent.com/code-yeongyu/oh-my-openagent/refs/head
|
||||
|
||||
Анонимная телеметрия включена по умолчанию для подсчёта активных установок (DAU/WAU/MAU). Не более одного события на машину за UTC-сутки, использует хешированный идентификатор установки, никогда не использует исходное имя хоста, и не создаёт PostHog person profile. Можно отключить через `OMO_SEND_ANONYMOUS_TELEMETRY=0` или `OMO_DISABLE_POSTHOG=1`. См. [Политику конфиденциальности](docs/legal/privacy-policy.md) и [Условия обслуживания](docs/legal/terms-of-service.md).
|
||||
|
||||
Если вы также используете OpenAI Codex CLI, установите дополнительный Codex-адаптер через `bunx omo install --codex=yes` или короткую команду `bunx lazycodex install`. Телеметрию только для Codex можно отключить через `OMO_CODEX_DISABLE_POSTHOG=1` или `OMO_CODEX_SEND_ANONYMOUS_TELEMETRY=0`.
|
||||
|
||||
------
|
||||
|
||||
## Пропустите этот README
|
||||
@@ -152,6 +154,7 @@ Read this and tell me why it's not just another boilerplate: https://raw.githubu
|
||||
| | Функция | Что делает |
|
||||
| --- | -------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| 🤖 | **Дисциплинированные агенты** | Sisyphus оркестрирует Hephaestus, Oracle, Librarian, Explore. Полноценная AI-команда разработки в параллельном режиме. |
|
||||
| 🧩 | **Codex Harness Adapter** | Те же возможности OMO для OpenAI Codex CLI. Установка через `bunx lazycodex install` или `bunx omo install --codex=yes`. |
|
||||
| 👥 | **Team Mode** (v4.0, opt-in) | Лид-агент + до 8 параллельных участников, визуализация в tmux в реальном времени, выделенные инструменты `team_*`. Питает `hyperplan` (5 враждебных критиков) и `security-research` (3 охотника + 2 PoC-инженера). [Документация →](docs/guide/team-mode.md) |
|
||||
| ⚡ | **`ultrawork` / `ulw`** | Одно слово. Все агенты активируются. Не останавливается, пока задача не выполнена. |
|
||||
| 🚪 | **[IntentGate](https://factory.ai/news/terminal-bench)** | Анализирует истинное намерение пользователя перед классификацией и действием. Никакого буквального неверного толкования. |
|
||||
@@ -338,6 +341,14 @@ project/
|
||||
# Плагин больше не должен загружаться
|
||||
```
|
||||
|
||||
4. **Удалите omo-codex (Codex-адаптер)**
|
||||
|
||||
```bash
|
||||
rm -rf ~/.codex/plugins/cache/code-yeongyu-codex-plugins
|
||||
```
|
||||
|
||||
Затем откройте `~/.codex/config.toml` и удалите блок `[plugins."omo@code-yeongyu-codex-plugins"]` и все блоки `[hooks.state.\"omo@...\"]`.
|
||||
|
||||
## Функции
|
||||
|
||||
Функции, которые, как вы будете думать, должны были существовать всегда. Попробовав раз, вы не сможете вернуться назад.
|
||||
|
||||
@@ -123,6 +123,8 @@ curl -s https://raw.githubusercontent.com/code-yeongyu/oh-my-openagent/refs/head
|
||||
|
||||
匿名遥测默认开启,用于统计活跃安装数(DAU/WAU/MAU)。每台机器每个 UTC 日最多发送一次事件,使用哈希化的安装标识符,绝不会使用原始主机名,且不会创建 PostHog person profile。可通过 `OMO_SEND_ANONYMOUS_TELEMETRY=0` 或 `OMO_DISABLE_POSTHOG=1` 禁用。详见 [隐私政策](docs/legal/privacy-policy.md) 和 [服务条款](docs/legal/terms-of-service.md)。
|
||||
|
||||
如果你也使用 OpenAI Codex CLI,可以额外安装可选的 Codex 适配器:`bunx omo install --codex=yes`,或使用快捷命令 `bunx lazycodex install`。Codex 专用遥测可通过 `OMO_CODEX_DISABLE_POSTHOG=1` 或 `OMO_CODEX_SEND_ANONYMOUS_TELEMETRY=0` 禁用。
|
||||
|
||||
---
|
||||
|
||||
## 跳过这个 README 吧
|
||||
@@ -153,6 +155,7 @@ Read this and tell me why it's not just another boilerplate: https://raw.githubu
|
||||
| | 特性 | 功能说明 |
|
||||
| :---: | :-------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| 🤖 | **自律军团 (Discipline Agents)** | Sisyphus 负责调度 Hephaestus、Oracle、Librarian 和 Explore。一支完整的 AI 开发团队并行工作。 |
|
||||
| 🧩 | **Codex Harness Adapter** | 在 OpenAI Codex CLI 中也能使用同样的 OMO 功能。通过 `bunx lazycodex install` 或 `bunx omo install --codex=yes` 安装。 |
|
||||
| 👥 | **Team Mode** (v4.0, 选择性启用) | 领导 Agent + 最多 8 个并行成员,实时 tmux 可视化,专用 `team_*` 工具家族。驱动 `hyperplan`(5 个敌对评论者) 和 `security-research`(3 个猎手 + 2 个 PoC 工程师)。[文档 →](docs/guide/team-mode.md) |
|
||||
| ⚡ | **`ultrawork` / `ulw`** | 一键触发,所有智能体出动。任务完成前绝不罢休。 |
|
||||
| 🚪 | **[IntentGate 意图门](https://factory.ai/news/terminal-bench)** | 真正行动前,先分析用户的真实意图。彻底告别被字面意思误导的 AI 废话。 |
|
||||
@@ -339,6 +342,14 @@ Agent 会自动顺藤摸瓜加载对应的 Context,免去了你所有的手动
|
||||
# 这个时候就应该没有任何关于插件的输出信息了
|
||||
```
|
||||
|
||||
4. **移除 omo-codex(Codex 适配器)**
|
||||
|
||||
```bash
|
||||
rm -rf ~/.codex/plugins/cache/code-yeongyu-codex-plugins
|
||||
```
|
||||
|
||||
然后打开 `~/.codex/config.toml`,删除 `[plugins."omo@code-yeongyu-codex-plugins"]` 区块,以及所有 `[hooks.state.\"omo@...\"]` 区块。
|
||||
|
||||
## Features
|
||||
|
||||
那种"这个功能本来就该一直存在"的感觉。一用就回不去。
|
||||
|
||||
@@ -21,6 +21,7 @@
|
||||
| Known issues & workarounds | [docs/reference/known-issues.md](file:///Users/yeongyu/local-workspaces/omo/docs/reference/known-issues.md) |
|
||||
| `prompt_async_gate` deep-dive | [docs/reference/prompt-async-gate-rfc.md](file:///Users/yeongyu/local-workspaces/omo/docs/reference/prompt-async-gate-rfc.md) |
|
||||
| Release process | [docs/reference/release-process.md](file:///Users/yeongyu/local-workspaces/omo/docs/reference/release-process.md) |
|
||||
| Claiming the lazycodex npm name | [docs/reference/lazycodex-npm-reservation.md](file:///Users/yeongyu/local-workspaces/omo/docs/reference/lazycodex-npm-reservation.md) |
|
||||
| Rules-injector cross-module comparison | [docs/reference/rules-injection-cross-module-comparison.md](file:///Users/yeongyu/local-workspaces/omo/docs/reference/rules-injection-cross-module-comparison.md) |
|
||||
| Sample configs | [docs/examples/](file:///Users/yeongyu/local-workspaces/omo/docs/examples/) (default, coding-focused, planning-focused) |
|
||||
| Privacy & ToS | [docs/legal/](file:///Users/yeongyu/local-workspaces/omo/docs/legal/) |
|
||||
|
||||
@@ -25,10 +25,25 @@ Use Bun only for installation. Do not use npm, yarn, or pnpm.
|
||||
|
||||
Follow the prompts to configure your Claude, ChatGPT, and Gemini subscriptions. After installation, authenticate your providers as instructed.
|
||||
|
||||
Anonymous telemetry is enabled by default to track active installations (DAU/WAU/MAU). A single event is sent at most once per UTC day per machine using a hashed installation identifier, and PostHog person profiles are not created. Disable with `OMO_SEND_ANONYMOUS_TELEMETRY=0` or `OMO_DISABLE_POSTHOG=1`. See [Privacy Policy](../legal/privacy-policy.md) and [Terms of Service](../legal/terms-of-service.md).
|
||||
Anonymous telemetry is enabled by default to track active installations (DAU/WAU/MAU). A single event is sent at most once per UTC day per machine using a hashed installation identifier, and PostHog person profiles are not created. Disable with `OMO_SEND_ANONYMOUS_TELEMETRY=0` or `OMO_DISABLE_POSTHOG=1`. If you install `omo-codex`, it sends a separate `omo_codex_daily_active` event with the same daily limit and hashed identifier behavior, and it can also be disabled with `OMO_CODEX_DISABLE_POSTHOG=1` or `OMO_CODEX_SEND_ANONYMOUS_TELEMETRY=0`. See [Privacy Policy](../legal/privacy-policy.md) and [Terms of Service](../legal/terms-of-service.md).
|
||||
|
||||
After you install it, you can read this [overview guide](./overview.md) to understand more.
|
||||
|
||||
### Codex Adapter (optional)
|
||||
|
||||
`omo-codex` adds Codex-native hooks so OpenAI Codex CLI gets the same OMO components: rules injection, comment-checker, LSP MCP integration, ultrawork, and ultragoal.
|
||||
|
||||
Install it with either command:
|
||||
|
||||
```bash
|
||||
bunx omo install --codex=yes
|
||||
bunx lazycodex install
|
||||
```
|
||||
|
||||
The adapter writes under `~/.codex/`, updates `~/.codex/config.toml`, and installs component entry points into `~/.local/bin/`.
|
||||
|
||||
Telemetry opt-out follows the same policy as oh-my-openagent. See [Privacy Policy](../legal/privacy-policy.md).
|
||||
|
||||
The project is dual-published during the rename transition: `oh-my-openagent` and `oh-my-opencode` are both published package names. Inside `opencode.json`, the compatibility layer now prefers the plugin entry `oh-my-openagent`, while legacy `oh-my-opencode` entries still load with a warning. Plugin config loading recognizes both `oh-my-openagent.json[c]` and `oh-my-opencode.json[c]` during the transition. If you see a "Using legacy package name" warning from `bunx oh-my-openagent doctor`, update your `opencode.json` plugin entry from `"oh-my-opencode"` to `"oh-my-openagent"`.
|
||||
|
||||
Postinstall validates both platform binary resolution and OpenCode version compatibility.
|
||||
@@ -102,6 +117,10 @@ Ask the user these questions to determine CLI options:
|
||||
- If **yes** → `--vercel-ai-gateway=yes`
|
||||
- If **no** → `--vercel-ai-gateway=no` (default)
|
||||
|
||||
10. **Do you want to install the Codex harness adapter (`omo-codex`)?**
|
||||
- **Yes** (recommended if you use OpenAI Codex CLI)
|
||||
- **No**
|
||||
|
||||
**Provider selection is agent-specific.** The installer and runtime do not use one single global provider priority. Each agent resolves against its own fallback chain.
|
||||
|
||||
MUST STRONGLY WARNING, WHEN USER SAID THEY DON'T HAVE CLAUDE SUBSCRIPTION, SISYPHUS AGENT MIGHT NOT WORK IDEALLY.
|
||||
@@ -125,7 +144,7 @@ Spawn a subagent to handle installation and report back - to save context.
|
||||
Based on user's answers, run the CLI installer with appropriate flags:
|
||||
|
||||
```bash
|
||||
bunx oh-my-openagent install --no-tui --claude=<yes|no|max20> --gemini=<yes|no> --copilot=<yes|no> [--openai=<yes|no>] [--opencode-go=<yes|no>] [--opencode-zen=<yes|no>] [--zai-coding-plan=<yes|no>] [--kimi-for-coding=<yes|no>] [--vercel-ai-gateway=<yes|no>] [--skip-auth]
|
||||
bunx oh-my-openagent install --no-tui --claude=<yes|no|max20> --gemini=<yes|no> --copilot=<yes|no> [--openai=<yes|no>] [--opencode-go=<yes|no>] [--opencode-zen=<yes|no>] [--zai-coding-plan=<yes|no>] [--kimi-for-coding=<yes|no>] [--vercel-ai-gateway=<yes|no>] [--codex=<yes|no>] [--skip-auth]
|
||||
```
|
||||
|
||||
**Examples:**
|
||||
@@ -138,6 +157,8 @@ bunx oh-my-openagent install --no-tui --claude=<yes|no|max20> --gemini=<yes|no>
|
||||
- User has only OpenCode Zen: `bunx oh-my-openagent install --no-tui --claude=no --gemini=no --copilot=no --opencode-zen=yes`
|
||||
- User has OpenCode Go only: `bunx oh-my-openagent install --no-tui --claude=no --openai=no --gemini=no --copilot=no --opencode-go=yes`
|
||||
- User has no subscriptions: `bunx oh-my-openagent install --no-tui --claude=no --gemini=no --copilot=no`
|
||||
- User wants OpenCode + Codex adapter together: `bunx oh-my-openagent install --no-tui --claude=yes --gemini=no --copilot=no --codex=yes`
|
||||
- Codex-first shortcut (`--codex=yes` by default): `bunx lazycodex install --no-tui --claude=no --gemini=no --copilot=no`
|
||||
|
||||
The CLI will:
|
||||
|
||||
|
||||
@@ -17,6 +17,7 @@ We collect limited non-personal information needed to operate and improve the Se
|
||||
When anonymous telemetry is enabled, the Application may collect a single anonymous usage event:
|
||||
|
||||
- `omo_daily_active`, sent at most once per UTC day per machine when the plugin loads or when the `run` CLI is invoked, used to estimate daily, weekly, and monthly active installations
|
||||
- `omo_codex_daily_active`, sent at most once per UTC day per machine when the `omo-codex` adapter is installed or used, with the same opt-out posture as `omo_daily_active`
|
||||
- Anonymous machine metadata bundled with that event, such as package version, plugin name, runtime, OS family, locale, and timezone
|
||||
- A pseudonymous installation identifier derived from a one-way hash of the local hostname
|
||||
|
||||
@@ -36,8 +37,14 @@ Telemetry can be disabled at any time by setting one of these environment variab
|
||||
export OMO_SEND_ANONYMOUS_TELEMETRY=0
|
||||
# or
|
||||
export OMO_DISABLE_POSTHOG=1
|
||||
# codex-only opt-out flags
|
||||
export OMO_CODEX_DISABLE_POSTHOG=1
|
||||
export OMO_CODEX_SEND_ANONYMOUS_TELEMETRY=0
|
||||
```
|
||||
|
||||
`OMO_CODEX_DISABLE_POSTHOG` and `OMO_CODEX_SEND_ANONYMOUS_TELEMETRY` suppress only `omo-codex` telemetry.
|
||||
Global flags (`OMO_DISABLE_POSTHOG`, `OMO_SEND_ANONYMOUS_TELEMETRY`) suppress telemetry for both oh-my-openagent/oh-my-opencode and omo-codex.
|
||||
|
||||
When telemetry is disabled, PostHog events are not sent.
|
||||
|
||||
## 3. Third-Party Services
|
||||
|
||||
+18
-1
@@ -7,6 +7,15 @@ Complete reference for the published CLI package. During the rename transition,
|
||||
|
||||
Plugin registration inside `opencode.json` prefers `oh-my-openagent`.
|
||||
|
||||
## Bin Commands
|
||||
|
||||
All published packages expose the same compiled CLI with these bin entries:
|
||||
|
||||
- `oh-my-opencode` (legacy name, still primary)
|
||||
- `oh-my-openagent` (renamed primary)
|
||||
- `omo` (short alias)
|
||||
- `lazycodex` (Codex-default alias; `lazycodex install` implies `--codex=yes` unless explicitly overridden)
|
||||
|
||||
## Basic Usage
|
||||
|
||||
```bash
|
||||
@@ -56,9 +65,17 @@ bunx oh-my-openagent install
|
||||
| `--kimi-for-coding <value>` | Kimi For Coding subscription: `no`, `yes` |
|
||||
| `--opencode-go <value>` | OpenCode Go subscription: `no`, `yes` |
|
||||
| `--vercel-ai-gateway <value>` | Vercel AI Gateway: `no`, `yes` |
|
||||
| `--codex <value>` | Install Codex adapter (`omo-codex`): `no`, `yes` |
|
||||
| `--skip-auth` | Skip authentication setup hints |
|
||||
|
||||
Anonymous telemetry uses PostHog with a hashed installation identifier. Disable with `OMO_SEND_ANONYMOUS_TELEMETRY=0` or `OMO_DISABLE_POSTHOG=1`.
|
||||
When using the `lazycodex` bin alias, `install` defaults to `--codex=yes`.
|
||||
|
||||
### Telemetry and opt-out
|
||||
|
||||
Anonymous telemetry uses PostHog with a hashed installation identifier.
|
||||
|
||||
- Global opt-out for oh-my-openagent and omo-codex: `OMO_SEND_ANONYMOUS_TELEMETRY=0` or `OMO_DISABLE_POSTHOG=1`
|
||||
- Codex-only opt-out for `omo_codex_daily_active`: `OMO_CODEX_SEND_ANONYMOUS_TELEMETRY=0` or `OMO_CODEX_DISABLE_POSTHOG=1`
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1007,6 +1007,8 @@ When enabled, OmO registers the hash-anchored `edit` tool and activates the `has
|
||||
| `OPENCODE_CONFIG_DIR` | Override OpenCode config directory (useful for profile isolation) |
|
||||
| `OMO_SEND_ANONYMOUS_TELEMETRY` | Set to `0`, `false`, or `no` to disable anonymous telemetry |
|
||||
| `OMO_DISABLE_POSTHOG` | Legacy telemetry opt-out flag. Set to `1` or `true` to disable PostHog |
|
||||
| `OMO_CODEX_DISABLE_POSTHOG` | Set to `1` or `true` to disable PostHog telemetry for the `omo-codex` adapter only. Does not affect oh-my-opencode telemetry |
|
||||
| `OMO_CODEX_SEND_ANONYMOUS_TELEMETRY` | Set to `0`, `false`, or `no` to disable anonymous telemetry for `omo-codex` only |
|
||||
| `POSTHOG_API_KEY` | Optional override for the built-in PostHog project API key |
|
||||
| `POSTHOG_HOST` | Override the PostHog ingestion host. Defaults to `https://us.i.posthog.com` |
|
||||
|
||||
|
||||
Reference in New Issue
Block a user