Skip to content

Commit b5842a3

Browse files
committed
docs: landing page accuracy sweep — align claims with the implementation
Verified every checkable claim in docs/index.html against the code: - JSON-LD softwareVersion 1.2.0 -> 1.26.2 (stale by 24 releases) - Docker Compose files live in docker/, not the repo root (hero carousel - now cds into odek/docker so the later config/compose steps resolve) - 'go 1.24' -> 'go 1.25' in demo go.mod output (go.mod says 1.25.12) - search_files is pure-Go regex content search, not 'ripgrep-backed' - session_search is semantic vector search over conversation content; there is no --deep flag - odek serve sandboxes by default — cheatsheet showed the inverse (--no-sandbox is the opt-out) - odek mcp has no --sse-addr/SSE mode, stdio only — removed the cheatsheet row and the same stale claim in llms.txt and AGENTS.md - odek schedule add requires --cron "<expr>" - --interaction-mode accepts a fourth mode (off); also fixed the raw <m> tag that swallowed the flag placeholder at render time - added the EXTENSIONS.md (odek-extension/v1) link to the docs grid and llms.txt Everything else checked out: install one-liner asset names, Go 1.25+, default model/iteration count, thinking levels, learn/no-learn, repl --id, run --deliver, memory/cleanup subcommands, telegram budget env vars, 3-worker delegation default, network_egress=prompt default, MIT license, Linux/macOS release targets.
1 parent c26b930 commit b5842a3

3 files changed

Lines changed: 15 additions & 14 deletions

File tree

‎AGENTS.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ cmd/odek/
4242
external_ref.go --external-ref flag parsing (run + continue) → session.ExternalRef
4343
perf_tools.go Performance/parallelism tools (batch_patch, parallel_shell, http_batch, math_eval, diff,
4444
count_lines, multi_grep, json_query, tree, checksum, sort, head_tail, base64, tr, word_count)
45-
mcp.go MCP server implementation (stdio + SSE transport)
45+
mcp.go MCP server implementation (stdio transport)
4646
mcp_approval.go Per-tool MCP server approval UI and persistence (key hashes limits/artifact_roots)
4747
project_sandbox_approval.go Project-level sandbox config approval gate (C-1)
4848
transcribe_tool.go Whisper.cpp audio transcription

‎docs/index.html‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -517,7 +517,7 @@
517517
"description": "The fastest, minimal Go autonomous agent runtime. ~12 MB static binary, zero frameworks. ReAct agent with parallel tool execution, persistent memory, MCP, sandbox, Web UI, and Telegram bot.",
518518
"url": "https://odek.21no.de",
519519
"downloadUrl": "https://github.com/BackendStack21/odek",
520-
"softwareVersion": "1.2.0",
520+
"softwareVersion": "1.26.2",
521521
"license": "https://github.com/BackendStack21/odek/blob/main/LICENSE",
522522
"image": "https://odek.21no.de/og-image.png",
523523
"screenshot": "https://odek.21no.de/og-image.png",
@@ -625,8 +625,8 @@ <h2 class="hero-h2">Getting started — <span class="hl">Docker + Telegram</span
625625
<div class="slide active">
626626
<span class="info"># 1 · Start from zero — grab the repo</span><br>
627627
<span class="prompt">$ git clone https://github.com/BackendStack21/odek</span><br>
628-
<span class="prompt">$ cd odek</span><br>
629-
<span class="output">The Docker Compose setup ships in the repo root:</span><br>
628+
<span class="prompt">$ cd odek/docker</span><br>
629+
<span class="output">The Docker Compose setup ships in docker/:</span><br>
630630
<span class="output"> Dockerfile · docker-compose.yml · config.restricted.json</span><br>
631631
<span class="info"># the container IS the sandbox — no --sandbox needed</span>
632632
</div>
@@ -803,7 +803,7 @@ <h2>See it in <span class="hl">action</span></h2>
803803
<span class="info">═══ Iter 1/15 ═══ [456 in · 21 out · 0.8s]</span><br>
804804
<span class="output">The <strong>go.mod</strong> file has 3 lines:</span><br>
805805
<span class="output">module github.com/BackendStack21/odek</span><br>
806-
<span class="output">go 1.24</span><br>
806+
<span class="output">go 1.25</span><br>
807807
<span class="output">require ( ... )</span><br>
808808
<span class="info">✅ Done in 0.8s</span>
809809
</div>
@@ -859,7 +859,7 @@ <h2>See it in <span class="hl">action</span></h2>
859859
<span class="output">Connected by Claude Code. Exposing built-in tools:</span><br>
860860
<span class="output"> • read_file — read files with line numbers</span><br>
861861
<span class="output"> • write_file — write files safely</span><br>
862-
<span class="output"> • search_files — ripgrep-backed search</span><br>
862+
<span class="output"> • search_files — regex content search</span><br>
863863
<span class="output"> • shell — execute commands</span><br>
864864
<span class="output"> • patch — find-and-replace edits</span><br>
865865
<span class="output"> — MCP stdio —</span>
@@ -964,7 +964,7 @@ <h4>Web UI</h4>
964964
<div class="card">
965965
<div class="icon">🔍</div>
966966
<h4>Session Search</h4>
967-
<p><code>session_search</code> — full-text and fuzzy search across your entire agent history. Use <code>--deep</code> for LLM-powered semantic search. Never lose a past finding, decision, or code review.</p>
967+
<p><code>session_search</code> — semantic search across your entire agent history: vector matching over full conversation content finds sessions whose messages match your query, even when titles don't. Never lose a past finding, decision, or code review.</p>
968968
</div>
969969

