docs: qualify primary install commands
Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent) Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
This commit is contained in:
Woonggi Min
@@ -112,11 +112,11 @@ Pick the edition(s) you want.
|
||||
|
||||
| You want | Run | What lands on disk |
|
||||
| :--- | :--- | :--- |
|
||||
| **Ultimate** (OpenCode) | `bunx omo install` (TUI walks you through it) | Plugin registered in `opencode.json` + agent/model config + provider auth prompts |
|
||||
| **Light** (Codex CLI) | `bunx omo install --platform=codex` or `bunx lazycodex install` | `~/.codex/plugins/cache/sisyphuslabs/omo/` + local Codex marketplace cache + `~/.codex/config.toml` marketplace/plugin/agent blocks + optional autonomous permissions + component CLIs in `~/.local/bin` |
|
||||
| **Both** | `bunx omo install --platform=both` | Both of the above |
|
||||
| **Ultimate** (OpenCode) | `bunx --package oh-my-openagent omo install` (TUI walks you through it) | Plugin registered in `opencode.json` + agent/model config + provider auth prompts |
|
||||
| **Light** (Codex CLI) | `bunx --package oh-my-openagent omo install --platform=codex` or `bunx --package @code-yeongyu/lazycodex lazycodex install` | `~/.codex/plugins/cache/sisyphuslabs/omo/` + local Codex marketplace cache + `~/.codex/config.toml` marketplace/plugin/agent blocks + optional autonomous permissions + component CLIs in `~/.local/bin` |
|
||||
| **Both** | `bunx --package oh-my-openagent omo install --platform=both` | Both of the above |
|
||||
|
||||
`--platform` defaults to `opencode` (Ultimate). The `bunx lazycodex install` alias is a shortcut for `bunx omo install --platform=codex`; use whichever reads cleaner.
|
||||
`--platform` defaults to `opencode` (Ultimate). The `bunx --package @code-yeongyu/lazycodex lazycodex install` alias is a shortcut for `bunx --package oh-my-openagent omo install --platform=codex`; use whichever reads cleaner.
|
||||
|
||||
### For Humans
|
||||
|
||||
@@ -132,11 +132,11 @@ https://raw.githubusercontent.com/code-yeongyu/oh-my-openagent/refs/heads/dev/do
|
||||
If you only want the **Light edition** (Codex CLI), the installer asks whether to configure Codex for autonomous full-permissions mode. You can run it yourself in one line:
|
||||
|
||||
```bash
|
||||
bunx omo install --platform=codex
|
||||
bunx --package oh-my-openagent omo install --platform=codex
|
||||
# equivalent:
|
||||
bunx lazycodex install
|
||||
bunx --package @code-yeongyu/lazycodex lazycodex install
|
||||
# non-interactive recommended mode:
|
||||
bunx lazycodex install --no-tui --codex-autonomous
|
||||
bunx --package @code-yeongyu/lazycodex lazycodex install --no-tui --codex-autonomous
|
||||
```
|
||||
|
||||
> **Do not** use `npm install -g`, `bun add -g`, or `bun install -g`. Global installation is not officially supported — oh-my-openagent is a plugin that must resolve from where OpenCode/Codex loads plugins. Always invoke via `bunx`.
|
||||
@@ -155,7 +155,7 @@ The guide covers: platform selection, the subscription interview, provider authe
|
||||
|
||||
The published npm package and CLI binary are still named `oh-my-opencode` (dual-published as `oh-my-openagent` during the rename transition). Inside `opencode.json`, the compatibility layer prefers the plugin entry `oh-my-openagent`, while legacy `oh-my-opencode` entries still load with a warning. Plugin config files still commonly use `oh-my-opencode.json[c]`; both legacy and renamed basenames are recognized.
|
||||
|
||||
All four `bunx` aliases - `oh-my-opencode`, `oh-my-openagent`, `omo`, `lazycodex` - invoke the same compiled CLI. `omo` is the recommended short form for documentation and prompts. `lazycodex` is a single-purpose npm/bin alias: `bunx lazycodex install` is exactly equivalent to `bunx omo install --platform=codex`. It is not the Codex marketplace name. Codex sees marketplace `sisyphuslabs` and plugin `omo`, enabled as `omo@sisyphuslabs`.
|
||||
All four `bunx` aliases - `oh-my-opencode`, `oh-my-openagent`, `omo`, `lazycodex` - invoke the same compiled CLI. `omo` is the recommended short form for documentation and prompts. `lazycodex` is a single-purpose npm/bin alias: `bunx --package @code-yeongyu/lazycodex lazycodex install` is exactly equivalent to `bunx --package oh-my-openagent omo install --platform=codex`. It is not the Codex marketplace name. Codex sees marketplace `sisyphuslabs` and plugin `omo`, enabled as `omo@sisyphuslabs`.
|
||||
|
||||
### Telemetry
|
||||
|
||||
@@ -204,7 +204,7 @@ Even with only the following subscriptions, `ultrawork` works well (this project
|
||||
| | Feature | Edition | What it does |
|
||||
| :---: | :------------------------------------------------------- | :------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| 🤖 | **Discipline Agents** | Ultimate | Sisyphus orchestrates Hephaestus, Oracle, Librarian, Explore. A full AI dev team in parallel. |
|
||||
| 🧩 | **Codex CLI Light Edition** | Light | Portable OMO components (rules, comment-checker, LSP, ultrawork, ulw-loop, start-work continuation, telemetry) running inside OpenAI Codex CLI. Install via `bunx omo install --platform=codex`. |
|
||||
| 🧩 | **Codex CLI Light Edition** | Light | Portable OMO components (rules, comment-checker, LSP, ultrawork, ulw-loop, start-work continuation, telemetry) running inside OpenAI Codex CLI. Install via `bunx --package oh-my-openagent omo install --platform=codex`. |
|
||||
| 👥 | **Team Mode** (v4.0, opt-in) | Ultimate | 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`** | Both | One word. Every agent activates. Doesn't stop until done. |
|
||||
| 🚪 | **[IntentGate](https://factory.ai/news/terminal-bench)** | Ultimate | Analyzes true user intent before classifying or acting. No more literal misinterpretations. (Light edition only recognises the `ultrawork`/`ulw` keyword.) |
|
||||
@@ -224,7 +224,7 @@ Even with only the following subscriptions, `ultrawork` works well (this project
|
||||
| 📋 | **Prometheus Planner** | Ultimate | Interview-mode strategic planning before any execution. |
|
||||
| 🔍 | **`/init-deep`** | Ultimate | Auto-generates hierarchical `AGENTS.md` files throughout your project. Great for both token efficiency and your agent's performance. |
|
||||
|
||||
> **Edition legend.** **Ultimate** = OpenCode-only (`bunx omo install`). **Light** = Codex CLI-only (`bunx omo install --platform=codex`). **Both** = shipped in both editions, often with slightly different implementations under the hood.
|
||||
> **Edition legend.** **Ultimate** = OpenCode-only (`bunx --package oh-my-openagent omo install`). **Light** = Codex CLI-only (`bunx --package oh-my-openagent omo install --platform=codex`). **Both** = shipped in both editions, often with slightly different implementations under the hood.
|
||||
|
||||
### Discipline Agents
|
||||
|
||||
|
||||
Reference in New Issue
Block a user