initial commit
This commit is contained in:
120
README.md
Normal file
120
README.md
Normal file
@@ -0,0 +1,120 @@
|
||||
# cross-eval
|
||||
|
||||
AI 에이전트 간 교차 검증을 자동화하는 CLI 도구.
|
||||
|
||||
기획서와 체크리스트를 기반으로 "생성 → 리뷰 → 피드백 → 재생성" 루프를 자동으로 돌려서,
|
||||
**과최적화 / 오탐 / 누락** 문제를 잡아냅니다.
|
||||
|
||||
## 설치
|
||||
|
||||
```bash
|
||||
# 1. 저장소 클론
|
||||
git clone <repository-url>
|
||||
cd cross-eval
|
||||
|
||||
# 2. 설치 (editable 모드 — 코드 수정 시 재설치 불필요)
|
||||
pip3 install -e .
|
||||
```
|
||||
|
||||
설치 후 터미널 어디서든 `cross-eval` 명령어를 사용할 수 있습니다.
|
||||
|
||||
```bash
|
||||
cross-eval --version
|
||||
```
|
||||
|
||||
### 요구사항
|
||||
|
||||
- Python 3.9+
|
||||
- [Claude CLI](https://docs.anthropic.com/en/docs/claude-code) 설치 및 인증 완료
|
||||
|
||||
## 사용법
|
||||
|
||||
### 1. 프로젝트 초기화
|
||||
|
||||
```bash
|
||||
cd my-project
|
||||
cross-eval init
|
||||
```
|
||||
|
||||
`.cross-eval/` 폴더 안에 `config.yaml`, `plan-sample.md`, `checklist-sample.md`가 생성됩니다.
|
||||
|
||||
### 2. 기획서 작성
|
||||
|
||||
샘플 파일을 복사하여 기획서와 체크리스트를 작성합니다.
|
||||
|
||||
```bash
|
||||
cp .cross-eval/plan-sample.md .cross-eval/plan.md
|
||||
cp .cross-eval/checklist-sample.md .cross-eval/checklist.md
|
||||
# plan.md, checklist.md 편집
|
||||
```
|
||||
|
||||
### 3. 실행
|
||||
|
||||
```bash
|
||||
# 기본 실행 (생성 → 리뷰, 최대 3회 반복)
|
||||
cross-eval run
|
||||
|
||||
# 프롬프트만 확인 (에이전트 호출 없이, 비용 절약)
|
||||
cross-eval run --dry-run
|
||||
|
||||
# 최대 반복 횟수 변경
|
||||
cross-eval run --max-iter 5
|
||||
|
||||
# 입력 파일 오버라이드
|
||||
cross-eval run --input plan=./docs/spec.md
|
||||
|
||||
# 설정 파일 지정
|
||||
cross-eval run --config .cross-eval/config.yaml
|
||||
```
|
||||
|
||||
### 4. 결과 확인
|
||||
|
||||
```
|
||||
output/
|
||||
├── v1/
|
||||
│ ├── generate.md # 에이전트 생성 결과
|
||||
│ └── review.md # 에이전트 리뷰 결과
|
||||
├── v2/
|
||||
│ ├── generate.md
|
||||
│ └── review.md
|
||||
└── final-report.md # 전체 요약 리포트
|
||||
```
|
||||
|
||||
## 설정 (`.cross-eval/config.yaml`)
|
||||
|
||||
```yaml
|
||||
output_dir: output
|
||||
max_iterations: 3
|
||||
language: ko # ko 또는 en (프롬프트 템플릿 언어)
|
||||
|
||||
inputs:
|
||||
plan: plan.md # config.yaml 기준 상대경로
|
||||
checklist: checklist.md
|
||||
|
||||
agents:
|
||||
generator:
|
||||
command: claude
|
||||
args: ["-p", "--model", "sonnet", "--permission-mode", "auto"]
|
||||
system_prompt: "You are a senior software engineer."
|
||||
reviewer:
|
||||
command: claude
|
||||
args: ["-p", "--model", "opus", "--permission-mode", "plan"]
|
||||
system_prompt: "You are a meticulous code reviewer."
|
||||
|
||||
pipeline: preset:simple
|
||||
```
|
||||
|
||||
실행 중에 `config.yaml`을 수정하면 다음 반복부터 자동으로 반영됩니다.
|
||||
|
||||
### 파이프라인 프리셋
|
||||
|
||||
| 프리셋 | 설명 |
|
||||
|--------|------|
|
||||
| `simple` | Agent A가 생성, Agent B가 리뷰 (기본값) |
|
||||
| `cross-review` | 둘 다 생성, 서로 교차 리뷰 |
|
||||
|
||||
```bash
|
||||
# 초기화 옵션
|
||||
cross-eval init --preset cross-review # 교차 리뷰 프리셋
|
||||
cross-eval init --lang en # 영어 템플릿
|
||||
```
|
||||
Reference in New Issue
Block a user