Skip to content

Latest commit

 

History

History

README.md

Runtime Documentation

This directory is the authoritative current-state documentation surface. It summarizes the implemented runtime, API, Web M1 product shell, verified Web Complete C0-C3 implementation, and CDH G1-G7 control/evidence/Settings completion. C1-C3 are integrated on main through PRs #24-#26; CDH G1-G7 merged through PR #29 at f9e88a7. Post-Coding-Tool full delivery merged through PR #30 at 4b740d3, followed by the whitespace-only PR #31 cleanup at 1b57b36. The deterministic live-API gates passed. The current source includes the full-delivery shared kernel/lifecycle, MCP Streamable HTTP plus rich Tool Result/Artifact and live catalog refresh, AgentDefinition/instruction/procedure checkpoints, and the implemented Tauri Desktop D0 host. Desktop reuses the API router and ProductStore; it is not a second runtime or state authority. Current evidence is Windows-only for packaging and process launch; macOS/Linux packaging remains unverified. The current source also implements the 2026-08-12 user-owned Provider catalog and TUI model-selection slice: ~/.rove/config.toml, authority-aware loading, catalog CAS/atomic writes, API/Web catalog convergence, per-turn CLI assembly, secret-free run model snapshots, legacy migration, and TUI /model. The 2026-08-18 real-use work adds shared provider add/test/use/list onboarding with a masked keyring default, bounded model-inventory probe, typed redacted failures, CAS publication verification, and staged-keyring compensation. The credentialed SiliconFlow and installed-TUI F4/T7 gates passed on 2026-08-19; external-provider Web/Desktop gates, Windows ConPTY/manual terminal evidence, and the final A Gate remain unverified.

The current source also implements the user-state directory contract: run state, memory, and the default MCP catalog are isolated under <data_root>/workspaces/<storage_key>/, ProductStore is API-global at <data_root>/product.sqlite, and rove state paths / rove state migrate provide inspection plus conservative legacy .rove/ import. Migrated state.sqlite snapshots transactionally rebase indexed artifact paths before atomic publication, so pruning the source does not break exact resume. See STATE_LAYOUT_AND_MIGRATION.md.

The current source also integrates productization workstreams B-E and F.1-F.3, plus the hard read-only Review workflow: native-first tool-call recovery, ignore-aware deterministic repository retrieval, Artifact-backed result history, Provider onboarding, and one durable conversation-message lifecycle across Runtime, ProductStore/API/SSE, Web, and TUI. ProductStore schema v14 adds durable Review rows/findings and preserves the parallel-v12 reconciliation. Review captures an immutable Git target snapshot, uses a read-only tool/environment profile, sanitizes findings, and projects the same result to API, CLI, and Web. Deterministic Review evidence passes; external and platform-specific release gates remain separately classified below.

New maintainers should start with docs/ONBOARDING.md, then use this directory for current subsystem truth.

The productization integration implements workstreams A-E and F.1-F.3. Their current contracts and evidence are recorded in react-loop.md, subsystems.md, and acceptance-matrix.md. F.4/F.5 are partially complete: long-session older-history pagination/windowing and complete TUI restart recovery remain open. Workstream G is also partially complete: deterministic Rust/Web/TUI checks and five live local fake-provider browser scenarios pass, while credentialed Provider, real third-party/official filesystem MCP, Windows ConPTY, macOS/Linux packaging, signing, installed-Desktop, and broader stress/soak evidence remain unverified.

Documents

File Purpose
mvp-definition.md Current local-first MVP boundary, included capabilities, exclusions, golden paths, and verification baseline.
architecture.md Top-level runtime architecture and cross-module boundaries.
react-loop.md Plan outside, ReAct inside runtime loop explanation and pico relationship.
subsystems.md Config, state/job, context, provider, memory, tool, API/security, workspace retrieval, web, and CI subsystem notes.
implementation-status.md Current implementation vs target architecture matrix.
implementation-guide.md Maintainer-focused implementation guide with startup paths, the bounded rove tui navigation/timeline/interaction contract, terminal verification boundaries, runtime flow, state artifacts, and known gaps.
acceptance-matrix.md M0-M6 acceptance criteria mapped to concrete verification commands.
integration-testing.md End-to-end integration profiles, required local-full baseline, optional provider/MCP gates, and runner design.
full-integration-runbook.md New-session runbook for full API/Web/provider/MCP/stress integration testing across official APIs, relay/gateway APIs, and local providers.
provider-smoke.md Opt-in real-provider verification for OpenAI, Anthropic, and Ollama paths.
release-readiness.md MVP release checklist covering verification, provider smoke, packaging, security posture, and out-of-scope reminders.
browser-workspace-spec.md Future Browser workspace design note; not a current runtime implementation.
desktop-workspace-spec.md Future Desktop workspace design note; not a current runtime implementation.

Source Design

The current architecture is based on:

Partially implemented evolution records are:

