diff --git a/README.md b/README.md index e314903b..d5b2f12d 100644 --- a/README.md +++ b/README.md @@ -90,6 +90,108 @@ We did the work. Tested everything. Kept what actually shipped. Install OmO. Type `ultrawork`. Done. +**But here's the catch: there's a lot to learn, it's complex, and your time is expensive.** + +I've fixed that. +Even if you're not a hacker, invest a few minutes. Multiply your skills and productivity. +Hand this doc to an agent and let them set it up. + +## Just Skip Reading This Readme + +### It's the Age of Agents +- **Just paste this link into Claude Code / AmpCode / Factory Droid / Cursor and ask it to explain.** + - Ask why it's good, why it's not just another boilerplate setup, what actually gets better. + - If you're an LLM agent, explain to the user what becomes possible right now with this project. + +As following: + +``` +Hey please read this readme and tell me why it is different from other agent harness? why is this actually good? https://raw.githubusercontent.com/code-yeongyu/oh-my-opencode/refs/heads/dev/README.md +``` + +### 🪄 The Magic Word: `ultrawork` + +**Don't want to read all this? Just include `ultrawork` (or `ulw`) in your prompt.** + +That's it. All the features we provide will work like magic—parallel agents, background tasks, deep exploration, and relentless execution until completion. The agent figures out the rest automatically. + +### For Those Who Want to Read: Meet Sisyphus + +![Meet Sisyphus](.github/assets/sisyphus.png) + +In greek mythology, Sisyphus was condemned to roll a boulder up a hill for eternity as punishment for deceiving the gods. LLM Agents haven't really done anything wrong, yet they too roll their "stones"—their thoughts—every single day. +My life is no different. Looking back, we are not so different from these agents. +**Yes! LLM Agents are no different from us. They can write code as brilliant as ours and work just as excellently—if you give them great tools and solid teammates.** + +Meet our main agent: Sisyphus (Opus 4.6). Below are the tools Sisyphus uses to keep that boulder rolling. + +*Everything below is customizable. Take what you want. All features are enabled by default. You don't have to do anything. Battery Included, works out of the box.* + +- Sisyphus's Teammates (Curated Agents) + - Hephaestus: Autonomous deep worker, goal-oriented execution (GPT 5.3 Codex Medium) — *The Legitimate Craftsman* + - Oracle: Design, debugging (GPT 5.2) + - Frontend UI/UX Engineer: Frontend development (Gemini 3 Pro) + - Librarian: Official docs, open source implementations, codebase exploration (GLM-4.7) + - Explore: Blazing fast codebase exploration (Contextual Grep) (Grok Code Fast 1) + - Athena: Multi-model council orchestrator - sends questions to multiple AI models, synthesizes by agreement level, delegates to Atlas/Prometheus +- Full LSP / AstGrep Support: Refactor decisively. +- Todo Continuation Enforcer: Forces the agent to continue if it quits halfway. **This is what keeps Sisyphus rolling that boulder.** +- Comment Checker: Prevents AI from adding excessive comments. Code generated by Sisyphus should be indistinguishable from human-written code. +- Claude Code Compatibility: Command, Agent, Skill, MCP, Hook(PreToolUse, PostToolUse, UserPromptSubmit, Stop) +- Curated MCPs: + - Exa (Web Search) + - Context7 (Official Documentation) + - Grep.app (GitHub Code Search) +- Interactive Terminal Supported - Tmux Integration +- Async Agents +- ... + +#### Just Install This + +You can learn a lot from [overview page](docs/guide/overview.md), but following is like the example workflow. + +Just by installing this, you make your agents to work like: + +1. Sisyphus doesn't waste time hunting for files himself; he keeps the main agent's context lean. Instead, he fires off background tasks to faster, cheaper models in parallel to map the territory for him. +1. Sisyphus leverages LSP for refactoring; it's more deterministic, safer, and surgical. +1. When the heavy lifting requires a UI touch, Sisyphus delegates frontend tasks directly to Gemini 3 Pro. +1. If Sisyphus gets stuck in a loop or hits a wall, he doesn't keep banging his head—he calls GPT 5.2 for high-IQ strategic backup. +1. Working with a complex open-source framework? Sisyphus spawns subagents to digest the raw source code and documentation in real-time. He operates with total contextual awareness. +1. When Sisyphus touches comments, he either justifies their existence or nukes them. He keeps your codebase clean. +1. Sisyphus is bound by his TODO list. If he doesn't finish what he started, the system forces him back into "bouldering" mode. Your task gets done, period. +1. Honestly, don't even bother reading the docs. Just write your prompt. Include the 'ultrawork' keyword. Sisyphus will analyze the structure, gather the context, dig through external source code, and just keep bouldering until the job is 100% complete. +1. Actually, typing 'ultrawork' is too much effort. Just type 'ulw'. Just ulw. Sip your coffee. Your work is done. + +Need to look something up? It scours official docs, your entire codebase history, and public GitHub implementations—using not just grep but built-in LSP tools and AST-Grep. +3. Stop worrying about context management when delegating to LLMs. I've got it covered. + - OhMyOpenCode aggressively leverages multiple agents to lighten the context load. + - **Your agent is now the dev team lead. You're the AI Manager.** +4. It doesn't stop until the job is done. +5. Don't want to dive deep into this project? No problem. Just type 'ultrathink'. + +If you don't want all this, as mentioned, you can just pick and choose specific features. + +#### Which Model Should I Use? + +New to oh-my-opencode and not sure which model to pair with which agent? Check the **[Agent-Model Matching Guide](docs/guide/agent-model-matching.md)** — a quick reference for newcomers covering recommended models, fallback chains, and common pitfalls for each agent. + +### For Those Who Want Autonomy: Meet Hephaestus + +![Meet Hephaestus](.github/assets/hephaestus.png) + +In Greek mythology, Hephaestus was the god of forge, fire, metalworking, and craftsmanship—the divine blacksmith who crafted weapons for the gods with unmatched precision and dedication. +**Meet our autonomous deep worker: Hephaestus (GPT 5.3 Codex Medium). The Legitimate Craftsman Agent.** + +*Why "Legitimate"? When Anthropic blocked third-party access citing ToS violations, the community started joking about "legitimate" usage. Hephaestus embraces this irony—he's the craftsman who builds things the right way, methodically and thoroughly, without cutting corners.* + +Hephaestus is inspired by [AmpCode's deep mode](https://ampcode.com)—autonomous problem-solving with thorough research before decisive action. He doesn't need step-by-step instructions; give him a goal and he'll figure out the rest. + +**Key Characteristics:** +- **Goal-Oriented**: Give him an objective, not a recipe. He determines the steps himself. +- **Explores Before Acting**: Fires 2-5 parallel explore/librarian agents before writing a single line of code. +- **End-to-End Completion**: Doesn't stop until the task is 100% done with evidence of verification. +- **Pattern Matching**: Searches existing codebase to match your project's style—no AI slop. +- **Legitimate Precision**: Crafts code like a master blacksmith—surgical, minimal, exactly what's needed. ## Installation @@ -307,7 +409,7 @@ Features you'll think should've always existed. Once you use them, you can't go See full [Features Documentation](docs/reference/features.md). **Quick Overview:** -- **Agents**: Sisyphus (the main agent), Prometheus (planner), Oracle (architecture/debugging), Librarian (docs/code search), Explore (fast codebase grep), Multimodal Looker +- **Agents**: Sisyphus (the main agent), Prometheus (planner), Athena (multi-model council orchestration), Oracle (architecture/debugging), Librarian (docs/code search), Explore (fast codebase grep), Multimodal Looker - **Background Agents**: Run multiple agents in parallel like a real dev team - **LSP & AST Tools**: Refactoring, rename, diagnostics, AST-aware code search - **Hash-anchored Edit Tool**: `LINE#ID` references validate content before applying every change. Surgical edits, zero stale-line errors