reaatech/agent-runbook-generator
GitHub: reaatech/agent-runbook-generator
这是一个基于 AI 的 CLI 工具,用于从服务仓库自动生成操作手册,以简化运维和事件响应流程。
Stars: 0 | Forks: 0
# 代理运行手册生成器
[](https://github.com/reaatech/agent-runbook-generator/actions/workflows/ci.yml)
[](LICENSE)
[](https://www.typescriptlang.org/)
此 monorepo 提供了标准的 A2A 参考类型、服务器框架、客户端 SDK 和 MCP 桥接,以及用于 AI 驱动的 DevOps 和 SRE 工作流的支撑基础设施。
## 功能
## 安装说明
### 使用包
包在 `@reaatech` 作用域下发布,可以单独安装:
```
# 核心类型、模式与实用工具
pnpm add @reaatech/agent-runbook
# 仓库分析(扫描器、配置解析器、代码分析器、依赖映射器)
pnpm add @reaatech/agent-runbook-analyzer
# 警报提取与生成
pnpm add @reaatech/agent-runbook-alerts
# 仪表板配置生成
pnpm add @reaatech/agent-runbook-dashboards
# 故障模式分析与缓解措施生成
pnpm add @reaatech/agent-runbook-failure-modes
# 健康检查生成(Kubernetes 探针、负载均衡器配置)
pnpm add @reaatech/agent-runbook-health-checks
# 事件响应工作流与通信模板
pnpm add @reaatech/agent-runbook-incident
# 带验证步骤的回滚程序生成
pnpm add @reaatech/agent-runbook-rollback
# 运行手册组装、格式化与编排流水线
pnpm add @reaatech/agent-runbook-runbook
# 服务依赖关系映射与图生成
pnpm add @reaatech/agent-runbook-service-map
# AI 代理层(LLM 提供者抽象、提示模板)
pnpm add @reaatech/agent-runbook-agent
# MCP 服务器(Model Context Protocol 工具注册表)
pnpm add @reaatech/agent-runbook-mcp @modelcontextprotocol/sdk
# 可观察性(日志、追踪、指标)
pnpm add @reaatech/agent-runbook-observability
# CLI 与编排器(包含以上所有)
pnpm add -g @reaatech/agent-runbook-cli
```
### 贡献
```
git clone https://github.com/reaatech/agent-runbook-generator.git
cd agent-runbook-generator
pnpm install
pnpm build
pnpm test
pnpm lint
```
## 包
| 包 | 描述 |
| --- | ----------- |
| [`@reaatech/agent-runbook`](./packages/core) | 核心类型、Zod 模式和工具函数 |
| [`@reaatech/agent-runbook-analyzer`](./packages/analyzer) | 仓库扫描和代码分析 |
| [`@reaatech/agent-runbook-alerts`](./packages/alerts) | 告警提取与生成 |
| [`@reaatech/agent-runbook-dashboards`](./packages/dashboards) | 仪表盘配置生成 |
| [`@reaatech/agent-runbook-failure-modes`](./packages/failure-modes) | 故障模式分析 |
| [`@reaatech/agent-runbook-health-checks`](./packages/health-checks) | 健康检查生成 |
| [`@reaatech/agent-runbook-incident`](./packages/incident) | 事件响应工作流 |
| [`@reaatech/agent-runbook-rollback`](./packages/rollback) | 回滚程序生成 |
| [`@reaatech/agent-runbook-runbook`](./packages/runbook) | 运行手册组装、格式化和流程 |
| [`@reaatech/agent-runbook-service-map`](./packages/service-map) | 服务依赖映射 |
| [`@reaatech/agent-runbook-agent`](./packages/agent) | AI 代理层 (LLM 提供者抽象) |
| [`@reaatech/agent-runbook-mcp`](./packages/mcp) | MCP 服务器 (跨 3 层共 16 个工具) |
| [`@reaatech/agent-runbook-observability`](./packages/observability) | 日志、追踪和指标 |
| [`@reaatech/agent-runbook-cli`](./packages/cli) | CLI 和编排器 |
## 文档
- [`ARCHITECTURE.md`](./ARCHITECTURE.md) — 系统设计、三层架构、数据流
- [`AGENTS.md`](./AGENTS.md) — 编码约定和代理开发指南
- [`CONTRIBUTING.md`](./CONTRIBUTING.md) — 贡献工作流和发布流程
- [`skills/`](./skills/) — 专门任务的代理技能定义
- [`examples/`](./examples/) — 示例运行手册输出和配置文件
## 许可证
[MIT](LICENSE)
标签:AI代理, AI辅助运维, AI驱动工具, API集成, GNU通用公共许可证, MCP服务器, monorepo, Node.js, SRE, SRE自动化, TypeScript, 仓库分析, 仪表板配置, 偏差过滤, 健康检查, 包管理, 可观测性, 回滚流程, 安全插件, 指标, 操作员运行手册, 故障模式分析, 日志, 服务依赖映射, 自动化攻击, 自动化运维, 警报管理, 跟踪, 运行手册生成