Skip to content

Commit 2afc64b

Browse files
committed
docs: sync README_CN.md and fix vscode extension build
1 parent 047f0d4 commit 2afc64b

3 files changed

Lines changed: 2945 additions & 9 deletions

File tree

README_CN.md

Lines changed: 130 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,21 @@ cm marketplace search --gpu
251251
cm marketplace install ml-pytorch
252252
```
253253

254-
### 7. VS Code 集成 (`cm code`)
254+
### 7. 即时分享 (`cm share`)
255+
256+
为团队生成“一键入职”链接。
257+
258+
```bash
259+
# 生成通用克隆命令
260+
cm share
261+
262+
# 生成 README Markdown 徽章
263+
cm share --format markdown
264+
```
265+
266+
输出类似:`cm clone https://github.com/org/repo`。该命令将克隆仓库、检测配置并立即进入开发环境。
267+
268+
### 8. VS Code 集成 (`cm code`)
255269

256270
在 VS Code 中打开项目,支持完整的 DevContainer。
257271

@@ -263,20 +277,47 @@ cm code
263277
- 启动带有 Remote-Containers 的 VS Code
264278
- 支持本地和远程容器
265279

280+
### 8. 多服务工作区 (`cm workspace`)
281+
282+
轻松编排复杂的微服务架构。`cm` 管理整个生命周期,包括依赖解析、共享网络和卷持久化。
283+
284+
**生命周期控制:**
285+
- `cm up`: 按依赖顺序启动所有服务。
286+
- `cm down`: 停止并移除服务。
287+
- `cm logs <service>`: 流式传输日志。
288+
- `cm ps`: 查看工作区进程。
289+
- `cm workspace graph`: 可视化依赖树。
290+
291+
### 9. Brownfield 迁移 (`cm import`)
292+
293+
无缝迁移现有项目。导入引擎解析 `docker-compose.yml`,执行兼容性分析,并生成原生 CM 配置。
294+
295+
**工作流:**
296+
- **Analyze**: 生成支持/不支持特性报告。
297+
- **Import**: 预览并转换服务、卷和网络。
298+
299+
```bash
300+
cm import docker-compose.yml
301+
```
302+
266303
---
267304

268305
## 🔧 高级功能
269306

270307
### DevContainer Features (OCI)
271308

272-
从 OCI 注册表安装额外工具:
309+
从 OCI 注册表安装额外工具,支持本地智能缓存
273310

274311
```bash
275312
# 添加 Go 到容器
276313
cm feature add ghcr.io/devcontainers/features/go
277314

278-
# 添加 Docker-in-Docker
279-
cm feature add ghcr.io/devcontainers/features/docker-in-docker
315+
# 下载并缓存 Feature
316+
cm feature download node
317+
318+
# 管理本地缓存
319+
cm feature cache
320+
cm feature cache clear
280321
```
281322

282323
### Docker Compose 集成
@@ -344,6 +385,63 @@ cm doctor --security
344385
- ⚠️ 敏感环境变量
345386
- ✅ 建议使用 Rootless Docker
346387

388+
### GPU 管理 (`cm gpu`)
389+
390+
对 AI/ML 开发的一流支持。Container-Maker 包含原生 GPU 调度器。
391+
392+
**功能:**
393+
- **自动检测**: 通过 `nvidia-smi` 零配置检测 NVIDIA GPU。
394+
- **硬件监控**: 实时跟踪显存、温度、功耗和利用率。
395+
- **智能调度**: 支持独占模式(专属任务)和共享模式(多服务共享显存)。
396+
397+
```bash
398+
# 列出 GPU
399+
cm gpu list
400+
401+
# 实时监控
402+
cm gpu status
403+
404+
# 申请资源
405+
cm gpu allocate training-job --count 2 --vram 16G
406+
```
407+
408+
### 服务模拟 (`cm mock`)
409+
410+
通过模拟上游依赖加速前端和微服务开发。
411+
412+
**能力:**
413+
- **动态响应**: 使用 Go 模板生成 JSON。
414+
- **延迟注入**: 模拟网络抖动和超时。
415+
- **契约验证**: 验证真实服务是否符合 API 契约 (OpenAPI)。
416+
417+
```bash
418+
# 快速模拟
419+
cm mock quick /api/status '{"status": "ok"}'
420+
421+
# 启动全功能服务器
422+
cm mock serve mocks.yaml
423+
```
424+
425+
### 企业级安全与合规
426+
427+
#### 策略即代码 (`cm policy`)
428+
使用类 Rego 的策略引擎强制执行组织标准。
429+
430+
**内置策略:**
431+
- `SEC-001` 🚨 禁止特权容器
432+
- `SEC-002` ⚠️ 强制非 root 用户
433+
- `RES-001` ⚠️ 必须定义内存/CPU 限制
434+
435+
#### SBOM 生成 (`cm sbom`)
436+
生成软件物料清单 (CycloneDX JSON),支持 Go, Node.js, Python。
437+
438+
```bash
439+
cm sbom -o sbom.json
440+
```
441+
442+
#### 插件系统 (`cm plugin`)
443+
扩展 Container-Maker 的能力,支持生命周期钩子 (`PreStart`/`PostStart`) 和自定义审计。
444+
347445
### 远程开发 (`cm remote`)
348446

349447
无缝连接远程机器并同步文件:
@@ -448,8 +546,21 @@ cm cloud dashboard
448546
- 实时实例监控
449547
- WebSocket 日志流
450548
- 交互式终端
549+
- 实时实例监控
550+
- WebSocket 日志流
551+
- 交互式终端
451552
- 使用分析和账单
452553

554+
### CLI 命令
555+
556+
```bash
557+
# 账单与用量
558+
cm cloud billing
559+
560+
# 列出支持的提供商
561+
cm cloud providers
562+
```
563+
453564
---
454565

455566
## 📊 TUI 仪表盘
@@ -589,13 +700,24 @@ cm status
589700
| `cm remote sync push` | 推送到远程 | `cm remote sync push` |
590701
| `cm remote sync pull` | 从远程拉取 | `cm remote sync pull` |
591702

592-
### 团队与组织
703+
### 团队与组织 (`cm team`)
704+
705+
管理企业配置、共享模板和审计日志。
593706

594707
| 命令 | 描述 | 示例 |
595708
|------|------|------|
596-
| `cm team set` | 设置组织 | `cm team set mycompany` |
597-
| `cm team templates` | 设置模板仓库 | `cm team templates <url>` |
598-
| `cm team info` | 显示团队配置 | `cm team info` |
709+
| **仓库管理** | | |
710+
| `cm team add` | 添加模板仓库 | `cm team add https://github.com/org/tmpls` |
711+
| `cm team sync` | 同步/更新仓库 | `cm team sync` |
712+
| `cm team list` | 列出缓存模板 | `cm team list` |
713+
| **企业控制** | | |
714+
| `cm team auth` | 配置认证 | `cm team auth --token <gh_token>` |
715+
| `cm team pin` | 锁定仓库版本 | `cm team pin hq@v1.2.0` |
716+
| `cm team var` | 设置全局变量 | `cm team var REGISTRY=harbor.internal` |
717+
| **审计** | | |
718+
| `cm team log` | 查看审计日志 | `cm team log` |
719+
| `cm team set-audit`| 启用/禁用审计 | `cm team set-audit on` |
720+
599721

600722
---
601723

0 commit comments

Comments
 (0)