Skip to content

AGENTS.md

Latest commit

 

History

History
364 lines (338 loc) · 22.2 KB

AGENTS.md

File metadata and controls

364 lines (338 loc) · 22.2 KB
Raw

AGENTS.md — guidance for coding agents working on bodek

bodek is a pure front-end: a Bubble Tea TUI that streams from an odek serve engine over WebSocket. It never re-implements agent behaviour (tools, approvals, sandbox, skills, memory) — all of that lives in odek. Keep it that way.

Project layout

Path Responsibility
cmd/bodek CLI entry point: flags, lifecycle, version / upgrade subcommands
internal/server Launch / attach to odek serve, resolve the auth token
internal/client odek serve WebSocket protocol (transport + REST + decoding)
internal/tokens Local persistence of per-session auth tokens
internal/workspace Per-cwd draft, queue, history, and last-session id
internal/tui The Bubble Tea model, update loop, panels, and view
internal/update Self-upgrade: fetch and swap in the latest GitHub release binary

Commands

make build   # compile → bin/bodek
make test    # go test -race ./...   (always use the race detector)
make vet     # go vet ./...
make lint    # golangci-lint (config: .golangci.yml)
make fmt     # go fmt ./...
make cover   # coverage report for internal packages

Before every commit — mandatory checklist

Run all of these and make them pass before committing:

  1. make fmt
  2. make vet
  3. make lint — must report 0 issues
  4. make test — the full race-enabled suite, all packages green

Never commit with failing tests or lint findings. If a change breaks an existing test, fix the code or deliberately update the test — never delete or weaken a test just to get green.

Commit messages — Conventional Commits (CZ)

Use Conventional Commits semantics:

<type>(<scope>): <short imperative summary>

<optional body: what and why, not how>
  • Types: feat (user-visible behaviour), fix (bug), refactor, perf, test, docs, chore, ci, build.
  • Scope: usually the package, e.g. tui, client, server, tokens.
  • Summary: lowercase, imperative, no trailing period, ≤ 72 chars.
  • Breaking changes: ! after the scope and a BREAKING CHANGE: footer.
  • One logical change per commit; don't mix refactors with features.

Examples from this repo's history:

fix(tui): interleave reasoning blocks with tool calls chronologically
feat(tui): compact tool steps with Ctrl+E details toggle

Testing expectations

  • Internal-package coverage is ~99% — keep it there. Any new behaviour needs a test; any bug fix needs a regression test.
  • TUI tests drive the model directly: construct a Model (see newTestModel in internal/tui), feed client.Events through handleEvent/Update, and assert on m.msgs, rendered output (renderMessage, plain()), or key handling (key("ctrl+e")).
  • Don't assert on exact timings or spinner frames — keep tests non-flaky.
  • The client and server packages are tested against an in-process odek serve stand-in; reuse those fixtures.

