Skip to content

Commit 9efbb4f

Browse files
committed
docs: add 'Why OpenCoder?' section to README
Explain the core value proposition of OpenCoder as an autonomous development tool. Clarifies the difference between OpenCode (interactive collaboration) and OpenCoder (autonomous delegation), including when to use each tool. Signed-off-by: leocavalcante <[email protected]>
1 parent 7a2d090 commit 9efbb4f

File tree

1 file changed

+45
-3
lines changed

1 file changed

+45
-3
lines changed

README.md

Lines changed: 45 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,48 @@
1515
- **Signal Handling** - Clean shutdown with state preservation
1616
- **Cross-Platform** - Builds for Linux and macOS (amd64/arm64)
1717

18+
## Why OpenCoder?
19+
20+
### The Gap
21+
22+
[OpenCode](https://opencode.ai) is an incredible AI coding agent with a powerful interactive TUI. You can have rich conversations, ask follow-up questions, and collaborate on complex problems. It's excellent when you want to **work with** the AI.
23+
24+
But what if you want the AI to **work for you** while you're away?
25+
26+
### The "Aha!" Moment
27+
28+
OpenCoder's insight is simple but powerful:
29+
30+
> **What if the AI never stopped improving your project?**
31+
32+
Instead of interactive sessions where you guide the AI, OpenCoder creates an *autonomous development loop* that runs continuously:
33+
34+
| OpenCode (Interactive) | OpenCoder (Autonomous) |
35+
|------------------------|------------------------|
36+
| You drive the conversation | AI drives the development |
37+
| Responds when you prompt | Runs continuously without prompts |
38+
| Requires your presence | Works while you're away |
39+
| You decide what's next | AI decides what's next |
40+
| Great for collaboration | Great for delegation |
41+
42+
### When to Use OpenCoder
43+
44+
- **Greenfield projects**: "Build me a REST API" and walk away
45+
- **Overnight development**: Start before bed, wake up to progress
46+
- **Continuous improvement**: Let AI find and fix issues you haven't thought of
47+
- **Background tasks**: Run while you focus on other work
48+
49+
### When to Use OpenCode Directly
50+
51+
- Interactive pair programming where you want to guide the AI
52+
- Quick one-off tasks where you'll review immediately
53+
- Complex decisions requiring human judgment at each step
54+
- Learning by watching the AI's reasoning in real-time
55+
56+
### The Philosophy
57+
58+
OpenCoder treats software development as an **infinite game**. There's always another test to write, another edge case to handle, another optimization to make. OpenCoder embraces this by never declaring "done"—it continuously cycles through planning, execution, and evaluation until you tell it to stop.
59+
1860
## Installation
1961

2062
### Pre-built Binaries
@@ -112,7 +154,7 @@ opencoder -P openai/gpt-4 -E openai/gpt-4o-mini "build a CLI tool"
112154

113155
## How It Works
114156

115-
Opencoder implements an **agentic development loop** with three phases:
157+
OpenCoder implements an **agentic development loop** with three phases:
116158

117159
```
118160
+-------------+ +-------------+ +-------------+
@@ -133,7 +175,7 @@ The loop continues indefinitely until manually stopped (Ctrl+C).
133175

134176
## Directory Structure
135177

136-
Opencoder creates a `.opencoder/` directory in your project:
178+
OpenCoder creates a `.opencoder/` directory in your project:
137179

138180
```
139181
.opencoder/
@@ -183,7 +225,7 @@ Using bcrypt for password hashing, JWT for tokens.
183225
## Tips
184226

185227
- **Start with a clear hint** - The more specific your instruction, the better the initial plan
186-
- **Let it run** - Opencoder is designed to run continuously; trust the loop
228+
- **Let it run** - OpenCoder is designed to run continuously; trust the loop
187229
- **Check the logs** - Detailed logs are in `.opencoder/logs/` if something goes wrong
188230
- **Review history** - Completed plans are archived in `.opencoder/history/`
189231

0 commit comments

Comments
 (0)