使用说明
FinOps伙伴
人工智能驱动的AWS成本副驾驶 --一个只读的FinOps助手，它结合了 Python命令行界面, 快速API 后端， 反应 web UI，以及 LLM驱动的聊天 因此，您可以在不改变AWS资产的情况下探索支出、仪表板和建议。
目的和范围
- 目的： 使用适合生产凭证的护栏，使AWS成本和使用数据易于探索（表、仪表板、自然语言）。
- 范围： 只读 --不得创建/更新/删除AWS资源；输入和工具级护栏强化了这一立场。
- 它是为谁准备的： 已经使用AWS配置文件（CLI/SSO）并希望拥有桌面友好型UI和可脚本化CLI的工程师和FinOps从业者。
不在范围内： 移动优先用户界面；多租户SaaS（参见 云部署文档 用于拟议的内部多用户托管）。
价值
|你如何得到|
|--------|-----|
| 成本仪表板 |按服务和帐户期限选择器（MTD或滚动天数）、Marketplace等（请参阅 特性；API查询 period 在 配置) |
| 会话分析 |用简单的英语提问；代理使用AWS API和可选 MCP服务器 |
| 安全操作 |只读工具允许列表+可选输入护栏|
| 同源web应用程序 |运行时从FastAPI提供内置UI finops serve --打包简单，默认路径无CORS|
| 可追溯的进化 | 开放规范 规格和变更档案 openspec/ |
技术栈
| 层 | 技术 |
|---|---|
| 后端 | Python、FastAPI、Pydantic、boto3、Strands代理（OpenAI/Bedrock）、诗歌 |
| 前端 | React 18、Vite、顺风CSS |
| 质量 | Ruff、Bandit、pip审计、pytest、预提交 |
| 容器 | Docker、Docker组合；嵌入式前端构建 src/finops_buddy/webui/ 发布 |
建筑（高级）
更多细节： 建筑 ·拟议 亚马逊云服务 群众或部队的集合： 在AWS上部署 · 建议的OpenSpec订单 用于云硬化工作流。
快速开始
poetry install
poetry run finops serve
打开 http://127.0.0.1:8000 （默认绑定）。确保 AWS凭据 可用（例如。 ~/.aws, AWS_PROFILE).
CLI示例： poetry run finops whoami · poetry run finops profiles · poetry run finops costs · poetry run finops chat
完整文档： docs/README.md --配置、运行、Docker、开发、MCP、功能、演示模式。
文件索引
规范指数： docs/README.md；下面的快速链接。
| Doc | 需要时使用 |
|---|---|
| docs/README.md | 所有文档的索引 |
| docs/FEATURES.md | 用户界面截图、仪表板和聊天、演示模式 |
| docs/MCP.md | MCP服务器概述 |
| docs/CONFIGURATION.md | settings.yaml，每 FINOPS_* 变量、聊天/MCP行为， /print 导出（PDF管道和回退） |
| docs/RUNNING.md | API和UI，Vite-dev，完全重建，Docker，Windows设置 |
| docs/DEVELOPMENT.md | OpenSpec工作流、lint/test、CLI& /commands 聊天中 |
| docs/ARCHITECTURE.md | 系统体系结构（CLI、API、核心、代理、MCP） |
| docs/DEPLOY_AWS_ARCHITECTURE.md | 拟议的AWS部署（ECS、ALB、OIDC、Bedrock）；PDF兄弟 |
| docs/CLOUD_CHANGES_WORD_ORDER.md | 相关OpenSpec云更改的建议顺序 |
| docs/build_deploy_architecture_pdf.py | 重新生成 DEPLOY_AWS_ARCHITECTURE.pdf |
| config/settings.yaml | 注释模板（安全占位符） |
许可证和包装
项目元数据和打包： pyproject.toml (finops-buddy).入口点： finops CLI， finops serve 用于API+托管的UI。