Code conventions

  • Standard Go style, go fmt clean, golangci-lint clean (.golangci.yml).
  • Match the surrounding file's comment density and naming; exported API is rare here — most identifiers stay unexported.
  • Minimal diffs: change only what the task requires. No drive-by refactors, renames, or reformatting.
  • Security: anything rendered from the wire (tokens, tool output, file contents) must go through sanitize() — see internal/tui/model.go. Never render raw remote content. Tool results arrive as JSON envelopes wrapped in untrusted-content markers: decode the envelope and fold the wrappers away before display — don't render either verbatim.
  • The transcript model in internal/tui: each assistant message keeps a chronological items []turnItem timeline (reasoning blocks, step references, and reply segments interleaved — one think→reply cycle per segment pair, each rendered independently). Preserve arrival order; don't regress to a single per-turn reasoning blob or a single trailing answer card, and don't reintroduce a separate in-transcript thinking placeholder alongside it. msg.content stays the "\n\n"-joined blob of all reply segments (appendReply maintains it) for export, stats, and hand-built messages; turn markers (**Cancelled.** etc.) attach to the last reply. The calm default hides reasoning previews and tool responses: the intent rail and step result bodies paint only under ^E (details) or a deliberate expand — ↑/↓ selects an item and Enter opens it; click selects and expands one step; the result peek is gone. While a turn streams, its head line carries the run's elapsed counter right-aligned at the viewport edge (the runStart clock, whole seconds, dropped on finalize — the sealed telemetry row sits under the reply). A deliberately opened live rail still holds completed sentences (or a short frozen stem) so a fast thinking_delta stream cannot ticker it; failed steps still auto-expand once on the live path. The status line stays a quiet reasoning / composing label while those surfaces own the words; live tool steps use a static ▸ (one spinner: the status line). A finished step keeps its sealed dur in the right rail — after the typed chip when one exists — so per-tool times outlive completion; resumed history (dur 0) shows none. beginWireTurn must not GotoBottom — refresh() already sticks when the reader is at the bottom, and a yank fights the "↓ new output" contract. Render-only layers (intent rail, turn receipt, live swarm band, sub-agent chip strip, swarm receipt rail) must not reorder items[] — the parallel-tool swarm is a consecutive overlay on unfinished parent steps and dissolves when one leftover remains. Sub-agent children live on step.agents and always paint as chips; agentSel (1-based, 0 = none) focuses one mini-card. The swarm verdict is a receipt rail, never stuffed into msg.content.
  • Events arrive from internal/client already in chronological order — keep ingestion order-dependent and idempotent. listen() drains every pending frame into one eventBatchMsg so a thinking_delta firehose cannot run View per fragment (that filled the 256-deep Events buffer and tripped odek's 30s write timeout — connection lost after any prompt). ingestWireBatch re-arms listen() as a top-level cmd, never nested inside handleEvent's Batch. The client also merges consecutive thinking/token deltas (16 at a time) before enqueueing. The header connection lamp stays lit while a turn runs (◉); idle is ●, reconnect ◌, down ○. Progress stays on the status line — an empty corner was read as a dropped socket. The header ctx gauge is the parent conversation window: odek ≥ v2.3 sends windowTokens (last parent prompt) plus maxContextTokens (runtime model limit — beats /api/models). done.inputTokens is billing spend including charged sub-agents — never a gauge. Pre-v2.3 still deltas contextTokens. Absent/zero windowTokens holds the last fill. The bar saturates at full; the percent stays honest when winCtxTok exceeds maxContext (stale catalog / last-resort max) — never a contradictory 100% beside a larger used count. Live tok/s is tracked from this-call usage/done fields (generationTokensPerSecond preferred, else tokensPerSecond) and renders in the cockpit stats sheet — the header carries no rate chip. Absent/zero holds the last rate; a new turn clears it. Never divide cumulative outputTokens by wall latency.
  • internal/tui is split by responsibility: model.go holds the core model, inspect.go owns transcript item focus and bounded tool paging, events.go event handling, input.go key/text input, input_reassembler.go the raw terminal input stream, approval.go the approval flow, chrome.go drawer-sheet / shelf / header-instrument / session-home layout, reconnect.go socket recovery. Put new code in the matching file instead of growing model.go.
  • First-run home (welcome in banner.go) is the working directory plus one next-action tip. Branding lives in the header — do not reintroduce a splash wordmark. After ^L, sessionHome keeps last prompt / receipt / recents; /new returns to first-run.
  • Composer newline is ⇧⏎ (shift+enter, also alt+enter / ^J / ctrl+enter). keyMsgFromCode must keep ctrl+enter distinct from plain enter (an accidental submit) and must decode shift+printable CSI chords (kitty CSI-u 97;2u, xterm 27;2;97~) into their uppercase rune instead of dropping them; the friction editor treats the shift+enter/ctrl+enter sentinels as no-ops so their literal text never splices into apprTyped. The newline chord set lives in one helper — newlineChord in input.go — and every Enter-accepting surface routes through it (composer, AC popup, approval composer, clarify); a well-formed enhanced-key chord that fails to decode becomes an alt+unmapped-chord sentinel that handleKey reports as a transient note instead of silent drop. ^K is gated while an approval or clarify card is head, and queue-strip focus outranks the skill-suggestion chip (its chords never answer a passive card while qfocus is set). Bare s/x save/skip a pending suggestion only on an empty draft — the same modifier-free fallback approvals use for terminals that cannot deliver Alt chords (macOS Option-as-UTF-8). Enable kitty disambiguate (flag 1) and xterm modifyOtherKeys=2 from Init — after alt-screen — so Cursor/xterm.js encodes Shift+Enter (CSI 27 ; 2 ; 13 ~) instead of CR. Never enable kitty "report all keys". FilterShiftEnter rewrites those CSI sequences (and the remapped ^C / ^K / esc) back into KeyMsgs — Codium/Cursor encode Ctrl+C as CSI once those modes are on. RestoreEnhancedKeys clears leftovers on startup and shutdown. A terminal read can end mid-sequence: AssembleInput (wired in buildProgramOptions, non-Windows) reassembles it before Bubble Tea parses each read, under two invariants: a read from the terminal never fetches more than the room its caller offers, and a release never ends inside an escape sequence. Bubble Tea parses every read on its own, so a chunk that stops inside a mouse report turns the head into a finished CSI and the coordinate bytes behind it into typed runes — exactly what a wheel burst from a terminal without mode 1006 produces, since Terminal.app's xterm-256color advertises kmous=\E[M and answers with legacy 6-byte ESC [ M reports that any burst past Bubble Tea's 256-byte read cuts mid-report. Bounding the read (not the release) is what keeps input flowing: bytes read ahead but not released are invisible to the kqueue/epoll readiness wait that gates the next Read, so holding one back stalls the rest of the burst until the next keystroke. The release clamp covers what the read bound cannot — a non-file source (tests) reading its full window, and a caller whose buffer shrinks mid-stream. Partial ESC [ < … heads wait for their tail; a mouse-shaped head whose tail never arrives is dropped — never echoed into the composer. Only the SGR form is disposable: the legacy X10 form is joined but never dropped, because its coordinate bytes are indistinguishable from typed text. Bracket-paste bodies are user data and are never dropped, whatever they contain. A mouse head a fresh read cannot continue is a truncated report and is discarded so the read is not eaten. The wrapper only wraps a terminal file; a pipe or redirected stdin keeps Bubble Tea's own handling. It also presents itself as a term.File with the real descriptor, because Bubble Tea enables and restores raw mode only for input it recognises as a file (tty_unix.go initInput) — a plain wrapper would leave the program in cooked mode. One pump goroutine per program instance; Close stops it without closing stdin, which the program does not own. Alt-screen always enables mouse cell-motion so the wheel scrolls (and clicks hit turn heads / answer cards / steps / the queue). A left-click on an answer card (or a collapsed summary) copies that turn's msg.content — final or the partial stream — and parks focusIdx so a follow-up alt+y copies the same card. Success is a footer ✓ Copied flash only (noticeTTL, generation-guarded expire — no transcript notice). Turn heads still fold; step headers and chips still win on their own lines; raw /help cards are not copy targets. Local clipboard helpers (pbcopy / wl-copy / clip) must run as a plain tea.Cmd — tea.ExecProcess releases the alt-screen and flickers on every copy. OSC 52 (SSH / helper-less) still uses tea.Exec. tea.Exec (attention, OSC 52) must return afterExec so restoreAfterExec re-arms mouse and Shift+Enter — Bubble Tea's RestoreTerminal does not. --plain skips mouse reporting.
  • The management drawer is a bottom sheet: keep ~8 transcript rows above it (sheetTranscriptMin); full-bleed only when the terminal cannot fit transcript + sheet. Layout-only — tab grammar (]/[/⏎/esc) stays. Approvals render above a live composer: bare a/d/t decide only while the composer draft is empty (a non-empty draft, paste, or any modifier routes to the composer), and Alt+A/Alt+D/Alt+T decide. Text, paste, cursor keys, and Enter retain composer behavior. Friction captures apprTyped only after explicit Alt+A; Escape returns to the draft without deciding. Keep the editor rune/row bounded and reset it on head changes. Clarify questions capture the keyboard into clarifyBuf: the spacebar is Bubble Tea KeySpace (not KeyRunes), so every printable — spaces, punctuation, paste — must append. Wrap the answer by cell width and paint only a capped tail so a long paste cannot push View past the terminal; the buffer keeps the full text. Expiry autocloses the card and parks focusIdx plus the viewport on the latest transcript message (a surviving queued successor must not yank scrollback). The unfocused queue is a shelf chip; ^Q unfolds the strip (qfocus).
  • The TUI reconnects with backoff and resumes the session after a socket drop (reconnect.go) — don't break that by assuming a single connection per run.
  • Streaming renders are coalesced into one flush per 80ms for performance; batching new redraw paths the same way keeps the TUI responsive. Live reply segments glamour-render on that flush (not only at turn end). The spinner animates the status line only — transcript rebuilds for live transcript clocks (streaming head counter, step timers) coalesce at 250ms (tailClockFlushMsg); the lane ticks whenever a message streams, not only when steps run. Finished message blocks and done tool steps cache their render output; invalidate per message/step on expand, not the whole prefix.
  • The slash-completion popup holds key capture while open; typed keys must keep flowing to the input. Route keys through the popup first, then fall through to normal input handling.
  • ESC closes the topmost window, then inspect chrome, then (if busy) arms cancel. Order: confirm disarm → palette → drawer edit/detail/tab → cockpit → find → @// popup → queue strip → approval (collapse details, then arm cancellation; Alt+D denies) → clarify (arm cancel while busy; the card stays) → skill chip / ^E / open thinking / agent focus / expanded step / help card → cancel gate. Do not let a leftover overlay swallow ESC without dismissing. Ctrl+X independently arms turn cancellation before modal routing; the confirmation footer must remain visible above every panel and approval. Inspect Escape returns to the composer first.
  • Management drawer tabs (memory/skills/tools/config — and jobs) have a detail submode: ⏎ expands the selected row (skill description, full fact text, MCP args, raw config JSON — everything through sanitize()), esc/q folds back, p promotes in place. Tab switches reset it (switchDrawerTab); keep that reset when adding new open paths.
  • The jobs tab pairs with a REST lifecycle watcher (jobs_tab.go): the TUI polls /api/jobs (10s in background, 3s while the tab is visible) and diffs status transitions into transient notes. odek ≥ v1.40 also pushes bg_job frames on start/exit — handleEvent routes them through kickJobsFetch() for an immediate snapshot, watcher tick as fallback; bg_wake frames become transient notes. Generation counters (jobsSeq/jobsWatchSeq) drop stale ticks — keep both chains generation-guarded when touching the cadence. The same push-beats-poll pattern drives the other tabs: subagent_state and memory_event frames set kickAgents/kickMemory flags that flushKicks() drains into ONE fetch per burst (per-event cmds would starve inside ingestWireBatch); the events tab polls the runtime ring at 3s while visible with seq-stamped fetches (eventsMsg.seq — a late landing never clobbers a filter change, and open/toggle/clear bump eventsTabSeq). Agents-tab rows prefer live card telemetry over the REST snapshot (skipping lost cards), and drawer selections anchor by identity (fact text / TaskID) across rebuilds so a refresh never silently retargets the detail view or the stop gate.
  • The narration-line plan strip (planStripLabel in plan.go) patches on plan tool_call (applyPlanMutation) so the count moves on that frame. REST (GET /api/sessions/{id}/plan) confirms after tool_result (250ms debounce) — a fetch on the call races the store and paints the previous snapshot. planDirty drops every non-confirm reply (create leaves planVer stale, so a version-newer poll can still be the pre-write store). Only the tool_result confirm fetch may land — that is also how a rejected write reverts the patch. Live poll is 1s while busy, 3s on the /plan tab; planLiveKick arms it from sendPrompt / beginWireTurn via planFollowup, never as a Tick batched into submit. Generation counters (planDebSeq/planReqSeq/planPollSeq) drop stale ticks — keep them when touching the cadence.
  • Server-initiated wake turns (odek ≥ v1.40, system_initiated on the session frame) open a streaming card from the wire (openWakeTurn in events.go): without it every streamed event drops, because cards only opened on the local send path. The card carries the systemWake marker (renders ⬡ odek · wake); wake turns are never rendered as user messages, and a wake frame arriving during an operator turn opens nothing. With odek's turn_started protocol the dedicated frame is the primary signal for every turn (wake → wake-marked card, foreign operator turn → plain remote card); the stamped session frame and ensureWireTurn's lazy open (first streamed event while idle) remain as fallbacks, so a turn must be missed by all three paths to drop.

Workflow rules for agents

  • Never modify the odek project from a bodek session. bodek is a pure front-end; if a fix requires changes in odek (protocol, odek serve, engine behaviour), do not edit that repo — instead summarize the required change and suggest it to the user as a task for an odek session.
  • Don't run git commit/git push unless the user explicitly asks.
  • Don't add dependencies without checking go.mod first and flagging it to the user.
  • Keep README.md (key bindings, commands, feature list) and this file in sync when you change user-visible behaviour.
  • CI (.github/workflows) runs build, vet, lint, and race tests on every push — a red pipeline means the commit checklist above was skipped.

Terminal polish regression bar

  • Crowded headers preserve sandbox and connection state before version metadata; compact composer footers must fit one terminal row and retain actionable keys.
  • Home hints wrap by display cells, including wide Unicode paths. Keep the home free of a second wordmark or an additional feature dashboard.
  • Structured batch summaries must not invent successful execution when normalized results omit exit/status metadata. Expanded plan and batch views remain behind existing details controls and preserve the chronological transcript.
  • TestTerminalWorkflowLayouts checks real views across four themes at 40, 80, and 120 columns. Set BODEK_RENDER_PREVIEW_DIR to write optional ANSI fixtures for visual review without an engine/provider; generated captures are not source.

Interaction and response bounds

  • ↑/↓ traverses chronological tools and reasoning while inspecting, with visible focus; Enter expands the selected item. Typing returns to the composer. PgUp/PgDn pages a selected tool and Right cycles its sub-agent chips. Copy uses the selected item. Clear/resume must discard stale inspect coordinates.
  • Expanded tool and sub-agent response bodies show at most eight display rows plus one pager row, shrinking with terminal height. Split embedded newlines before counting and clamp ANSI display widths. Clamp paging at both ends; invalidate per-step caches when selection, offset, height, or theme changes.
  • Keep normalized step.result for copying/error compatibility and bounded step.detailResult for structured display. Preserve sanitized command/path identity through live and history ingestion; never infer item boundaries from [N] text. Report omitted bodies/items and total subset counts explicitly. Generic previews cap at 128 KiB/200 lines; structured details at 64 KiB/256 items.
  • Completed plans include the producer's all N steps complete format.
  • All footer modes fit one display row, prioritizing primary and exit actions. Recompute viewport height when the new-output shelf changes. Approval details page with Alt+PgUp/PgDn; compact terminals drop decorative card borders.
  • /theme uses the existing searchable selector, preselecting/marking the current choice. Enter applies/persists, Escape leaves the theme unchanged. Keep direct /theme name aliases. Late session results cannot contaminate the theme list.
  • Test state transitions and real event-to-view rendering, including approvals arriving during typing/paste, stop from overlays, tool paging, plan completion, active theme selection, and narrow/short layouts. Semantic small-text colors must pass contrast checks, not only body text.