Skip to content

Commit 1348597

Browse files
committed
docs: file attachments — docs, landing page, and E2E tests
- Add 📎 File Attachments feature section to README.md (strategy features + quick start) - Add --ctx/-c flag to CLI.md run flags table + full file attachments doc - Add file attachment examples to CHEATSHEET.md (CLI + env vars) - Add drag-and-drop and paperclip features to WEBUI.md - Add File Attachments feature card + cheatsheet entries to landing page - Add 6 E2E tests: --ctx, @ref, both, missing file, -c short flag, multiple files (all gated by ODEK_E2E=true)
1 parent 6e3f24d commit 1348597

6 files changed

Lines changed: 559 additions & 5 deletions

File tree

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,10 @@ Four-layer priority chain: `global (~/.odek/config.json)` → `project (./odek.j
5454
Any OpenAI-compatible endpoint: Deepseek, OpenAI, Anthropic, Ollama, vLLM, Groq, Together, Fireworks — anything that speaks `/chat/completions`. Per-model profiles for thinking depth and context windows. [docs/PROVIDERS.md](docs/PROVIDERS.md)
5555

5656
### 🌐 Web UI
57-
`odek serve` — browser-based agent with `@` resource completion (`@file.go`, `@sess:abc123`), WebSocket streaming, and a full IDE-style console. [docs/WEBUI.md](docs/WEBUI.md)
57+
`odek serve` — browser-based agent with `@` resource completion (`@file.go`, `@sess:abc123`), **drag-and-drop file attachments**, WebSocket streaming, and a full IDE-style console. [docs/WEBUI.md](docs/WEBUI.md)
58+
59+
### 📎 File Attachments
60+
Attach files to any prompt with `--ctx` / `-c` (CLI), `@filename` inline references (CLI + REPL + Web UI), or drag-and-drop (Web UI). File content is injected as context blocks before the task — no tool calls needed. Comma-separate multiple files: `--ctx main.go,lib.go`. [docs/CLI.md#file-attachments](docs/CLI.md#file-attachments)
5861

5962
### 🔗 MCP (Two-Way)
6063
**Server** (`odek mcp`) — expose odek's native tools (shell, read/write/search files, patch, browser) to Claude Code, Cursor, and any MCP client. **Client** (`mcp_servers` config) — odek connects to external MCP servers (Playwright, Fetch, GitHub, SQLite, etc.) and makes their tools available to the agent as `<server>__<tool>`. Both directions in one binary. [docs/MCP.md](docs/MCP.md)
@@ -85,6 +88,11 @@ odek run "Set up a Go project with CI"
8588

8689
# Interactive REPL
8790
odek repl
91+
92+
# Attach files for context
93+
odek run --ctx data.csv "analyze this"
94+
odek run --ctx main.go,lib.go "compare these files"
95+
odek run "@README.md what does this project do?"
8896
```
8997

9098
---
@@ -128,6 +136,7 @@ odek repl
128136
| `--system <prompt>` | Override system prompt |
129137
| `--max-iter <n>` | Max think→act cycles (default 90) |
130138
| `--no-color` | Disable colored output |
139+
| `--ctx <files>` / `-c` | Attach files as context blocks (comma-separated) |
131140
| `--no-agents` | Skip AGENTS.md project file |
132141

133142
---

0 commit comments

Comments
 (0)