CLAUDE.md

1# Code Review Agent
2 
3An LLM-powered code review agent built on the simple-agent SDK.
4 
5## Quick Start
6 
7```bash
8# Install dependencies
9npm install
10 
11# Run code review
12npm run start -- "帮我 review 当前的改动"
13```
14 
15## Usage Scenarios
16 
17```bash
18# Review uncommitted changes (staged + unstaged)
19npm run start -- "帮我 review 当前的改动"
20 
21# Review branch diff vs main
22npm run start -- "帮我 review 当前 branch 新代码"
23 
24# Review specific commit
25npm run start -- "帮我 review commit abc123 的代码"
26 
27# Review changes after a commit
28npm run start -- "帮我 review commit abc123 之后的代码"
29 
30# Review PR (requires gh CLI)
31npm run start -- "帮我 review PR 42"
32```
33 
34## Environment Variables
35 
36- `OPENAI_API_KEY` - Required for LLM API access
37- `OPENAI_MODEL` - Model to use (default: gpt-5-codex)
38 
39## Project Structure
40 
41```
42codereview-agent/
43├── prompts/
44│   └── system.md          # System prompt (LLM behavior guide)
45├── src/
46│   ├── index.ts           # Public exports
47│   ├── agent.ts           # createCodeReviewAgent factory
48│   ├── cli.ts             # CLI entry point
49│   └── tools/
50│       ├── bash.ts        # Basic shell commands (read-only)
51│       ├── read-file.ts   # Read files in repo
52│       ├── write-file.ts  # Write review reports
53│       ├── git.ts         # Git commands (read-only)
54│       └── gh.ts          # GitHub CLI (read-only)
55└── examples/
56    └── basic-review.ts    # Usage example
57```
58 
59## Development
60 
61```bash
62# Type check
63npm run typecheck
64 
65# Lint
66npm run lint
67 
68# Build
69npm run build
70```
71 
72## Architecture
73 
74The agent follows an LLM-driven architecture where:
75 
761. **System Prompt** defines all business logic (intent understanding, tool selection, output format)
772. **Agent Code** provides tools and security checks only
783. **Tools** are read-only by design (git/gh commands are whitelisted)
79 
80This design keeps the agent code minimal while allowing complex review workflows through prompt engineering.
81