diffray 0.4.0 → 0.5.0

package/README.md

@@ -1,6 +1,6 @@
 <table>
   <tr>
-    <td><img src="logo.svg" alt="diffray" width="120"></td>
+    <td><img src="docs/logo.svg" alt="diffray" width="120"></td>
     <td>
       <h1>diffray</h1>
       <strong>Free open-source multi-agent code review</strong>
@@ -13,7 +13,7 @@
 > **How is it different from [diffray.ai](https://diffray.ai)?** The cloud platform automatically learns from your team's review feedback and generates rules. This CLI version requires manual rule configuration but gives you full control and runs locally.
 
 <p align="center">
-  <img src="/docs/diffray.png" alt="diffray in action" width="800">
+  <img src="docs/demo.gif" alt="diffray in action" width="800">
 </p>
 
 ---
@@ -48,10 +48,10 @@ npm install -g diffray
 cd your-project
 
 # Review your uncommitted changes (or last commit if working tree is clean)
-diffray
+diffray review
 
 # Or review changes between branches
-diffray --base main
+diffray review --base main
 ```
 
 That's it! diffray will analyze your changes and show any issues found.
@@ -60,25 +60,32 @@ That's it! diffray will analyze your changes and show any issues found.
 
 ```bash
 # Review uncommitted changes, or last commit if clean
-diffray
+diffray review
 
 # Review changes compared to main branch
-diffray --base main
+diffray review --base main
 
 # Review last 3 commits
-diffray --base HEAD~3
+diffray review --base HEAD~3
+
+# Review specific file(s) - only git changes in these files
+diffray review --files src/auth.ts
+diffray review --files src/auth.ts,src/user.ts
+
+# Review entire file content (without git diff)
+diffray review --files src/auth.ts --full
 
 # Show only critical and high severity issues
-diffray --severity critical,high
+diffray review --severity critical,high
 
 # Run only specific agent
-diffray --agent bug-hunter
+diffray review --agent bug-hunter
 
 # Output as JSON (for CI/CD pipelines)
-diffray --json
+diffray review --json
 
 # Show detailed progress
-diffray --stream
+diffray review --stream
 
 # List available agents and rules
 diffray agents
@@ -235,7 +242,26 @@ Supports any git URL:
 - `https://github.com/owner/repo#v1.0` — specific tag/branch
 - `git@github.com:owner/repo.git` — SSH format
 
-Then run `diffray extends install` to download. Agents/rules from extends have lower priority than local ones.
+**Extends commands:**
+
+```bash
+# Install extends from config
+diffray extends install
+
+# Install specific URL (auto-adds to config)
+diffray extends install https://github.com/owner/repo
+
+# Force re-clone all extends
+diffray extends install --force
+
+# List installed extends
+diffray extends list
+
+# Remove an extend
+diffray extends remove https://github.com/owner/repo
+```
+
+Agents/rules from extends have lower priority than local ones.
 
 ### Config commands
 
@@ -312,7 +338,7 @@ You should see `my-rules` in the list.
 **Step 4.** Run a review - your agent will now analyze your code!
 
 ```bash
-diffray
+diffray review
 ```
 
 ### Header fields explained
@@ -765,7 +791,7 @@ Your completely custom instructions here...
 diffray uses Claude AI which takes time to analyze code properly. Typical review takes 10-30 seconds. For faster (but less accurate) reviews, use:
 
 ```bash
-diffray --skip-validation
+diffray review --skip-validation
 ```
 
 ### Why didn't it find an obvious bug?
@@ -777,13 +803,18 @@ AI isn't perfect. diffray is tuned for **low false positives** (fewer wrong aler
 Yes! Use `--json` flag for machine-readable output:
 
 ```bash
-diffray --json --severity critical,high
+diffray review --json --severity critical,high
 ```
 
 Exit code is non-zero if issues are found.
 
 **GitHub Actions example:**
 
+> **⚠️ Security Warning:**
+> - Never commit `ANTHROPIC_API_KEY` or `CLAUDE_CODE_OAUTH_TOKEN` to git
+> - Always use GitHub Secrets for API keys in CI/CD
+> - For local development: use `claude setup-token` to generate `CLAUDE_CODE_OAUTH_TOKEN`
+
 ```yaml
 name: Code Review
 on: [pull_request]
@@ -802,9 +833,15 @@ jobs:
 
       - run: npm install -g diffray @anthropic-ai/claude-code
 
-      - run: claude auth login --api-key ${{ secrets.ANTHROPIC_API_KEY }}
+      # Option 1: Use ANTHROPIC_API_KEY (recommended for CI/CD)
+      - run: diffray review --base origin/${{ github.base_ref }} --json --severity critical,high
+        env:
+          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
 
-      - run: diffray --base origin/${{ github.base_ref }} --json --severity critical,high
+      # Option 2: Use CLAUDE_CODE_OAUTH_TOKEN (get via: claude setup-token)
+      # - run: diffray review --base origin/${{ github.base_ref }} --json --severity critical,high
+      #   env:
+      #     CLAUDE_CODE_OAUTH_TOKEN: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
 ```
 
 ### How much does it cost?