NPX ASYNCREVIEW FEATURE

Author: sng-asyncfunc

README.md

@@ -63,7 +63,16 @@ bun dev
 ```
 Open `http://localhost:3000` in your browser.
 
-## CLI Usage
+## Quick Start
+ 
+ No installation needed! Just use `npx`:
+ 
+ ```bash
+ # Review a GitHub PR
+ npx asyncreview review --url https://github.com/org/repo/pull/123 -q "Any security concerns?"
+ ```
+ 
+ ## CLI Usage
 
 You can also use the tool directly from the terminal:
 
@@ -72,26 +81,29 @@ You can also use the tool directly from the terminal:
 - **One-shot Review**: `cr review -q "What does this repo do?"`
 - **Help**: `cr --help`
 
-### `asyncreview` - GitHub PR/Issue Review (New!)
-
-Review GitHub PRs and Issues directly from the command line:
-
-```bash
-# Review a PR
-asyncreview review --url https://github.com/org/repo/pull/123 -q "Any security concerns?"
+### `npx asyncreview` - GitHub PR/Issue Review
+ 
+ Review GitHub PRs and Issues directly from the command line:
+ 
+ ```bash
+ # Review a PR
+ npx asyncreview review --url https://github.com/org/repo/pull/123 -q "Any security concerns?"
 
 # Review with markdown output (great for docs/skills)
-asyncreview review --url https://github.com/org/repo/pull/123 \
+# Review with markdown output (great for docs/skills)
+npx asyncreview review --url https://github.com/org/repo/pull/123 \
   -q "Summarize the changes" \
   --output markdown
 
 # Quiet mode for scripting (no progress bars)
-asyncreview review --url https://github.com/org/repo/pull/123 \
+# Quiet mode for scripting (no progress bars)
+npx asyncreview review --url https://github.com/org/repo/pull/123 \
   -q "What does this PR do?" \
   --quiet --output json
 
 # Use a specific model
-asyncreview review --url https://github.com/org/repo/pull/123 \
+# Use a specific model
+npx asyncreview review --url https://github.com/org/repo/pull/123 \
   -q "Deep code review" \
   --model gemini-3.0-pro-preview
 ```

npx/README.md

@@ -0,0 +1,67 @@
+# asyncreview
+
+AI-powered GitHub PR/Issue reviews from the command line using Recursive Language Models (RLM).
+
+## Quick Start
+
+```bash
+# Review a PR
+npx asyncreview review --url https://github.com/org/repo/pull/123 -q "Any security concerns?"
+
+# With JSON output for scripting
+npx asyncreview review --url https://github.com/org/repo/pull/123 -q "What does this PR do?" --quiet --output json
+```
+
+## Requirements
+
+- **Node.js 18+**
+- **Python 3.11+** (auto-detected)
+- **Gemini API Key** (prompted if not set)
+
+## API Key
+
+The Gemini API key can be provided in three ways (in order of priority):
+
+1. `--api <key>` flag
+2. `GEMINI_API_KEY` environment variable
+3. Interactive prompt (if neither above is set)
+
+```bash
+# Using --api flag
+npx asyncreview review --url <url> -q "Review this" --api YOUR_API_KEY
+
+# Using environment variable
+export GEMINI_API_KEY=your_key
+npx asyncreview review --url <url> -q "Review this"
+```
+
+## Options
+
+| Option | Description |
+|--------|-------------|
+| `-u, --url <url>` | GitHub PR or Issue URL (required) |
+| `-q, --question <question>` | Question to ask (required) |
+| `-o, --output <format>` | Output format: `text`, `markdown`, `json` (default: text) |
+| `--quiet` | Suppress progress output |
+| `-m, --model <model>` | Model to use (default: gemini-3-pro-preview) |
+| `--api <key>` | Gemini API key |
+
+## Examples
+
+```bash
+# Quick PR summary
+npx asyncreview review -u https://github.com/vercel/next.js/pull/1234 -q "Summarize the changes"
+
+# Security review
+npx asyncreview review -u https://github.com/org/repo/pull/123 -q "Any security vulnerabilities?"
+
+# Markdown output for docs
+npx asyncreview review -u https://github.com/org/repo/pull/123 -q "Document these changes" -o markdown
+
+# Scripting with JSON
+npx asyncreview review -u https://github.com/org/repo/pull/123 -q "Review" --quiet -o json | jq .answer
+```
+
+## License
+
+MIT