dt-cr/README.md

AI 代码审查工具

# AI 辅助代码审查工具

基于 OpenRouter API 的代码审查工具，帮助开发者在提交代码前进行自动审查。

## 功能特点

- 支持 Git 和 SVN 版本控制系统
- 提取代码中的 TODO、FIXME、BUG 等特殊注释
- 检查环境相关问题（调试代码、测试端点等）
- 利用 AI 进行代码变更分析和智能总结
- 非阻塞式反馈，不影响正常提交流程

## 使用方法

### 设置 API Key

首次使用前，需要设置 OpenRouter API Key：

```bash
# 不安装的情况
npx dt-cr --set-key YOUR_API_KEY

# 全局安装的情况
dt-cr --set-key YOUR_API_KEY
```

API Key 将安全保存在用户主目录下的 `.dt-cr-config.json` 文件中，无需重复设置。

### 全局使用

```bash
# 不安装的情况，直接运行
npx dt-cr

# 全局安装的情况
npm install -g dt-cr

dt-cr

# 或添加到 package.json 脚本
# "scripts": {
#   "review": "dt-cr"
# }
```

### 显示帮助信息

```bash
dt-cr --help
```

## 工具配置

配置文件位于 `src/review.config.js`，可以自定义以下内容：

- 需要提取的注释标记（如 TODO、FIXME 等）
- 环境问题检测规则（调试代码、测试配置等）
- 忽略检查的路径
- OpenRouter API 设置`model`

## 发布 npm

1. 确保已经登录 npm 账户

```bash
npm login
```

2. 更新版本

```bash
# 升级补丁版本（修复 bug）
npm version patch

# 升级小版本（新增功能）
npm version minor

# 升级主版本（不兼容变更）
npm version major
```

2. 执行发布命令

```bash
# 组织的话需要加 npm publish --access public
npm publish
```