Skip to content

Commit 8a524c5

Browse files
committed
docs: add badges, quick start, prerequisites, AI CLI table, contributing guide, license
1 parent 4b37409 commit 8a524c5

3 files changed

Lines changed: 174 additions & 0 deletions

File tree

README.en.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,33 @@
44

55
# Dev Docker Image Packages
66

7+
![GitHub Release](https://img.shields.io/github/v/release/shumingyang-opencode/dev-docker-image-packages)
8+
![GHCR Pulls](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fghcr.io%2Fv2%2Fshumingyang-opencode%2Fpy-devkit-image-base&label=GHCR%20pulls&query=%24.pull_count)
9+
![GitHub Actions Workflow](https://img.shields.io/github/actions/workflow/status/shumingyang-opencode/dev-docker-image-packages/build-image.yml)
10+
711
A collection of personal Docker images, automatically built and published to GHCR via GitHub Actions.
812

13+
## Quick Start
14+
15+
```bash
16+
# 1. Pull the latest image
17+
docker pull ghcr.io/shumingyang-opencode/py-devkit-image-base:latest
18+
19+
# 2. Start a dev container
20+
docker run --rm -it ghcr.io/shumingyang-opencode/py-devkit-image-base:latest bash
21+
22+
# 3. Check the built-in AI CLIs
23+
opencode --version && copilot --help && lark-cli --version && trae-cli --version
24+
```
25+
26+
## Prerequisites
27+
28+
- [Docker](https://docs.docker.com/get-docker/) installed
29+
- GitHub account (to trigger CI builds and E2E tests)
30+
- API keys for each AI CLI (required for Advanced E2E tests)
31+
32+
> To simply **pull and run** an image, you only need Docker — no GitHub account required.
33+
934
## Available Images
1035

1136
| Image | Latest Version | Base | Description | Docs |
@@ -14,6 +39,17 @@ A collection of personal Docker images, automatically built and published to GHC
1439

1540
> For a full image index, see [images/README.md](./images/README.md).
1641
42+
## Built-in AI CLI Tools
43+
44+
| CLI | Package | Description | Needs API Key |
45+
|-----|---------|-------------|:-------------:|
46+
| `opencode` | npm (opencode-ai) | AI development assistant ||
47+
| `copilot` | npm (@github/copilot) | GitHub Copilot Agent ||
48+
| `lark-cli` | npm (@larksuite/cli) | Lark development CLI (internal network only) ||
49+
| `trae-cli` | pip (trae-agent) | AI Code Agent ||
50+
51+
> API keys are passed via environment variables. See each image's README for details.
52+
1753
## Image Tags
1854

1955
Each image is published to GHCR with the following tags:
@@ -198,6 +234,26 @@ bash skills/install.sh
198234
| "加 image" / "new image" / "create image" | Scaffold a new image (Dockerfile + README) |
199235
| "build image" / "建置 image" | Trigger GitHub Actions build for an image |
200236

237+
## Contributing
238+
239+
PRs and feature requests are welcome:
240+
241+
1. **Add a new image** — Create `images/<name>/` with a Dockerfile + test scripts, then add the agent config in `tests/e2e/agents/`
242+
2. **Improve tests** — Strengthen E2E test coverage or add new test cases
243+
3. **Documentation** — Fix typos, clarify instructions, or improve docs quality
244+
245+
How to contribute: Fork → Develop → Submit a PR → I'll review and merge.
246+
247+
## Related Projects
248+
249+
- [OpenCode](https://opencode.ai) — AI development assistant (built into this image)
250+
- [trae-agent](https://github.com/bytedance/trae-agent) — ByteDance open-source AI Agent
251+
- [GHCR](https://ghcr.io) — GitHub Container Registry
252+
253+
## License
254+
255+
MIT
256+
201257
## Project Structure
202258

203259
```

README.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,51 @@
44

55
# Dev Docker Image Packages
66

7+
![GitHub Release](https://img.shields.io/github/v/release/shumingyang-opencode/dev-docker-image-packages)
8+
![GHCR Pulls](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fghcr.io%2Fv2%2Fshumingyang-opencode%2Fpy-devkit-image-base&label=GHCR%20pulls&query=%24.pull_count)
9+
![GitHub Actions Workflow](https://img.shields.io/github/actions/workflow/status/shumingyang-opencode/dev-docker-image-packages/build-image.yml)
10+
711
個人開發用 Docker Image 集合,透過 GitHub Actions 自動建置並發佈至 GHCR。
812

913
## 目錄
1014

15+
- [Quick Start](#quick-start)
16+
- [需求](#需求)
1117
- [可用 Images](#可用-images)
18+
- [內建 AI CLI 工具](#內建-ai-cli-工具)
1219
- [Image Tags](#image-tags)
1320
- [使用方式](#使用方式)
1421
- [CI / GitHub Actions Workflows](#ci--github-actions-workflows)
1522
- [E2E 測試](#e2e-測試)
1623
- [Skills(OpenCode 整合)](#skillsopencode-整合)
24+
- [貢獻](#貢獻)
25+
- [相關專案](#相關專案)
26+
- [License](#license)
1727
- [專案目錄結構](#專案目錄結構)
1828

1929
---
2030

31+
## Quick Start
32+
33+
```bash
34+
# 1. 下載最新 Image
35+
docker pull ghcr.io/shumingyang-opencode/py-devkit-image-base:latest
36+
37+
# 2. 啟動開發容器
38+
docker run --rm -it ghcr.io/shumingyang-opencode/py-devkit-image-base:latest bash
39+
40+
# 3. 查看內建 AI CLI
41+
opencode --version && copilot --help && lark-cli --version && trae-cli --version
42+
```
43+
44+
## 需求
45+
46+
- [Docker](https://docs.docker.com/get-docker/) 已安裝
47+
- GitHub 帳號(用於觸發 CI 建置、E2E 測試)
48+
- 各 AI CLI 對應的 API Key(Advanced E2E 測試用)
49+
50+
> 若只需要 **Pull & Run** Image,則只需要 Docker,不需要 GitHub 帳號。
51+
2152
## 可用 Images
2253

2354
| Image | 最新版本 | Base | 用途 | 說明文件 |
@@ -26,6 +57,17 @@
2657

2758
> 詳細 Image 索引請見 [images/README.md](./images/README.md)
2859
60+
## 內建 AI CLI 工具
61+
62+
| CLI | 安裝方式 | 用途 | 需 API Key |
63+
|-----|---------|------|:----------:|
64+
| `opencode` | npm (opencode-ai) | AI 開發助手 ||
65+
| `copilot` | npm (@github/copilot) | GitHub Copilot Agent ||
66+
| `lark-cli` | npm (@larksuite/cli) | 飛書開發工具(內部網路專用) ||
67+
| `trae-cli` | pip (trae-agent) | AI Code Agent ||
68+
69+
> API Key 透過環境變數傳遞,詳見各 Image 說明文件。
70+
2971
## Image Tags
3072

3173
每個 Image 發佈至 GHCR 時會標記以下 tags:
@@ -214,6 +256,26 @@ bash skills/install.sh
214256
| 「加 image」 / 「new image」 / 「create image」 | 互動式新增 Image(Dockerfile + README) |
215257
| 「build image」 / 「建置 image」 | 觸發 GitHub Actions 建置指定 Image |
216258

259+
## 貢獻
260+
261+
歡迎提交 PR 或 Feature Request:
262+
263+
1. **新增 Image** — 在 `images/<name>/` 下建立 Dockerfile + 測試腳本,並在 `tests/e2e/agents/` 新增對應的設定檔
264+
2. **改善測試** — 補強 E2E 測試案例或新增測試覆蓋範圍
265+
3. **文件修正** — 修正錯字、補齊說明、改善文件品質
266+
267+
提交方式:Fork 此專案 → 開發 → 提交 PR → 我會審閱後合併
268+
269+
## 相關專案
270+
271+
- [OpenCode](https://opencode.ai) — AI 開發助手(本 Image 內建)
272+
- [trae-agent](https://github.com/bytedance/trae-agent) — ByteDance 開源 AI Agent
273+
- [GHCR](https://ghcr.io) — GitHub Container Registry
274+
275+
## License
276+
277+
MIT
278+
217279
## 專案目錄結構
218280

219281
```

README.zh-CN.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,33 @@
44

55
# Dev Docker Image Packages
66

7+
![GitHub Release](https://img.shields.io/github/v/release/shumingyang-opencode/dev-docker-image-packages)
8+
![GHCR Pulls](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fghcr.io%2Fv2%2Fshumingyang-opencode%2Fpy-devkit-image-base&label=GHCR%20pulls&query=%24.pull_count)
9+
![GitHub Actions Workflow](https://img.shields.io/github/actions/workflow/status/shumingyang-opencode/dev-docker-image-packages/build-image.yml)
10+
711
个人开发用 Docker Image 集合,通过 GitHub Actions 自动构建并发布至 GHCR。
812

13+
## Quick Start
14+
15+
```bash
16+
# 1. 下载最新 Image
17+
docker pull ghcr.io/shumingyang-opencode/py-devkit-image-base:latest
18+
19+
# 2. 启动开发容器
20+
docker run --rm -it ghcr.io/shumingyang-opencode/py-devkit-image-base:latest bash
21+
22+
# 3. 查看内置 AI CLI
23+
opencode --version && copilot --help && lark-cli --version && trae-cli --version
24+
```
25+
26+
## 需求
27+
28+
- [Docker](https://docs.docker.com/get-docker/) 已安装
29+
- GitHub 账号(用于触发 CI 构建、E2E 测试)
30+
- 各 AI CLI 对应的 API Key(Advanced E2E 测试用)
31+
32+
> 若只需要 **Pull & Run** Image,则只需要 Docker,不需要 GitHub 账号。
33+
934
## 可用 Images
1035

1136
| Image | 最新版本 | Base | 用途 | 说明文档 |
@@ -14,6 +39,17 @@
1439

1540
> 详细 Image 索引请见 [images/README.md](./images/README.md)
1641
42+
## 内置 AI CLI 工具
43+
44+
| CLI | 安装方式 | 用途 | 需 API Key |
45+
|-----|---------|------|:----------:|
46+
| `opencode` | npm (opencode-ai) | AI 开发助手 ||
47+
| `copilot` | npm (@github/copilot) | GitHub Copilot Agent ||
48+
| `lark-cli` | npm (@larksuite/cli) | 飞书开发工具(内部网络专用) ||
49+
| `trae-cli` | pip (trae-agent) | AI Code Agent ||
50+
51+
> API Key 通过环境变量传递,详见各 Image 说明文件。
52+
1753
## Image Tags
1854

1955
每个 Image 发布至 GHCR 时会标记以下 tags:
@@ -198,6 +234,26 @@ bash skills/install.sh
198234
| 「加 image」 / 「new image」 / 「create image」 | 互动式新增 Image(Dockerfile + README) |
199235
| 「build image」 / 「建置 image」 | 触发 GitHub Actions 构建指定 Image |
200236

237+
## 贡献
238+
239+
欢迎提交 PR 或 Feature Request:
240+
241+
1. **新增 Image** — 在 `images/<name>/` 下建立 Dockerfile + 测试脚本,并在 `tests/e2e/agents/` 新增对应的配置文件
242+
2. **改善测试** — 补强 E2E 测试案例或新增测试覆盖范围
243+
3. **文档修正** — 修正错字、补全说明、改善文档质量
244+
245+
提交方式:Fork 此项目 → 开发 → 提交 PR → 我会审核后合并
246+
247+
## 相关项目
248+
249+
- [OpenCode](https://opencode.ai) — AI 开发助手(本 Image 内置)
250+
- [trae-agent](https://github.com/bytedance/trae-agent) — ByteDance 开源 AI Agent
251+
- [GHCR](https://ghcr.io) — GitHub Container Registry
252+
253+
## License
254+
255+
MIT
256+
201257
## 项目目录结构
202258

203259
```

0 commit comments

Comments
 (0)