初次配置

环境要求

node > 18

原理

1. 通过git工具获取提交记录
2. 通过openai的模型分析提交记录
3. 生成md格式的分析报告

使用方法

安装

windows安装nodejs

1. 下载安装包：nodejs官网
2. 安装：双击安装包，一路下一步
3. 配置环境变量，添加nodejs的bin目录到环境变量中，例如：C:\Program Files\nodejs，一般安装完成后会自动配置好环境变量
4. 验证是否安装成功，打开cmd，输入以下命令，如果出现版本号，则安装成功。
``bash
node -v
npm -v
`

安装本工具

`bash
npm install -g code_review_assistant
`

使用

在项目的根目录下执行（需要项目使用了git）
`bash
codeReview run
`

!2024-02-22_105649.png

第一次使用会提示配置openai的key，粘贴输入即可。以后都不会再提示。

空格选择提交记录，选择完成，回车开始分析。

分析完成后，会在当前目录下生成md格式的分析报告。

修改配置

`bash
codeReview config
`

!2024-02-22_105820.png

选择需要修改的配置项，输入内容并回车即可修改。



!流程图

TODO

1. [x] git操作
1. [x] git diff
2. [x] git log`
2. [ ] UI界面
3. [ ] 全部代码分析，帮助新手辅助阅读整个代码库