# auto-ops

**Repository Path**: RomanticCoder/auto-ops

## Basic Information

- **Project Name**: auto-ops
- **Description**: 前端自动化运维项目
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-21
- **Last Updated**: 2026-05-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Auto Ops

前端自动化运维项目 — 插件驱动的 DevOps 自动化引擎。

## 项目简介

Auto Ops 是一个基于插件的自动化运维引擎，支持通过 Web 面板触发 Git 克隆、Docker 构建等运维任务。采用 pnpm monorepo 架构，核心由插件 SDK、执行引擎、API 服务和前端面板组成。

## 架构

```
auto-ops/
├── packages/
│   ├── api-server/        # Express REST API (端口 3000)
│   ├── core-engine/       # 插件执行引擎（不可变状态）
│   ├── plugin-sdk/        # 插件类型定义与工具函数
│   └── web-dashboard/     # React 19 + Vite 6 前端面板
├── plugins/
│   ├── docker-plugin/     # Docker 构建与运行插件
│   ├── git-plugin/        # Git 仓库克隆插件
│   └── test-plugin/       # 测试验证插件
├── examples/
│   └── demo-app/          # Vue 3 示例应用（Docker 构建目标）
└── work/                  # 默认克隆目录
```

## 技术栈

| 层级       | 技术                          |
|-----------|-------------------------------|
| 运行环境   | Node.js (ESM)                 |
| 语言       | TypeScript 6.0                |
| 包管理     | pnpm 10.23.0 workspaces       |
| API 服务   | Express 5                     |
| 前端       | React 19 + Vite 6             |
| 示例应用   | Vue 3 + Vite 5 + nginx        |

## 快速开始

```bash
# 安装依赖
pnpm install

# 构建所有插件
pnpm build

# 启动开发模式（所有包并行）
pnpm dev

# 单独启动 API 服务
pnpm dev:api

# 单独启动前端面板
pnpm dev:web
```

## 执行流程

1. 用户在 Web 面板输入 Git 地址或点击操作按钮
2. 前端通过 HTTP 请求调用 API 服务
3. API 服务创建 Engine 实例，注册对应插件
4. Engine 按生命周期顺序执行插件钩子：`init → beforeExecute → execute → afterExecute → cleanup`
5. 任一钩子失败则中止执行并触发 `onError`
6. 返回 JSON 格式的执行结果

## 插件开发

插件需实现 `@auto-ops/plugin-sdk` 定义的 `PluginLifecycle` 接口：

```typescript
import { createPlugin, type PluginLifecycle } from '@auto-ops/plugin-sdk'

const lifecycle: PluginLifecycle = {
  init(ctx) {
    // 参数校验
    return true
  },
  execute(ctx) {
    // 核心逻辑
    return true
  },
  cleanup(ctx) {
    // 资源清理
    return true
  }
}

export default createPlugin({
  name: 'my-plugin',
  version: '0.1.0',
  description: 'My custom plugin'
}, lifecycle)
```

## License

MIT