From 6ec3bdf3e87d1b8130c4b4d09519b501c5da99e0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jesus=20Nu=C3=B1ez?= Date: Sat, 30 May 2026 20:48:45 -0400 Subject: [PATCH] docs(readme): make v3 the current focus with a clearly labeled section MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Rename the "AI Insights Agent" heading to "v3 — Insights Agent (current focus)" so it's unambiguously v3 and parallel to the v1/v2 sections, move the "current focus" marker from v2 to v3, and drop "(in progress)" from the v3 roadmap entry now that the v3 milestones are complete. --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 03e95f6..57dc8ef 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,10 @@ A Go FinOps toolkit that ships in two modes from the same `oracle` binary, with a polyglot agent extension in progress: - **v1 — Audit existing cloud spend.** Ingest live EC2/RDS/EBS/Lambda inventory from AWS, GCP, or Azure into Postgres, run deterministic rules over it, and produce an executive PDF + dashboard with an LLM-narrated summary. See **[docs/v1-guide.md](docs/v1-guide.md)**. -- **v2 — Predict cost impact of a Terraform PR before merge.** Read `terraform show -json plan.tfplan`, look every changing resource up against the AWS Pricing API, and post (or upsert) a Markdown comment on the PR with the net monthly delta, top movers, and a 1–3 sentence LLM narrative. Ships as a GitHub Action and as the `oracle pr-check` subcommand. **Current focus.** See **[docs/v2-guide.md](docs/v2-guide.md)**. -- **v3 — Insights Agent.** Polyglot Go + Python extension adding agentic FinOps analysis on top of v1/v2 cost data — a hand-rolled LangGraph supervisor over specialist agents, RAG over a FinOps corpus (pgvector), production guardrails, real billing via AWS Cost Explorer, and a CLI + HTTP surface. See **[docs/v3-guide.md](docs/v3-guide.md)**, **[AI Insights Agent](#ai-insights-agent)** below, and **[insights-agent/README.md](insights-agent/README.md)**. +- **v2 — Predict cost impact of a Terraform PR before merge.** Read `terraform show -json plan.tfplan`, look every changing resource up against the AWS Pricing API, and post (or upsert) a Markdown comment on the PR with the net monthly delta, top movers, and a 1–3 sentence LLM narrative. Ships as a GitHub Action and as the `oracle pr-check` subcommand. See **[docs/v2-guide.md](docs/v2-guide.md)**. +- **v3 — Insights Agent.** Polyglot Go + Python extension adding agentic FinOps analysis on top of v1/v2 cost data — a hand-rolled LangGraph supervisor over specialist agents, RAG over a FinOps corpus (pgvector), production guardrails, real billing via AWS Cost Explorer, and a CLI + HTTP surface. **Current focus.** See **[v3 — Insights Agent](#v3--insights-agent-current-focus)** below, **[docs/v3-guide.md](docs/v3-guide.md)**, and **[insights-agent/README.md](insights-agent/README.md)**. -## AI Insights Agent +## v3 — Insights Agent (current focus) A Python sibling of the Go server that lets you ask FinOps questions in natural language. The agent decides which `/api/v1` endpoint to call, fetches @@ -42,7 +42,7 @@ curated FinOps corpus embedded in pgvector. RAG is optional (enabled by `DATABASE_URL`). Setup, env vars, the RAG ingestion step, and the smoke test are documented in **[insights-agent/README.md](insights-agent/README.md)**. -## v2 — Quick start (current focus) +## v2 — Quick start CloudOracle parses a Terraform plan, prices every changing resource, and posts a PR comment like this: @@ -135,7 +135,7 @@ The synthetic provider needs no credentials. To run against AWS / GCP / Azure, s ## Roadmap -### v3 — Insights Agent (in progress) +### v3 — Insights Agent - [X] **Milestone 8.0** — Authenticated `/api/v1/cost-summary` and `/api/v1/cost-by-service` Go endpoints (X-API-Key, snapshot-derived totals with explicit `data_source` disclaimer, machine-readable error codes) - [X] **Milestone 8.1** — Python `insights-agent` sibling: LangGraph `create_react_agent` graph with two CloudOracle tools, Gemini provider, pydantic-settings config, structlog matching the Go slog format, CLI with `--verbose` / `--json` flags, 92% test coverage with mocked LLM + mocked HTTP. See **[insights-agent/](insights-agent/README.md)**