Skip to content

Commit 8fb639a

Browse files
haasonsaasclaude
andcommitted
docs: update README with accurate codebase information
- Fix model support documentation to reflect current implementation - Remove premature Claude 4 model references - Clarify interactive commands are in development - Update configuration examples with actual supported options - Add comprehensive command reference section - Fix path configuration examples to match actual schema - Add plugin documentation for ESLint, Semgrep, and duplicate filter - Improve model format documentation for Ollama 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 94557a1 commit 8fb639a

1 file changed

Lines changed: 62 additions & 25 deletions

File tree

README.md

Lines changed: 62 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ A composable code review engine for automated diff analysis.
44

55
## Features
66

7-
- **Model Agnostic**: Works with OpenAI, Anthropic Claude 4, Ollama, and any OpenAI-compatible API
7+
- **Model Agnostic**: Works with OpenAI, Anthropic Claude, Ollama, and any OpenAI-compatible API
88
- **Git Integration**: Review uncommitted, staged, or branch changes directly
99
- **PR Reviews**: Analyze and comment on GitHub pull requests with interactive commands
1010
- **Smart Prompting**: Advanced prompt engineering with examples, XML structure, and chain-of-thought
@@ -129,18 +129,19 @@ git diff | diffscope review --model claude-3-5-sonnet-20241022
129129

130130
# Local Ollama
131131
git diff | diffscope review --model ollama:codellama
132+
133+
# Custom API endpoint
134+
export OPENAI_BASE_URL=https://api.custom.com/v1
135+
git diff | diffscope review --model custom-model
132136
```
133137

134138
### Supported Models
135139

136140
**OpenAI**: gpt-4o, gpt-4-turbo, gpt-3.5-turbo
137141

138-
**Anthropic**:
139-
- Claude 4: claude-opus-4-20250514, claude-sonnet-4-20250514
140-
- Claude 3.5: claude-3-5-sonnet-20241022, claude-3-5-haiku-20240307
141-
- Claude 3: claude-3-opus-20240229, claude-3-haiku-20240307
142+
**Anthropic**: claude-3-5-sonnet-20241022, claude-3-5-haiku-20240307, claude-3-opus-20240229, claude-3-haiku-20240307, and newer Claude models
142143

143-
**Ollama**: Any locally installed model (codellama, llama3.2, mistral, etc.)
144+
**Ollama**: Any locally installed model (codellama, llama3.2, mistral, etc.) - use `ollama:model-name` format
144145

145146
### Output Formats
146147
```bash
@@ -181,6 +182,18 @@ model: gpt-4o
181182
temperature: 0.2
182183
max_tokens: 4000
183184
system_prompt: "Focus on security vulnerabilities, performance issues, and best practices"
185+
186+
# Built-in plugins (enabled by default)
187+
plugins:
188+
eslint: true # JavaScript/TypeScript linting
189+
semgrep: true # Security-focused static analysis
190+
duplicate_filter: true # Remove duplicate comments
191+
192+
# Global exclusions
193+
exclude_patterns:
194+
- "**/*.generated.*"
195+
- "**/node_modules/**"
196+
- "**/__pycache__/**"
184197
```
185198

186199
## Plugin Development
@@ -390,18 +403,12 @@ system_prompt: |
390403
Prioritize by severity: Security > Performance > Maintainability
391404
392405
# File filters for monorepo
393-
include_patterns:
394-
- "src/**/*.py"
395-
- "tests/**/*.py"
396-
- "alembic/versions/*.py"
397-
- "*.yml"
398-
- "Dockerfile*"
399-
400406
exclude_patterns:
401407
- "**/__pycache__/**"
402408
- "**/venv/**"
403409
- "**/.pytest_cache/**"
404410
- "**/node_modules/**"
411+
- "**/*.generated.*"
405412

406413
# Review configuration
407414
max_diff_size: 10000
@@ -461,7 +468,34 @@ stage('AI Code Review') {
461468
5. **Output Parsing**: Handle both empty reviews and JSON parsing errors gracefully
462469
6. **Conditional Runs**: Skip reviews on draft PRs or specific file types
463470

464-
## New Features in v0.5.0
471+
## Available Commands
472+
473+
### Core Commands
474+
```bash
475+
# Review diffs
476+
diffscope review [--diff file.patch]
477+
478+
# Enhanced analysis with confidence scoring
479+
diffscope smart-review [--diff file.patch]
480+
481+
# Git integration
482+
diffscope git uncommitted # Review uncommitted changes
483+
diffscope git staged # Review staged changes
484+
diffscope git branch [base] # Compare against branch (default: main)
485+
diffscope git suggest # Generate commit messages
486+
diffscope git pr-title # Generate PR titles
487+
488+
# Pull request operations
489+
diffscope pr [--number N] [--post-comments] [--summary]
490+
491+
# File comparison
492+
diffscope compare --old-file old.py --new-file new.py
493+
494+
# Changelog generation
495+
diffscope changelog --from v0.4.0 [--to HEAD] [--release v0.5.0]
496+
```
497+
498+
## New Features in v0.5.3
465499

466500
### 🔄 Changelog Generation
467501

@@ -505,20 +539,21 @@ exclude_patterns:
505539
paths:
506540
# API endpoints need security focus
507541
"src/api/**":
508-
focus:
509-
- security
510-
- validation
511-
- authentication
512-
severity_overrides:
513-
security: error # All security issues become errors
542+
ignore_patterns:
543+
- "**/*.generated.*"
544+
extra_context:
545+
- "src/auth/**"
514546
system_prompt: |
515547
Focus on SQL injection, auth bypass, and input validation
548+
severity_overrides:
549+
security: error # All security issues become errors
516550

517-
# Test files have different standards
551+
# Test files have different standards
518552
"tests/**":
519-
focus:
520-
- coverage
521-
- assertions
553+
ignore_patterns:
554+
- "**/*.snap"
555+
extra_context:
556+
- "src/main/**"
522557
severity_overrides:
523558
style: suggestion # Style issues are just suggestions
524559

@@ -530,7 +565,9 @@ paths:
530565
531566
### 💬 Interactive PR Commands
532567
533-
Respond to pull request comments with interactive commands:
568+
*Note: Interactive commands are currently in development.*
569+
570+
Planned support for responding to pull request comments with interactive commands:
534571
535572
```
536573
@diffscope review # Re-review the changes

0 commit comments

Comments
 (0)