970970
<div class="card">
@@ -1097,13 +1097,12 @@ <h3>Commands</h3>
10971097
<li><span class="cmd">odek run --sandbox &lt;task&gt;</span><span class="desc">Run in Docker sandbox</span></li>
10981098
<li><span class="cmd">odek repl</span><span class="desc">Interactive multi-turn REPL</span></li>
10991099
<li><span class="cmd">odek repl --id &lt;uuid&gt;</span><span class="desc">Resume a saved session</span></li>
1100-
<li><span class="cmd">odek serve</span><span class="desc">Start Web UI (http://127.0.0.1:8080)</span></li>
1101-
<li><span class="cmd">odek serve --sandbox</span><span class="desc">Web UI with Docker sandbox</span></li>
1100+
<li><span class="cmd">odek serve</span><span class="desc">Start Web UI (sandboxed by default, http://127.0.0.1:8080)</span></li>
1101+
<li><span class="cmd">odek serve --no-sandbox</span><span class="desc">Web UI without the Docker sandbox</span></li>
11021102
<li><span class="cmd">odek subagent --goal &lt;s&gt;</span><span class="desc">Run a focused sub-task</span></li>
1103-
<li><span class="cmd">odek mcp</span><span class="desc">Start MCP server (stdio)</span></li>
1104-
<li><span class="cmd">odek mcp --sse-addr :8081</span><span class="desc">Start MCP server (SSE)</span></li>
1103+
<li><span class="cmd">odek mcp</span><span class="desc">Start MCP server (stdio; --sandbox for Docker)</span></li>
11051104
<li><span class="cmd">odek telegram</span><span class="desc">Start Telegram bot</span></li>
1106-
<li><span class="cmd">odek schedule add &lt;task&gt;</span><span class="desc">Schedule a recurring agent task (cron)</span></li>
1105+
<li><span class="cmd">odek schedule add --cron "&lt;expr&gt;" &lt;task&gt;</span><span class="desc">Schedule a recurring agent task (cron)</span></li>
11071106
<li><span class="cmd">odek cleanup --dry-run</span><span class="desc">Preview storage maintenance, delete nothing</span></li>
11081107
<li><span class="cmd">odek cleanup</span><span class="desc">Run one storage maintenance sweep</span></li>
11091108
<li><span class="cmd">odek memory extended stats</span><span class="desc">Memory store, index, quarantine, recall health</span></li>
@@ -1128,7 +1127,7 @@ <h3>Key Flags</h3>
11281127
<li><span class="cmd">--system &lt;prompt&gt;</span><span class="desc">Override system prompt</span></li>
11291128
<li><span class="cmd">--no-color</span><span class="desc">Disable colored output</span></li>
11301129
<li><span class="cmd">--deliver</span><span class="desc">Deliver result to Telegram default chat</span></li>
1131-
<li><span class="cmd">--interaction-mode <m></span><span class="desc">engaging | verbose | enhance</span></li>
1130+
<li><span class="cmd">--interaction-mode &lt;mode&gt;</span><span class="desc">engaging | verbose | enhance | off</span></li>
11321131
</ul>
11331132
</section>
11341133

@@ -1146,6 +1145,7 @@ <h2>Everything else is <span class="hl">documented</span></h2>
11461145
<a href="https://github.com/BackendStack21/odek/blob/main/docs/PROVIDERS.md">Providers & Models<span>DeepSeek, OpenAI, Anthropic, Ollama, vLLM, more</span></a>
11471146
<a href="https://github.com/BackendStack21/odek/blob/main/docs/CACHING.md">Prompt Caching<span>Cache markers for lower latency and cost on repeats</span></a>
11481147
<a href="https://github.com/BackendStack21/odek/blob/main/docs/MCP.md">MCP (Two-Way)<span>Serve tools + connect to external MCP servers</span></a>
1148+
<a href="https://github.com/BackendStack21/odek/blob/main/docs/EXTENSIONS.md">Extension Contract<span>odek-extension/v1: limits, artifact refs, events, budgets</span></a>
11491149
<a href="https://github.com/BackendStack21/odek/blob/main/docs/MEMORY.md">Memory System<span>Legacy facts, buffer, episodes</span></a>
11501150
<a href="https://github.com/BackendStack21/odek/blob/main/docs/EXTENDED_MEMORY.md">Extended Memory<span>Semantic atoms, recall, quarantine, proactive engagement</span></a>
11511151
<a href="https://github.com/BackendStack21/odek/blob/main/docs/MAINTENANCE.md">Storage Maintenance<span>Janitor, retention config, odek cleanup</span></a>

‎docs/llms.txt‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ Module path: `github.com/BackendStack21/odek`. Repository: https://github.com/Ba
1818
- [Sub-agents](https://odek.21no.de/SUBAGENTS.md): `delegate_tasks` tool and `odek subagent` — real OS processes with trust levels, risk caps, and FD-based API key handoff
1919
- [Tool Selection](https://odek.21no.de/TOOL_SELECTION.md): restricting which built-in tools the LLM can see
2020
- [Prompt Caching](https://odek.21no.de/CACHING.md): provider prompt-caching support, cost and latency effects
21-
- [MCP Integration](https://odek.21no.de/MCP.md): odek as MCP server (stdio/SSE) and as MCP client, per-tool approval flow
21+
- [MCP Integration](https://odek.21no.de/MCP.md): odek as MCP server (stdio) and as MCP client, per-tool approval flow
22+
- [Extension Contract](https://odek.21no.de/EXTENSIONS.md): odek-extension/v1 — MCP per-server limits, artifact refs, runtime events, execution budgets
2223
- [Development](https://odek.21no.de/DEVELOPMENT.md): build, test, release workflow, and contributor notes
2324

2425
## Memory, learning, and sessions

0 commit comments

Comments
 (0)