@mison/ag-kit-cn 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (237) hide show
  1. package/.agent/.shared/ui-ux-pro-max/data/charts.csv +26 -0
  2. package/.agent/.shared/ui-ux-pro-max/data/colors.csv +97 -0
  3. package/.agent/.shared/ui-ux-pro-max/data/icons.csv +101 -0
  4. package/.agent/.shared/ui-ux-pro-max/data/landing.csv +31 -0
  5. package/.agent/.shared/ui-ux-pro-max/data/products.csv +97 -0
  6. package/.agent/.shared/ui-ux-pro-max/data/prompts.csv +24 -0
  7. package/.agent/.shared/ui-ux-pro-max/data/react-performance.csv +45 -0
  8. package/.agent/.shared/ui-ux-pro-max/data/stacks/flutter.csv +53 -0
  9. package/.agent/.shared/ui-ux-pro-max/data/stacks/html-tailwind.csv +56 -0
  10. package/.agent/.shared/ui-ux-pro-max/data/stacks/jetpack-compose.csv +53 -0
  11. package/.agent/.shared/ui-ux-pro-max/data/stacks/nextjs.csv +53 -0
  12. package/.agent/.shared/ui-ux-pro-max/data/stacks/nuxt-ui.csv +51 -0
  13. package/.agent/.shared/ui-ux-pro-max/data/stacks/nuxtjs.csv +59 -0
  14. package/.agent/.shared/ui-ux-pro-max/data/stacks/react-native.csv +52 -0
  15. package/.agent/.shared/ui-ux-pro-max/data/stacks/react.csv +54 -0
  16. package/.agent/.shared/ui-ux-pro-max/data/stacks/shadcn.csv +61 -0
  17. package/.agent/.shared/ui-ux-pro-max/data/stacks/svelte.csv +54 -0
  18. package/.agent/.shared/ui-ux-pro-max/data/stacks/swiftui.csv +51 -0
  19. package/.agent/.shared/ui-ux-pro-max/data/stacks/vue.csv +50 -0
  20. package/.agent/.shared/ui-ux-pro-max/data/styles.csv +59 -0
  21. package/.agent/.shared/ui-ux-pro-max/data/typography.csv +58 -0
  22. package/.agent/.shared/ui-ux-pro-max/data/ui-reasoning.csv +101 -0
  23. package/.agent/.shared/ui-ux-pro-max/data/ux-guidelines.csv +100 -0
  24. package/.agent/.shared/ui-ux-pro-max/data/web-interface.csv +31 -0
  25. package/.agent/.shared/ui-ux-pro-max/scripts/core.py +258 -0
  26. package/.agent/.shared/ui-ux-pro-max/scripts/design_system.py +1067 -0
  27. package/.agent/.shared/ui-ux-pro-max/scripts/search.py +106 -0
  28. package/.agent/ARCHITECTURE.md +285 -0
  29. package/.agent/agents/backend-specialist.md +268 -0
  30. package/.agent/agents/code-archaeologist.md +106 -0
  31. package/.agent/agents/database-architect.md +225 -0
  32. package/.agent/agents/debugger.md +225 -0
  33. package/.agent/agents/devops-engineer.md +242 -0
  34. package/.agent/agents/documentation-writer.md +104 -0
  35. package/.agent/agents/explorer-agent.md +73 -0
  36. package/.agent/agents/frontend-specialist.md +618 -0
  37. package/.agent/agents/game-developer.md +162 -0
  38. package/.agent/agents/mobile-developer.md +382 -0
  39. package/.agent/agents/orchestrator.md +438 -0
  40. package/.agent/agents/penetration-tester.md +188 -0
  41. package/.agent/agents/performance-optimizer.md +187 -0
  42. package/.agent/agents/product-manager.md +112 -0
  43. package/.agent/agents/product-owner.md +95 -0
  44. package/.agent/agents/project-planner.md +405 -0
  45. package/.agent/agents/qa-automation-engineer.md +103 -0
  46. package/.agent/agents/security-auditor.md +170 -0
  47. package/.agent/agents/seo-specialist.md +111 -0
  48. package/.agent/agents/test-engineer.md +158 -0
  49. package/.agent/mcp_config.json +12 -0
  50. package/.agent/rules/GEMINI.md +273 -0
  51. package/.agent/scripts/auto_preview.py +148 -0
  52. package/.agent/scripts/checklist.py +217 -0
  53. package/.agent/scripts/session_manager.py +120 -0
  54. package/.agent/scripts/verify_all.py +327 -0
  55. package/.agent/skills/api-patterns/SKILL.md +84 -0
  56. package/.agent/skills/api-patterns/api-style.md +42 -0
  57. package/.agent/skills/api-patterns/auth.md +24 -0
  58. package/.agent/skills/api-patterns/documentation.md +26 -0
  59. package/.agent/skills/api-patterns/graphql.md +41 -0
  60. package/.agent/skills/api-patterns/rate-limiting.md +31 -0
  61. package/.agent/skills/api-patterns/response.md +37 -0
  62. package/.agent/skills/api-patterns/rest.md +40 -0
  63. package/.agent/skills/api-patterns/scripts/api_validator.py +211 -0
  64. package/.agent/skills/api-patterns/security-testing.md +122 -0
  65. package/.agent/skills/api-patterns/trpc.md +41 -0
  66. package/.agent/skills/api-patterns/versioning.md +22 -0
  67. package/.agent/skills/app-builder/SKILL.md +75 -0
  68. package/.agent/skills/app-builder/agent-coordination.md +74 -0
  69. package/.agent/skills/app-builder/feature-building.md +53 -0
  70. package/.agent/skills/app-builder/project-detection.md +34 -0
  71. package/.agent/skills/app-builder/scaffolding.md +118 -0
  72. package/.agent/skills/app-builder/tech-stack.md +40 -0
  73. package/.agent/skills/app-builder/templates/SKILL.md +39 -0
  74. package/.agent/skills/app-builder/templates/astro-static/TEMPLATE.md +76 -0
  75. package/.agent/skills/app-builder/templates/chrome-extension/TEMPLATE.md +92 -0
  76. package/.agent/skills/app-builder/templates/cli-tool/TEMPLATE.md +88 -0
  77. package/.agent/skills/app-builder/templates/electron-desktop/TEMPLATE.md +88 -0
  78. package/.agent/skills/app-builder/templates/express-api/TEMPLATE.md +83 -0
  79. package/.agent/skills/app-builder/templates/flutter-app/TEMPLATE.md +90 -0
  80. package/.agent/skills/app-builder/templates/monorepo-turborepo/TEMPLATE.md +90 -0
  81. package/.agent/skills/app-builder/templates/nextjs-fullstack/TEMPLATE.md +122 -0
  82. package/.agent/skills/app-builder/templates/nextjs-saas/TEMPLATE.md +122 -0
  83. package/.agent/skills/app-builder/templates/nextjs-static/TEMPLATE.md +169 -0
  84. package/.agent/skills/app-builder/templates/nuxt-app/TEMPLATE.md +134 -0
  85. package/.agent/skills/app-builder/templates/python-fastapi/TEMPLATE.md +83 -0
  86. package/.agent/skills/app-builder/templates/react-native-app/TEMPLATE.md +119 -0
  87. package/.agent/skills/architecture/SKILL.md +57 -0
  88. package/.agent/skills/architecture/context-discovery.md +43 -0
  89. package/.agent/skills/architecture/examples.md +94 -0
  90. package/.agent/skills/architecture/pattern-selection.md +68 -0
  91. package/.agent/skills/architecture/patterns-reference.md +50 -0
  92. package/.agent/skills/architecture/trade-off-analysis.md +77 -0
  93. package/.agent/skills/bash-linux/SKILL.md +201 -0
  94. package/.agent/skills/behavioral-modes/SKILL.md +264 -0
  95. package/.agent/skills/brainstorming/SKILL.md +164 -0
  96. package/.agent/skills/brainstorming/dynamic-questioning.md +359 -0
  97. package/.agent/skills/clean-code/SKILL.md +200 -0
  98. package/.agent/skills/code-review-checklist/SKILL.md +125 -0
  99. package/.agent/skills/database-design/SKILL.md +54 -0
  100. package/.agent/skills/database-design/database-selection.md +43 -0
  101. package/.agent/skills/database-design/indexing.md +39 -0
  102. package/.agent/skills/database-design/migrations.md +50 -0
  103. package/.agent/skills/database-design/optimization.md +36 -0
  104. package/.agent/skills/database-design/orm-selection.md +30 -0
  105. package/.agent/skills/database-design/schema-design.md +56 -0
  106. package/.agent/skills/database-design/scripts/schema_validator.py +172 -0
  107. package/.agent/skills/deployment-procedures/SKILL.md +241 -0
  108. package/.agent/skills/doc.md +177 -0
  109. package/.agent/skills/documentation-templates/SKILL.md +194 -0
  110. package/.agent/skills/frontend-design/SKILL.md +418 -0
  111. package/.agent/skills/frontend-design/animation-guide.md +331 -0
  112. package/.agent/skills/frontend-design/color-system.md +307 -0
  113. package/.agent/skills/frontend-design/decision-trees.md +418 -0
  114. package/.agent/skills/frontend-design/motion-graphics.md +306 -0
  115. package/.agent/skills/frontend-design/scripts/accessibility_checker.py +183 -0
  116. package/.agent/skills/frontend-design/scripts/ux_audit.py +727 -0
  117. package/.agent/skills/frontend-design/typography-system.md +345 -0
  118. package/.agent/skills/frontend-design/ux-psychology.md +1118 -0
  119. package/.agent/skills/frontend-design/visual-effects.md +383 -0
  120. package/.agent/skills/game-development/2d-games/SKILL.md +119 -0
  121. package/.agent/skills/game-development/3d-games/SKILL.md +135 -0
  122. package/.agent/skills/game-development/SKILL.md +167 -0
  123. package/.agent/skills/game-development/game-art/SKILL.md +185 -0
  124. package/.agent/skills/game-development/game-audio/SKILL.md +190 -0
  125. package/.agent/skills/game-development/game-design/SKILL.md +129 -0
  126. package/.agent/skills/game-development/mobile-games/SKILL.md +108 -0
  127. package/.agent/skills/game-development/multiplayer/SKILL.md +132 -0
  128. package/.agent/skills/game-development/pc-games/SKILL.md +144 -0
  129. package/.agent/skills/game-development/vr-ar/SKILL.md +123 -0
  130. package/.agent/skills/game-development/web-games/SKILL.md +150 -0
  131. package/.agent/skills/geo-fundamentals/SKILL.md +155 -0
  132. package/.agent/skills/geo-fundamentals/scripts/geo_checker.py +289 -0
  133. package/.agent/skills/i18n-localization/SKILL.md +154 -0
  134. package/.agent/skills/i18n-localization/scripts/i18n_checker.py +241 -0
  135. package/.agent/skills/intelligent-routing/SKILL.md +335 -0
  136. package/.agent/skills/lint-and-validate/SKILL.md +44 -0
  137. package/.agent/skills/lint-and-validate/scripts/lint_runner.py +184 -0
  138. package/.agent/skills/lint-and-validate/scripts/type_coverage.py +173 -0
  139. package/.agent/skills/mcp-builder/SKILL.md +176 -0
  140. package/.agent/skills/mobile-design/SKILL.md +394 -0
  141. package/.agent/skills/mobile-design/decision-trees.md +516 -0
  142. package/.agent/skills/mobile-design/mobile-backend.md +491 -0
  143. package/.agent/skills/mobile-design/mobile-color-system.md +420 -0
  144. package/.agent/skills/mobile-design/mobile-debugging.md +122 -0
  145. package/.agent/skills/mobile-design/mobile-design-thinking.md +355 -0
  146. package/.agent/skills/mobile-design/mobile-navigation.md +458 -0
  147. package/.agent/skills/mobile-design/mobile-performance.md +767 -0
  148. package/.agent/skills/mobile-design/mobile-testing.md +356 -0
  149. package/.agent/skills/mobile-design/mobile-typography.md +432 -0
  150. package/.agent/skills/mobile-design/platform-android.md +666 -0
  151. package/.agent/skills/mobile-design/platform-ios.md +561 -0
  152. package/.agent/skills/mobile-design/scripts/mobile_audit.py +670 -0
  153. package/.agent/skills/mobile-design/touch-psychology.md +537 -0
  154. package/.agent/skills/nextjs-react-expert/1-async-eliminating-waterfalls.md +311 -0
  155. package/.agent/skills/nextjs-react-expert/2-bundle-bundle-size-optimization.md +241 -0
  156. package/.agent/skills/nextjs-react-expert/3-server-server-side-performance.md +489 -0
  157. package/.agent/skills/nextjs-react-expert/4-client-client-side-data-fetching.md +263 -0
  158. package/.agent/skills/nextjs-react-expert/5-rerender-re-render-optimization.md +581 -0
  159. package/.agent/skills/nextjs-react-expert/6-rendering-rendering-performance.md +431 -0
  160. package/.agent/skills/nextjs-react-expert/7-js-javascript-performance.md +683 -0
  161. package/.agent/skills/nextjs-react-expert/8-advanced-advanced-patterns.md +149 -0
  162. package/.agent/skills/nextjs-react-expert/SKILL.md +286 -0
  163. package/.agent/skills/nextjs-react-expert/scripts/convert_rules.py +222 -0
  164. package/.agent/skills/nextjs-react-expert/scripts/react_performance_checker.py +252 -0
  165. package/.agent/skills/nodejs-best-practices/SKILL.md +333 -0
  166. package/.agent/skills/parallel-agents/SKILL.md +194 -0
  167. package/.agent/skills/performance-profiling/SKILL.md +149 -0
  168. package/.agent/skills/performance-profiling/scripts/lighthouse_audit.py +76 -0
  169. package/.agent/skills/plan-writing/SKILL.md +152 -0
  170. package/.agent/skills/powershell-windows/SKILL.md +166 -0
  171. package/.agent/skills/python-patterns/SKILL.md +441 -0
  172. package/.agent/skills/red-team-tactics/SKILL.md +203 -0
  173. package/.agent/skills/rust-pro/SKILL.md +190 -0
  174. package/.agent/skills/seo-fundamentals/SKILL.md +135 -0
  175. package/.agent/skills/seo-fundamentals/scripts/seo_checker.py +215 -0
  176. package/.agent/skills/server-management/SKILL.md +161 -0
  177. package/.agent/skills/systematic-debugging/SKILL.md +114 -0
  178. package/.agent/skills/tailwind-patterns/SKILL.md +269 -0
  179. package/.agent/skills/tdd-workflow/SKILL.md +149 -0
  180. package/.agent/skills/testing-patterns/SKILL.md +178 -0
  181. package/.agent/skills/testing-patterns/scripts/test_runner.py +219 -0
  182. package/.agent/skills/vulnerability-scanner/SKILL.md +276 -0
  183. package/.agent/skills/vulnerability-scanner/checklists.md +131 -0
  184. package/.agent/skills/vulnerability-scanner/scripts/security_scan.py +459 -0
  185. package/.agent/skills/web-design-guidelines/SKILL.md +57 -0
  186. package/.agent/skills/webapp-testing/SKILL.md +187 -0
  187. package/.agent/skills/webapp-testing/scripts/playwright_runner.py +173 -0
  188. package/.agent/workflows/brainstorm.md +113 -0
  189. package/.agent/workflows/create.md +59 -0
  190. package/.agent/workflows/debug.md +103 -0
  191. package/.agent/workflows/deploy.md +176 -0
  192. package/.agent/workflows/enhance.md +63 -0
  193. package/.agent/workflows/orchestrate.md +242 -0
  194. package/.agent/workflows/plan.md +89 -0
  195. package/.agent/workflows/preview.md +80 -0
  196. package/.agent/workflows/restore-localize-compat.md +525 -0
  197. package/.agent/workflows/status.md +86 -0
  198. package/.agent/workflows/test.md +144 -0
  199. package/.agent/workflows/ui-ux-pro-max.md +295 -0
  200. package/AGENT_FLOW.md +609 -0
  201. package/CHANGELOG.md +68 -0
  202. package/LICENSE +21 -0
  203. package/README.md +260 -0
  204. package/bin/adapters/base.js +63 -0
  205. package/bin/adapters/codex.js +391 -0
  206. package/bin/adapters/gemini.js +137 -0
  207. package/bin/ag-kit.js +1336 -0
  208. package/bin/core/builder.js +80 -0
  209. package/bin/core/generator.js +59 -0
  210. package/bin/core/resource-loader.js +64 -0
  211. package/bin/core/transformer.js +208 -0
  212. package/bin/interactive.js +65 -0
  213. package/bin/utils/atomic-writer.js +97 -0
  214. package/bin/utils/git-helper.js +68 -0
  215. package/bin/utils/managed-block.js +65 -0
  216. package/bin/utils/manifest.js +241 -0
  217. package/bin/utils.js +82 -0
  218. package/docs/codex-rules-template.md +36 -0
  219. package/docs/mapping-spec.md +68 -0
  220. package/docs/multi-target-adapter.md +80 -0
  221. package/docs/official/README.md +53 -0
  222. package/docs/official/antigravity/agent-modes-settings.md +64 -0
  223. package/docs/official/antigravity/rules-workflows.md +96 -0
  224. package/docs/official/antigravity/skills.md +147 -0
  225. package/docs/official/codex/agents-md.md +119 -0
  226. package/docs/official/codex/config-advanced.md +358 -0
  227. package/docs/official/codex/config-basic.md +141 -0
  228. package/docs/official/codex/config-reference.md +223 -0
  229. package/docs/official/codex/config-sample.md +216 -0
  230. package/docs/official/codex/mcp.md +107 -0
  231. package/docs/official/codex/rules.md +79 -0
  232. package/docs/official/codex/skills.md +114 -0
  233. package/docs/official/sources-index.md +32 -0
  234. package/docs/operations.md +145 -0
  235. package/docs/terminology-style-guide.md +69 -0
  236. package/package.json +51 -0
  237. package/scripts/postinstall-check.js +112 -0
