docs: document --codex installer, lazycodex shortcut, omo_codex_daily_active telemetry
This commit is contained in:
YeonGyu-Kim
@@ -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