From 5861583d8292cebd27ae1473c5db1fb45b1ded5a Mon Sep 17 00:00:00 2001 From: Gadi Evron Date: Fri, 14 Aug 2026 22:30:09 +0300 Subject: [PATCH] docs: document the openant serve web UI The web UI (openant serve) landed in the code (#235) but its doc updates missed that merge. Add them: a "Web UI" section in the README, a CHANGELOG entry, and `serve` in the ARCHITECTURE command list. Docs-only; no code change. Co-Authored-By: Claude Opus 4.8 --- ARCHITECTURE.md | 2 +- CHANGELOG.md | 11 +++++++++++ README.md | 16 ++++++++++++++++ 3 files changed, 28 insertions(+), 1 deletion(-) diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md index 1b4da86e..f964d0cc 100644 --- a/ARCHITECTURE.md +++ b/ARCHITECTURE.md @@ -19,7 +19,7 @@ everything about analysis. They speak over a deliberately narrow contract. ```mermaid flowchart TB subgraph go["Go CLI — apps/openant-cli"] - cmd["cmd/*.go
init · scan · parse · report"] + cmd["cmd/*.go
init · scan · parse · report · serve"] invoke["internal/python/invoke.go
process lifecycle, timeouts, signals"] gocfg["internal/config
~/.config/openant/config.json"] golang_["internal/languages
reads config/languages.json"] diff --git a/CHANGELOG.md b/CHANGELOG.md index 036a0fd3..327c6a35 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -18,6 +18,17 @@ All notable changes to OpenAnt are documented in this file. checkpointed, so a re-run resumes; the override lets a single large run finish outright. +## [2026-08-14] — Local web UI + +### Added + +- **`openant serve` — a local, loopback-only web UI for the scan pipeline.** + Submit a repository URL or local path from the browser, watch scan logs stream + live (SSE), and read the HTML report / markdown summary / disclosures. Binds + 127.0.0.1 only (refuses a non-loopback `--addr`); outputs persist under + `~/.openant/webui/`. Original work by @sounil, reconciled onto master and + security-hardened. See the "Web UI" section in the README. + ## [2026-07-22] — Efficacy harness rescoped to a smoke test ### Changed diff --git a/README.md b/README.md index 02de4bc6..e08cb09b 100644 --- a/README.md +++ b/README.md @@ -192,6 +192,22 @@ Or run the full pipeline in one command: openant scan --verify ``` +### Web UI + +`openant serve` starts a local web UI over the same scan pipeline: submit a +repository URL or local path, watch the scan logs stream live, and read the HTML +report, markdown summary, and disclosures — all from the browser. + +```bash +openant serve # http://127.0.0.1:8080, opens your browser +openant serve --addr 127.0.0.1:9000 # choose a port +``` + +The server binds to loopback only (it refuses any non-loopback `--addr`) and is +intended for local single-user use. Scan outputs persist under +`~/.openant/webui/` across restarts. Analysis still sends source code to your +configured LLM provider, the same as the CLI. + ### Working with multiple projects The pipeline operates on one project at a time. Running `openant init` sets the newly initialized project as the active one, so all subsequent commands target it by default.