@@ -0,0 +1,96 @@
1
+ ---
2
+ slug: rules-workflows
3
+ section: 代理
4
+ title: 规则与工作流
5
+ path:
6
+ - 代理
7
+ - 规则与工作流
8
+ ---
9
+
10
+ # 规则与工作流(中文整理)
11
+
12
+ > 来源:`https://antigravity.google/docs/rules-workflows`
13
+ > 同步日期:2026-02-12
14
+ > 说明:本文件为官方内容的中文整理版,采用标准 Markdown 语法。
15
+
16
+ # Rules(规则)
17
+
18
+ Rules 是用户手动定义的约束,可在全局和工作区层级生效,用于把 Agent 的行为对齐到你的团队规范、技术栈和个人风格。
19
+
20
+ ## 快速开始
21
+
22
+ 1. 在编辑器 Agent 面板顶部点击 `...` 打开 Customizations。
23
+ 2. 进入 `Rules` 面板。
24
+ 3. 点击 `+ Global` 创建全局规则,或点击 `+ Workspace` 创建工作区规则。
25
+
26
+ 规则文件本质是 Markdown 文档。每个规则文件上限为 `12,000` 字符。
27
+
28
+ ## 全局规则
29
+
30
+ - 路径:`~/.gemini/GEMINI.md`
31
+ - 作用域:所有工作区
32
+
33
+ ## 工作区规则
34
+
35
+ - 路径:`<workspace-root>/.agent/rules/`
36
+ - 作用域:当前工作区(或对应 Git 根目录)
37
+
38
+ ## 规则激活方式
39
+
40
+ 每条规则可配置激活方式:
41
+
42
+ - `Manual`:通过输入框 `@提及` 手动启用。
43
+ - `Always On`:始终启用。
44
+ - `Model Decision`:由模型根据规则自然语言描述决定是否启用。
45
+ - `Glob`:按文件匹配模式启用(例如 `*.js`、`src/**/*.ts`)。
46
+
47
+ ## `@` 引用机制
48
+
49
+ 规则文件可通过 `@filename` 引用其他文件:
50
+
51
+ - 相对路径:相对于规则文件所在目录解析。
52
+ - 绝对路径:优先按真实绝对路径解析。
53
+ - 若绝对路径不存在,系统会尝试按仓库相对路径解析。
54
+
55
+ 示例:
56
+
57
+ - `@/path/to/file.md`:先尝试 `/path/to/file.md`,不存在则尝试 `workspace/path/to/file.md`。
58
+
59
+ # Workflows(工作流)
60
+
61
+ Workflows 用于把重复性任务固化为“可复用步骤序列”,例如部署、回评审意见、批量检查等。
62
+ 工作流保存为 Markdown 文件,可通过斜杠命令 `/workflow-name` 调用。
63
+
64
+ 与 Rules 的区别:
65
+
66
+ - Rules:提供长期、可复用的行为约束(提示层)。
67
+ - Workflows:提供结构化执行步骤(流程层)。
68
+
69
+ ## 创建工作流
70
+
71
+ 1. 在 Agent 面板顶部点击 `...` 打开 Customizations。
72
+ 2. 进入 `Workflows` 面板。
73
+ 3. 点击 `+ Global` 创建全局工作流,或点击 `+ Workspace` 创建工作区工作流。
74
+
75
+ ## 执行工作流
76
+
77
+ 在 Agent 中输入:
78
+
79
+ ```text
80
+ /workflow-name
81
+ ```
82
+
83
+ 工作流支持互相调用。例如 `/workflow-1` 的步骤中可包含“调用 `/workflow-2`”和“调用 `/workflow-3`”。
84
+
85
+ 工作流文件包含:
86
+
87
+ - 标题
88
+ - 描述
89
+ - 有序步骤说明
90
+
91
+ 每个工作流文件上限为 `12,000` 字符。
92
+
93
+ ## 让 Agent 生成工作流
94
+
95
+ 你也可以直接让 Agent 帮你生成工作流。
96
+ 当你已经手动完成一轮完整操作后,Agent 可以利用会话历史自动归纳并产出可复用工作流。
@@ -0,0 +1,147 @@
1
+ ---
2
+ title: 技能
3
+ slug: skills
4
+ path: ['代理', '技能']
5
+ ---
6
+
7
+ # Agent 技能(中文整理)
8
+
9
+ > 来源:`https://antigravity.google/docs/skills`
10
+ > 同步日期:2026-02-12
11
+ > 说明:本文件为官方内容的中文整理版,采用标准 Markdown 语法。
12
+
13
+ Skills 是扩展 Agent 能力的开放标准(见 `https://agentskills.io`)。
14
+ 一个 Skill 是一个目录,至少包含一个 `SKILL.md` 指令文件。
15
+
16
+ ## 什么是 Skill
17
+
18
+ Skill 是可复用的能力包,通常包含:
19
+
20
+ - 任务处理指令
21
+ - 最佳实践与约束
22
+ - 可选脚本与资源文件
23
+
24
+ 会话开始时,Agent 先看到所有 Skill 的元信息(名称、描述)。
25
+ 当某个 Skill 与当前任务相关时,Agent 再读取完整 `SKILL.md` 并执行。
26
+
27
+ ## Skill 存放位置
28
+
29
+ Antigravity 支持两类 Skill:
30
+
31
+ | 位置 | 作用域 |
32
+ | :--- | :--- |
33
+ | `<workspace-root>/.agent/skills/<skill-folder>/` | 工作区级 |
34
+ | `~/.gemini/antigravity/skills/<skill-folder>/` | 全局级(所有工作区) |
35
+
36
+ - 工作区 Skill:适合项目专属流程(如部署规范、测试约定)。
37
+ - 全局 Skill:适合跨项目复用的个人工具或通用能力。
38
+
39
+ ## 如何创建 Skill
40
+
41
+ 1. 在 Skill 目录下创建文件夹。
42
+ 2. 在该文件夹中创建 `SKILL.md`。
43
+
44
+ ```text
45
+ .agent/skills/
46
+ └── my-skill/
47
+ └── SKILL.md
48
+ ```
49
+
50
+ `SKILL.md` 示例:
51
+
52
+ ```markdown
53
+ ---
54
+ name: my-skill
55
+ description: 用于处理某类任务,在需要 X 或 Y 时使用。
56
+ ---
57
+
58
+ # 我的 Skill
59
+
60
+ 这里写详细指令。
61
+
62
+ ## 何时使用
63
+
64
+ - 场景 1
65
+ - 场景 2
66
+
67
+ ## 如何执行
68
+
69
+ 按步骤给出模式、约束、输出要求。
70
+ ```
71
+
72
+ ## Frontmatter 字段
73
+
74
+ | 字段 | 是否必填 | 说明 |
75
+ | :--- | :--- | :--- |
76
+ | `name` | 否 | Skill 唯一标识(建议小写 + 连字符)。省略时默认使用目录名。 |
77
+ | `description` | 是 | 描述 Skill 的用途与触发场景,供 Agent 判断是否启用。 |
78
+
79
+ 建议:
80
+
81
+ - 用第三人称描述 Skill 行为。
82
+ - 包含关键触发词,便于 Agent 识别。
83
+
84
+ ## 推荐目录结构
85
+
86
+ `SKILL.md` 是必需项,其他目录可选:
87
+
88
+ ```text
89
+ .agent/skills/my-skill/
90
+ ├── SKILL.md # 必需:核心指令
91
+ ├── scripts/ # 可选:执行脚本
92
+ ├── examples/ # 可选:示例实现
93
+ └── resources/ # 可选:模板/资源
94
+ ```
95
+
96
+ ## Agent 如何使用 Skill
97
+
98
+ Skill 使用“渐进式加载(progressive disclosure)”模式:
99
+
100
+ 1. **发现**:会话开始时仅加载 Skill 名称和描述。
101
+ 2. **激活**:判断相关后才读取完整 `SKILL.md`。
102
+ 3. **执行**:按 Skill 指令完成当前任务。
103
+
104
+ 你通常无需显式指定 Skill;Agent 会按上下文决定。
105
+ 如需强制使用,可在对话中点名 Skill。
106
+
107
+ ## 编写最佳实践
108
+
109
+ ### 单一职责
110
+
111
+ 每个 Skill 聚焦一个能力,避免“全能型”大杂烩 Skill。
112
+
113
+ ### 描述精确
114
+
115
+ `description` 要明确写出“做什么 + 什么时候用”。
116
+
117
+ ### 脚本黑盒化
118
+
119
+ 若包含脚本,优先让 Agent 用 `--help` 理解用法,避免无谓读取完整源码。
120
+
121
+ ### 添加决策分支
122
+
123
+ 复杂 Skill 建议加入“条件分支”说明,帮助 Agent 在不同场景选择正确路径。
124
+
125
+ ## 示例:代码审查 Skill
126
+
127
+ ```markdown
128
+ ---
129
+ name: code-review
130
+ description: 审查代码中的缺陷、风格问题与最佳实践偏差,适用于 PR 审查与质量检查。
131
+ ---
132
+
133
+ # 代码审查 Skill
134
+
135
+ ## 审查清单
136
+
137
+ 1. 正确性:是否满足需求与预期行为?
138
+ 2. 边界条件:异常与错误路径是否覆盖?
139
+ 3. 风格一致性:是否符合项目规范?
140
+ 4. 性能:是否存在明显低效实现?
141
+
142
+ ## 反馈方式
143
+
144
+ - 说明具体问题位置与影响
145
+ - 解释原因,不只给结论
146
+ - 提供可执行替代方案
147
+ ```
@@ -0,0 +1,119 @@
1
+ # 使用 AGENTS.md 自定义指令
2
+
3
+ > 来源:`https://developers.openai.com/codex/guides/agents-md`
4
+ > 同步日期:2026-02-12
5
+ > 说明:本文件为官方内容的中文整理版,采用标准 Markdown 语法。
6
+
7
+ Codex 在执行任务前会读取 `AGENTS.md` 指令链。
8
+ 通过“全局 + 项目 + 子目录”分层指令,你可以让 Agent 在不同仓库中保持一致行为,并允许就近覆盖。
9
+
10
+ ## Codex 如何发现与合并指令
11
+
12
+ Codex 启动时会构建一次指令链(TUI 通常是每次启动会话时构建)。
13
+
14
+ ### 发现顺序
15
+
16
+ 1. **全局层(Codex Home)**
17
+ - 目录:`$CODEX_HOME`(默认 `~/.codex`)
18
+ - 优先读取:`AGENTS.override.md`
19
+ - 若无再读取:`AGENTS.md`
20
+ - 同层最多取第一个非空文件
21
+
22
+ 2. **项目层(从项目根到当前目录)**
23
+ - 每一层目录按顺序检查:
24
+ - `AGENTS.override.md`
25
+ - `AGENTS.md`
26
+ - `project_doc_fallback_filenames` 中定义的备选文件名
27
+ - 每层目录最多取一个文件
28
+
29
+ 3. **合并顺序**
30
+ - 从根目录到当前目录依次拼接
31
+ - 越靠近当前目录的文件越“后出现”,覆盖能力越强
32
+
33
+ ### 大小限制
34
+
35
+ - 受 `project_doc_max_bytes` 控制(默认 `32 KiB`)
36
+ - 空文件会被跳过
37
+ - 达到上限后停止继续追加
38
+
39
+ ## 创建全局指令
40
+
41
+ ```bash
42
+ mkdir -p ~/.codex
43
+ ```
44
+
45
+ 在 `~/.codex/AGENTS.md` 写入跨项目通用规范,例如:
46
+
47
+ ```markdown
48
+ # 全局工作约定
49
+
50
+ ## 代码风格
51
+ - 先保证正确性,再追求优化
52
+ - 变更应尽量小而可回滚
53
+
54
+ ## 输出要求
55
+ - 先给结论,再给依据
56
+ - 明确列出未完成项与风险
57
+ ```
58
+
59
+ ## 创建项目级与目录级指令
60
+
61
+ 在仓库根目录放项目总约束:
62
+
63
+ ```text
64
+ repo/
65
+ ├── AGENTS.md
66
+ └── services/
67
+ ├── AGENTS.md
68
+ └── api/
69
+ └── AGENTS.md
70
+ ```
71
+
72
+ 这样可以形成“总规则 -> 模块规则 -> 子模块规则”的分层覆盖。
73
+
74
+ ## 备选文件名(Fallback)
75
+
76
+ 当目录内不存在 `AGENTS.md` 时,可以通过配置补充候选文件名:
77
+
78
+ ```toml
79
+ project_doc_fallback_filenames = ["TEAM.md", "ASSISTANT.md"]
80
+ ```
81
+
82
+ 用途:
83
+
84
+ - 与历史文档命名兼容
85
+ - 渐进迁移到 `AGENTS.md`
86
+
87
+ ## 验证是否生效
88
+
89
+ 建议检查:
90
+
91
+ 1. `AGENTS.md` 是否在预期目录存在且非空
92
+ 2. 项目是否被标记为受信任
93
+ 3. `project_doc_max_bytes` 是否过小导致截断
94
+ 4. 是否被同层的 `AGENTS.override.md` 覆盖
95
+
96
+ ## 常见问题排查
97
+
98
+ ### 指令没生效
99
+
100
+ - 检查当前 `cwd` 是否在目标目录链下
101
+ - 检查项目是否不受信任(会跳过项目级配置层)
102
+ - 检查文档是否超限被截断
103
+
104
+ ### 指令互相冲突
105
+
106
+ - 按目录层级拆分职责
107
+ - 通用规则上移到根目录
108
+ - 细节规则下沉到子目录
109
+
110
+ ### 想临时覆盖全局规则
111
+
112
+ - 在 `~/.codex` 放置 `AGENTS.override.md`,其优先级高于同层 `AGENTS.md`
113
+
114
+ ## 实践建议
115
+
116
+ - 全局层只放稳定工作约定
117
+ - 项目根放仓库级规范(测试、提交、架构约束)
118
+ - 子目录放模块级细则(接口契约、边界约束)
119
+ - 指令保持短句、可执行、可验证
@@ -0,0 +1,358 @@
1
+ # 高级配置(Advanced Configuration)
2
+
3
+ > 来源:`https://developers.openai.com/codex/config-advanced`
4
+ > 同步日期:2026-02-12
5
+ > 说明:本文件为官方内容的中文整理版,采用标准 Markdown 语法。
6
+
7
+ 当你需要更细粒度控制模型提供方、安全策略、MCP、可观测性等能力时,使用本页配置。
8
+ 基础项先看 `config-basic.md`。
9
+
10
+ ## Profiles(命名配置集)
11
+
12
+ Profile 可把一组配置命名保存,并通过 CLI 快速切换。
13
+
14
+ 注意:
15
+
16
+ - 当前为实验能力,后续可能调整。
17
+ - Codex IDE 扩展当前不支持 profile 切换。
18
+
19
+ 示例:
20
+
21
+ ```toml
22
+ model = "gpt-5-codex"
23
+ approval_policy = "on-request"
24
+
25
+ [profiles.deep-review]
26
+ model = "gpt-5-pro"
27
+ model_reasoning_effort = "high"
28
+ approval_policy = "never"
29
+
30
+ [profiles.lightweight]
31
+ model = "gpt-4.1"
32
+ approval_policy = "untrusted"
33
+ ```
34
+
35
+ 调用方式:
36
+
37
+ ```bash
38
+ codex --profile deep-review
39
+ ```
40
+
41
+ 设置默认 profile:
42
+
43
+ ```toml
44
+ profile = "deep-review"
45
+ ```
46
+
47
+ ## 单次运行覆盖配置(CLI)
48
+
49
+ 除编辑 `~/.codex/config.toml` 外,也可为单次运行覆盖配置。
50
+
51
+ - 有专用参数时优先用专用参数(如 `--model`)。
52
+ - 其他键用 `-c` / `--config`。
53
+
54
+ ```bash
55
+ # 专用参数
56
+ codex --model gpt-5.2
57
+
58
+ # 通用覆盖(值按 TOML 解析)
59
+ codex --config model='"gpt-5.2"'
60
+ codex --config sandbox_workspace_write.network_access=true
61
+ codex --config 'shell_environment_policy.include_only=["PATH","HOME"]'
62
+ ```
63
+
64
+ 说明:
65
+
66
+ - 支持点号路径设置嵌套键(如 `mcp_servers.context7.enabled=false`)。
67
+ - `--config` 值按 TOML 解析;解析失败时按字符串处理。
68
+
69
+ ## 配置与状态目录
70
+
71
+ Codex 本地状态目录:`$CODEX_HOME`(默认 `~/.codex`)。
72
+
73
+ 常见文件:
74
+
75
+ - `config.toml`:本地配置
76
+ - `auth.json`:文件型凭据存储(或系统 keychain/keyring)
77
+ - `history.jsonl`:会话历史(启用持久化时)
78
+ - 日志与缓存文件
79
+
80
+ ## 项目级配置(`.codex/config.toml`)
81
+
82
+ Codex 会从项目根到当前目录逐层加载 `.codex/config.toml`。
83
+ 同名键冲突时,离当前目录最近的配置生效。
84
+
85
+ 安全规则:
86
+
87
+ - 仅受信任项目加载项目级 `.codex/config.toml`
88
+ - 不受信任项目会忽略项目级配置
89
+
90
+ 路径解析规则:
91
+
92
+ - 项目配置中的相对路径,按该配置文件所在 `.codex/` 目录解析
93
+
94
+ ## 项目根识别
95
+
96
+ 默认遇到 `.git` 即视为项目根。可通过 `project_root_markers` 调整:
97
+
98
+ ```toml
99
+ project_root_markers = [".git", ".hg", ".sl"]
100
+ ```
101
+
102
+ 若设置为空数组:
103
+
104
+ ```toml
105
+ project_root_markers = []
106
+ ```
107
+
108
+ 则不向上查找父目录,当前目录即项目根。
109
+
110
+ ## 自定义模型提供方(Model Provider)
111
+
112
+ Provider 决定 Codex 如何连接模型(`base_url`、协议、鉴权、请求头等)。
113
+
114
+ ```toml
115
+ model = "gpt-5.1"
116
+ model_provider = "proxy"
117
+
118
+ [model_providers.proxy]
119
+ name = "OpenAI via Proxy"
120
+ base_url = "http://proxy.example.com"
121
+ env_key = "OPENAI_API_KEY"
122
+
123
+ [model_providers.ollama]
124
+ name = "Ollama"
125
+ base_url = "http://localhost:11434/v1"
126
+ ```
127
+
128
+ 附加请求头:
129
+
130
+ ```toml
131
+ [model_providers.example]
132
+ http_headers = { "X-Example-Header" = "example-value" }
133
+ env_http_headers = { "X-Example-Features" = "EXAMPLE_FEATURES" }
134
+ ```
135
+
136
+ ## OSS 模式(本地开源模型)
137
+
138
+ `--oss` 可切换到本地 provider(如 Ollama、LM Studio)。
139
+
140
+ ```toml
141
+ oss_provider = "ollama" # 或 lmstudio
142
+ ```
143
+
144
+ ## Azure 与数据驻留(Data Residency)
145
+
146
+ Azure 示例:
147
+
148
+ ```toml
149
+ [model_providers.azure]
150
+ name = "Azure"
151
+ base_url = "https://YOUR_PROJECT_NAME.openai.azure.com/openai"
152
+ env_key = "AZURE_OPENAI_API_KEY"
153
+ query_params = { api-version = "2025-04-01-preview" }
154
+ wire_api = "responses"
155
+ ```
156
+
157
+ 数据驻留示例:
158
+
159
+ ```toml
160
+ model_provider = "openaidr"
161
+
162
+ [model_providers.openaidr]
163
+ name = "OpenAI Data Residency"
164
+ base_url = "https://us.api.openai.com/v1"
165
+ ```
166
+
167
+ ## 推理、冗长度与上下文限制
168
+
169
+ ```toml
170
+ model_reasoning_summary = "none"
171
+ model_verbosity = "low"
172
+ model_supports_reasoning_summaries = true
173
+ model_context_window = 128000
174
+ ```
175
+
176
+ 说明:
177
+
178
+ - `model_verbosity` 仅对 Responses API provider 生效。
179
+ - Chat Completions provider 可能忽略该设置。
180
+
181
+ ## 审批策略与沙箱策略
182
+
183
+ ```toml
184
+ approval_policy = "untrusted" # 也可 on-request / on-failure / never
185
+ sandbox_mode = "workspace-write"
186
+
187
+ [sandbox_workspace_write]
188
+ exclude_tmpdir_env_var = false
189
+ exclude_slash_tmp = false
190
+ writable_roots = ["/Users/YOU/.pyenv/shims"]
191
+ network_access = false
192
+ ```
193
+
194
+ 提示:
195
+
196
+ - `workspace-write` 下某些环境会保持 `.git/`、`.codex/` 只读。
197
+ - 若需控制“哪些命令可跳出沙箱”,结合 `rules` 使用。
198
+ - `danger-full-access` 会关闭沙箱隔离,仅适用于你已具备外部隔离措施的环境。
199
+
200
+ ## Shell 环境变量策略
201
+
202
+ `shell_environment_policy` 控制 Codex 启动子进程时可继承哪些环境变量。
203
+
204
+ ```toml
205
+ [shell_environment_policy]
206
+ inherit = "none" # all / core / none
207
+ set = { PATH = "/usr/bin", MY_FLAG = "1" }
208
+ ignore_default_excludes = false
209
+ exclude = ["AWS_*", "AZURE_*"]
210
+ include_only = ["PATH", "HOME"]
211
+ ```
212
+
213
+ 说明:
214
+
215
+ - 匹配规则为不区分大小写的 glob。
216
+ - 默认会过滤包含 `KEY` / `SECRET` / `TOKEN` 的变量名(除非显式放开)。
217
+
218
+ ## MCP 配置
219
+
220
+ MCP 细节请参见 `mcp.md`。
221
+ 常见配置入口为 `[mcp_servers.<name>]`。
222
+
223
+ ## 可观测性与遥测(OTel + Metrics)
224
+
225
+ 默认关闭。启用示例:
226
+
227
+ ```toml
228
+ [otel]
229
+ environment = "staging"
230
+ exporter = "none" # 或 otlp-http / otlp-grpc
231
+ log_user_prompt = false
232
+ ```
233
+
234
+ HTTP 导出示例:
235
+
236
+ ```toml
237
+ [otel]
238
+ exporter = { otlp-http = {
239
+ endpoint = "https://otel.example.com/v1/logs",
240
+ protocol = "binary",
241
+ headers = { "x-otlp-api-key" = "${OTLP_TOKEN}" }
242
+ }}
243
+ ```
244
+
245
+ gRPC 导出示例:
246
+
247
+ ```toml
248
+ [otel]
249
+ exporter = { otlp-grpc = {
250
+ endpoint = "https://otel.example.com:4317",
251
+ headers = { "x-otlp-meta" = "abc123" }
252
+ }}
253
+ ```
254
+
255
+ ### 典型事件
256
+
257
+ - `codex.conversation_starts`
258
+ - `codex.api_request`
259
+ - `codex.sse_event`
260
+ - `codex.websocket_request`
261
+ - `codex.websocket_event`
262
+ - `codex.user_prompt`(默认脱敏)
263
+ - `codex.tool_decision`
264
+ - `codex.tool_result`
265
+
266
+ ### 常见 OTel 指标
267
+
268
+ | 指标 | 类型 | 说明 |
269
+ | :--- | :--- | :--- |
270
+ | `codex.api_request` | counter | API 请求计数 |
271
+ | `codex.api_request.duration_ms` | histogram | API 请求耗时 |
272
+ | `codex.sse_event` | counter | SSE 事件计数 |
273
+ | `codex.sse_event.duration_ms` | histogram | SSE 处理耗时 |
274
+ | `codex.tool.call` | counter | 工具调用计数 |
275
+ | `codex.tool.call.duration_ms` | histogram | 工具执行耗时 |
276
+
277
+ ### 匿名指标开关
278
+
279
+ ```toml
280
+ [analytics]
281
+ enabled = false
282
+ ```
283
+
284
+ 该开关与 OTel 导出独立。
285
+
286
+ ## 反馈开关
287
+
288
+ 默认允许 `/feedback`。可全局禁用:
289
+
290
+ ```toml
291
+ [feedback]
292
+ enabled = false
293
+ ```
294
+
295
+ ## 推理内容显示控制
296
+
297
+ ```toml
298
+ hide_agent_reasoning = true
299
+ # show_raw_agent_reasoning = true
300
+ ```
301
+
302
+ 建议仅在确有需要时显示原始推理内容。
303
+
304
+ ## 通知(notify / TUI 通知)
305
+
306
+ 外部通知程序:
307
+
308
+ ```toml
309
+ notify = ["python3", "/path/to/notify.py"]
310
+ ```
311
+
312
+ 通知参数为单个 JSON 字符串,常见字段:
313
+
314
+ - `type`
315
+ - `thread-id`
316
+ - `turn-id`
317
+ - `cwd`
318
+ - `input-messages`
319
+ - `last-assistant-message`
320
+
321
+ TUI 相关键位于 `[tui]`:
322
+
323
+ - `tui.notifications`
324
+ - `tui.notification_method`(`auto` / `osc9` / `bel`)
325
+ - `tui.animations`
326
+ - `tui.alternate_screen`
327
+ - `tui.show_tooltips`
328
+
329
+ ## 历史持久化
330
+
331
+ 关闭历史:
332
+
333
+ ```toml
334
+ [history]
335
+ persistence = "none"
336
+ ```
337
+
338
+ 限制历史文件大小:
339
+
340
+ ```toml
341
+ [history]
342
+ max_bytes = 104857600
343
+ ```
344
+
345
+ ## 可点击引用(file_opener)
346
+
347
+ ```toml
348
+ file_opener = "vscode" # 或 cursor / windsurf / vscode-insiders / none
349
+ ```
350
+
351
+ ## 项目指令发现
352
+
353
+ 两项关键参数:
354
+
355
+ - `project_doc_max_bytes`
356
+ - `project_doc_fallback_filenames`
357
+
358
+ 用于控制 `AGENTS.md`(及备选文件)读取范围与容量。