Documentation Index
Fetch the complete documentation index at: https://docs.kodus.io/llms.txt
Use this file to discover all available pages before exploring further.
为新团队启动 Kodus 大约需要 30 分钟。本指南介绍完整设置，使您的团队从第一个 PR 开始就能获得价值。
步骤 1 — 创建和配置工作区
- 在 kodus.io 注册或访问自托管实例
- 为团队创建新工作区
- 连接 Git 提供商（GitHub、GitLab、Bitbucket 或 Azure DevOps）
- 选择要监控的代码库
步骤 2 — 设置审查基线
在自定义之前从合理的默认值开始：
# kodus-config.yml — 放入每个代码库根目录
reviewOptions:
security: true
code_style: true
kody_rules: true
refactoring: true
error_handling: true
maintainability: true
potential_issues: true
performance_and_optimization: true
business_logic: true
suggestionControl:
groupingMode: full
limitationType: pr
maxSuggestions: 9
severityLevelFilter: medium
automatedReviewActive: true
步骤 3 — 从 IDE 工具导入现有规则
如果团队已经使用 Cursor、Copilot 或 Claude 规则：
- 前往代码审查设置 → Kody 规则
- Kodus 检测
.cursorrules、.github/copilot-instructions.md 和 .claude 文件
- 导入对代码审查有意义的规则
这避免了从头重写规则。
步骤 4 — 教授前 5 个约定
不要试图在第一天就编码所有内容。从团队争论最多的 5 个约定开始：
@kody remember: we use camelCase for variables and PascalCase for types.
@kody remember: all API responses use the standard envelope format
{ data, error, meta }.
@kody remember: we prefer composition over inheritance.
Use interfaces and dependency injection.
@kody remember: every public function must have JSDoc with
@param and @returns descriptions.
@kody remember: database queries go through the repository layer only.
No direct DB access from services or controllers.
步骤 5 — 创建 2-3 个关键规则
添加绝对不能发生的事情的规则：
名称：生产代码中禁止 console.log
范围：文件
路径：src/**/*.ts
严重性：高
说明：标记 fileDiff 中的任何 console.log、console.warn 或 console.error。
请使用项目日志记录器。排除测试文件（*.spec.ts、*.test.ts）。
名称：禁止硬编码 API URL
范围：文件
路径：src/**/*.ts
严重性：严重
说明：标记 fileDiff 中任何看起来像 API 端点的硬编码 URL（http:// 或 https://）。
URL 必须来自环境变量或配置文件。
步骤 6 — 连接任务管理（可选但推荐）
在设置 → 插件中连接 Jira、Linear、Notion 或 ClickUp 以启用业务逻辑验证。这让 Kodus 检查 PR 是否实现了任务描述的内容。
步骤 7 — 运行试点 PR
打开一个测试 PR 并验证：
步骤 8 — 一周后收集反馈
一周审查后，与团队确认：
- 建议太多？→ 提高
severityLevelFilter 或降低 maxSuggestions
- 规则太嘈杂？→ 缩小文件路径或添加排除
- 遗漏重要模式？→ 添加新规则或记忆
- 想要自动生成规则？→ 点击生成 Kody 规则从审查历史中获取建议
- 第一天不要过度添加规则 — 从小处开始逐步增长
- 让团队在正式化为规则之前通过对话自然地教 Kody
- 前几个 PR 使用
@kody start-review 让团队看到 Kodus 的实际效果
- 如果想审查 Kody 学到的内容，启用 LLM 生成记忆审批
完整设置指南，请参阅快速开始。
