diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 11ea5a6..5f81061 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -151,7 +151,6 @@ Documentation is a crucial part of OpenCodeReview. We welcome improvements to RE | `README.zh-CN.md` | Chinese translation | | `CONTRIBUTING.md` | Contribution guide (English) | | `CONTRIBUTING.zh-CN.md` | Contribution guide (Chinese) | -| `NPM-README.md` | Description shown on npm registry | ## Submitting Changes diff --git a/CONTRIBUTING.zh-CN.md b/CONTRIBUTING.zh-CN.md index 1f74621..c59e79d 100644 --- a/CONTRIBUTING.zh-CN.md +++ b/CONTRIBUTING.zh-CN.md @@ -151,7 +151,6 @@ make build | `README.zh-CN.md` | 中文翻译 | | `CONTRIBUTING.md` | 贡献指南(英文) | | `CONTRIBUTING.zh-CN.md` | 贡献指南(中文) | -| `NPM-README.md` | npm 发布页展示的说明 | ## 提交变更 diff --git a/NPM-README.md b/NPM-README.md deleted file mode 100644 index f4f2331..0000000 --- a/NPM-README.md +++ /dev/null @@ -1,95 +0,0 @@ -# OpenCodeReview CLI - -AI-powered code review tool that reads Git diffs, sends changed files to a configurable LLM via OpenAI-compatible API, and generates structured review comments. It goes beyond surface-level analysis — the Agent can read project context for deep reviews. - -## Install - -```bash -npm install -g @alibaba-group/open-code-review -``` - -After installation, the `ocr` command is available globally. - -### Version Control - -```bash -# Install specific version -OCR_VERSION=v1.0.0 npm install -g @alibaba-group/open-code-review -``` - -## Prerequisites - -**You must configure an LLM provider before using `ocr`.** The tool requires access to an OpenAI-compatible API endpoint (OpenAI, Claude, local models, etc.). - -```bash -ocr config set llm.url https://api.anthropic.com/v1/messages \ - && ocr config set llm.auth_token {{your-api-key}} \ - && ocr config set llm.model claude-opus-4-6 \ - && ocr config set llm.use_anthropic true \ - && ocr config set language Chinese -``` - -Config is stored in `~/.opencodereview/config.json`. - -Or via environment variables: - -```bash -export OCR_LLM_URL=https://api.anthropic.com/v1/messages -export OCR_LLM_TOKEN=your-api-key -export OCR_LLM_MODEL=claude-opus-4-6 -``` - -### Test Connectivity - -```bash -ocr llm test -``` - -## Quick Start - -Navigate to any Git repository and run: - -```bash -# Review all workspace changes -ocr review - -# Review diff between two branches -ocr review --from main --to feature-branch - -# Review a single commit -ocr review --commit abc123 -``` - -## Commands - -| Command | Description | -|---------|-------------| -| `ocr review` / `ocr r` | Start code review | -| `ocr config set ` | Manage configuration | -| `ocr llm test` | Test LLM connectivity | -| `ocr viewer` | Start WebUI session viewer | -| `ocr version` | Show version info | - -## Common Options - -| Flag | Shorthand | Default | Description | -|------|-----------|---------|-------------| -| `--repo` | | current dir | Git repository root | -| `--from` | | | Source ref (e.g., `main`) | -| `--to` | | | Target ref (e.g., `feature-branch`) | -| `--commit` | `-c` | | Review a single commit | -| `--format` | `-f` | `text` | Output format: `text` or `json` | -| `--concurrency` | | `4` | Max concurrent file reviews | -| `--timeout` | | `10` | Per-file timeout (minutes) | - -## Features - -- **Three review modes**: workspace changes, branch range, single commit -- **Context-aware**: Agent reads arbitrary files, searches code via `git grep`, inspects diffs -- **Plan phase**: Large changes (>50 lines) get risk analysis first -- **Any LLM**: Works with OpenAI, Claude-compatible endpoints, local models -- **Concurrent**: Files reviewed in parallel (configurable workers) - -## License - -Apache-2.0 diff --git a/package.json b/package.json index bf25657..5be4bb3 100644 --- a/package.json +++ b/package.json @@ -6,9 +6,7 @@ "ocr": "bin/ocr.js" }, "scripts": { - "postinstall": "node scripts/install.js", - "prepublishOnly": "cp NPM-README.md README.md", - "postpublish": "git checkout README.md" + "postinstall": "node scripts/install.js" }, "repository": { "type": "git",