The Web product line is tracked separately:

  • Web M1 is implemented; its ledger is docs/plans/2026-07-25-web-management-m1.md.
  • Product-shell browser evidence has two explicit layers. shell.spec.ts, continuity.spec.ts, settings.spec.ts, migration.spec.ts, and polish.spec.ts use browser-boundary mocks for broad deterministic state, race, recovery, and visual checks. The gated local-full suite runs real-api.spec.ts against a live Rust API. The current integration run passes five cases: migration before catalog boot; exact A/B session continuity plus refresh and product interactions; unified-message promotion/revocation; completed-session Fork with independent child continuation; and a bounded advanced /dev/workbench smoke.
  • Web Complete C0 is implemented: the API owns product.sqlite, product workspace/session/profile/preferences CRUD, exact product-session/runtime bindings, a canonical-event transcript read projection, and strict/idempotent M1 migration. Migration preparation is deadline-bounded; the supervised apply phase survives an HTTP disconnect, uses a durable preflight baseline and preference revision CAS, and reserves canonical workspace runtime databases before committing verified bindings. Typed Web client and migration modules are present.
  • Web Complete C1 is implemented: the default ProductApp consumes the C0 workspace/session/preferences/profile/transcript client, restores canonical history with explicit partial/error/retry states, uses durable workspace, session, and Settings routes, sends exact product_session_id turns, and reattaches only the focused live job while polling durable background status. Ambiguous job-start responses use bounded binding reconciliation and never trigger an automatic duplicate submission. Provider profiles and selection are API-authoritative.
  • Web Complete C2 is implemented: preferences use revision CAS and a durable default approval policy, product jobs honor that default, bounded Memory and runtime-health APIs back the UI, provider profiles support complete CRUD, and all nine Settings sections expose tested catalog, session, memory, runtime, approval, keyboard, or developer capabilities.
  • Web Complete C3 is implemented and verified on main. M1MigrationGate runs before API-authoritative catalog boot, permits the shell only after not_needed or verified complete, preserves exact retry payloads, and keeps invalid or uncertain imports fail closed. C3 also completes the responsive, focus, reduced-motion, and state polish and moves deterministic live-API acceptance to the default / product shell while retaining one bounded /dev/workbench check. The provider runner now targets an exact product session and correlates the browser's returned job/run IDs, but no external-provider C3 gate has been run. Follow docs/design/2026-07-26-web-complete-design.md for the completed design record.
  • CDH G1-G7 are implemented and verified on main through PR #29. Their legacy Steer/Follow-up routes remain compatibility wrappers; the current product uses one Send Message lifecycle plus terminal-boundary Fork/lineage, immutable session run configuration snapshots, usage/context/cost, bounded files and artifacts, image validation, run/Git diff, redacted evidence export, and a workspace-scoped MCP catalog shared by Settings and job assembly. See the acceptance matrix and the completed CDH plan.
  • Productization F.1-F.3 is implemented for the unified conversation command. Runtime canonical events now carry the six durable message delivery states (queued, intervention_requested, applied_current_run, claimed_successor, needs_attention, revoked). The API ProductStore schema is at v14 and the Runtime state schema is at v3; v13 reconciles both parallel v12 layouts before v14 adds Review tables, and both stores retain compatibility projections and idempotent/CAS migration paths. API routes, SSE/replay reflection, Web reducers/transcript, and the TUI all consume the shared message-domain vocabulary. Web unit/type/build, mocked browser, and five live local fake-provider cases pass; Windows ConPTY and external-provider delivery remain unverified. F.4 remains partial because the current Web/TUI path loads only the latest bounded message page and does not yet provide stable older-history prepend/windowing. F.5 remains partial because TUI process restart does not yet drain an existing queued successor or reconcile a successor claim that has no run.
  • The completed Kernel, Message, and Provider implementation record covers typed messages, provider normalization, and shared-kernel migration.
  • The completed Tool Schema and Runtime validation record covers bounded schema validation, atomic catalogs, model preflight, and Runtime capability snapshots.
  • The completed Project Trust, Execution Environment, and Coding Tools implementation record covers durable trust, Runtime-owned execution adapters, and the Coding Tool foundation.
  • Coding Tool V2 is implemented and verified by the Coding Tool V2 implementation plan.
  • A Tauri Desktop product host exists in apps/desktop on main through PR #30 and reuses the API router, ProductStore, and shared static Web build. desktop-workspace-spec.md remains an automation workspace note, not the Desktop product-shell design.
  • The User Provider Configuration and TUI Model Selection design is implemented through Phase 0-5. Its configured-model catalog, CAS, migration, CLI/TUI, API/Web, and resume contracts have deterministic test coverage. The optional real external-provider smoke remains unverified, so this is not an interoperability claim.
  • The productization implementation record and its remaining G gates are in 2026-08-10-post-full-delivery-productization.md. Workstreams A-E and F.1-F.3 are implemented; F.4/F.5 and G remain partial. Its dated audit inputs remain evidence and rationale, not independent plans.

Historical May/June hardening and RAG design notes live under docs/Archive/design/. These runtime docs describe what exists now and where the remaining gaps are.