29 lines
1.2 KiB
Markdown
29 lines
1.2 KiB
Markdown
# config/.codex 目录 Agent 指南
|
|
|
|
本目录用于维护 **Codex CLI 的项目级配置**（主要是 `config.toml`）。目标是：让团队/自己在不同机器上有一份可追踪、可回滚的配置基线。
|
|
|
|
## 目录结构
|
|
|
|
```text
|
|
config/.codex/
|
|
├── AGENTS.md # 本文件（目录级约束与说明）
|
|
└── config.toml # Codex CLI 配置（含详细中文注释）
|
|
```
|
|
|
|
## 操作规范
|
|
|
|
### 允许
|
|
- 维护 `config.toml` 的结构、注释与默认值（以“可理解 + 可回滚”为第一优先级）
|
|
- 增补/更新配置项的中文注释（说明用途、风险、推荐值）
|
|
|
|
### 禁止 / 强烈不推荐
|
|
- 在 `config.toml` 或本目录写入任何密钥、Token、个人隐私路径等敏感信息
|
|
- 把配置写成“只有你自己机器能用”的硬编码（如必须存在的绝对路径）
|
|
|
|
## 维护原则（约定）
|
|
|
|
- **注释优先**：新增配置项时必须写清楚“为什么需要它、不开会怎样、风险是什么”。
|
|
- **最小惊讶**：默认值尽量保守；高风险选项（例如放开权限）要明确标注风险与适用场景。
|
|
- **结构稳定**：同类配置放在同一段落，避免频繁无意义的重排导致 diff 噪音。
|
|
|