From 75030cd6a78ba12ba05b683aa26d41913ddffba9 Mon Sep 17 00:00:00 2001
From: "tao.chen" <93983997+taochen-ct@users.noreply.github.com>
Date: Thu, 18 Jun 2026 14:40:21 +0800
Subject: [PATCH] update readme

---
 README.md | 30 +++++++++++++++++++++++++++++-
 1 file changed, 29 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 2966b12..3b7b059 100644
--- a/README.md
+++ b/README.md
@@ -35,6 +35,29 @@ docker run -itd --name opencode -p 14096:4096 \
 - 三个 `-v` 挂载分别持久化 opencode 配置、运行数据、以及工作区文件
 - `web` 子命令以 `0.0.0.0` 监听并启用 mDNS，端口 `4096`，日志级别 DEBUG
 
+## 使用 docker compose
+
+仓库根目录提供 `docker-compose.yml`，与上面的 `docker run` 命令等价但更易管理（声明式、自动重启、`--build` 一条命令搞定）。**首次启动前** 需要从模板创建 `.env`（`.env` 已被 `.gitignore` 忽略，不会被提交）：
+
+```bash
+cp .env.example .env
+# 编辑 .env，把 OPENCODE_SERVER_PASSWORD 改成你自己的密码
+```
+
+```bash
+# 首次启动（或 Dockerfile / skills 变更后）：现场构建并后台启动
+docker compose up -d --build
+
+# 后续重启
+docker compose restart
+
+# 查看实时日志
+docker compose logs -f
+
+# 停止并移除容器
+docker compose down
+```
+
 ## Skills 概览
 
 `skills/` 下是一套端到端流水线，把中文业务数据需求一步步推到可评审的 PySpark SQL：
@@ -52,7 +75,11 @@ requirements-analysis → metadata-validator → logic-planner
 
 ```
 .
+├── .env.example                        # 环境变量模板（复制为 .env 并填值，.env 本身被 .gitignore 忽略）
+├── .gitignore                          # 忽略 .env、Python 缓存、IDE/OS 杂项
+├── CHANGELOG.md                        # 镜像版本演进记录
 ├── Dockerfile                          # 多阶段镜像构建
+├── docker-compose.yml                  # 等价于"运行"小节的 docker run
 ├── requirements.txt                    # Python 数据栈依赖
 ├── ripgrep-*.tar.gz                    # ripgrep 预编译包（构建时复制进镜像）
 ├── skills/
@@ -67,5 +94,6 @@ requirements-analysis → metadata-validator → logic-planner
 │   │       └── test_sql_guard.py       # 18 个用例的标准测试集
 │   ├── sql-review/                     # 静态评审（10 项检查）
 │   └── pyspark-sql-pipeline/           # 全流程 orchestrator
-└── CLAUDE.md                           # 给 Claude Code 的详细指南
+├── CLAUDE.md                           # 给 Claude Code 的详细指南
+└── README.md                           # 本文件
 ```