# Quick Start - OpenClaw Venture Capitalist

**Get started with AI-powered investment analysis in 5 minutes**

---

## 📦 Installation

```bash
# Clone the repository
git clone https://github.com/ZhenRobotics/openclaw-venture-capitalist.git
cd openclaw-venture-capitalist

# Install dependencies
npm install

# Build the project
npm run build
```

---

## 🚀 Your First Analysis

### Step 1: Prepare a pitch deck

Place a pitch deck file (PDF, PPTX, or DOCX) in your project directory. For testing, you can use any business plan or pitch deck.

Example: `acme-startup.pdf`

### Step 2: Run analysis

```bash
npm start analyze acme-startup.pdf
```

You'll see a comprehensive analysis including:
- Executive Summary
- Overall Score (0-10)
- Investment Recommendation (STRONG BUY / BUY / HOLD / PASS)
- Detailed scores across 10 dimensions
- Key highlights and concerns
- Next steps

### Step 3: Generate a full report

```bash
npm start report acme-startup.pdf --output ./reports/acme-analysis.md
```

This creates a detailed markdown report saved to `./reports/acme-analysis.md`.

---

## 📊 Common Commands

### Analyze a Pitch Deck

```bash
npm start analyze pitch-deck.pdf
```

**Output**: Terminal display with key insights and scores

### Generate PDF Report

```bash
npm start report pitch-deck.pdf --format pdf --output report.pdf
```

**Output**: Comprehensive investment memo in PDF format

### Extract Specific Data

```bash
# Get market size
npm start extract pitch-deck.pdf market-size

# Get team information
npm start extract pitch-deck.pdf team

# Get financial data
npm start extract pitch-deck.pdf financials

# Get traction metrics
npm start extract pitch-deck.pdf traction
```

### Compare Multiple Deals

```bash
npm start compare deal1.pdf deal2.pdf deal3.pdf --output comparison.md
```

**Output**: Side-by-side comparison table with scores

---

## ⚙️ Configuration (Optional)

Create `.vcconfig.json` in your project root to customize analysis:

```json
{
  "scoring": {
    "enabled": true,
    "weights": {
      "market": 0.25,
      "team": 0.30,
      "product": 0.15,
      "traction": 0.15,
      "financials": 0.10,
      "businessModel": 0.05,
      "competition": 0.05,
      "risks": -0.05
    },
    "thresholds": {
      "strong_buy": 8.0,
      "buy": 6.5,
      "hold": 5.0
    }
  },
  "output_directory": "./reports",
  "save_history": true
}
```

### Customizing Scoring Weights

Adjust the weights to match your investment criteria:

- **`market`**: Market opportunity size and growth (default: 25%)
- **`team`**: Founder and team quality (default: 30%)
- **`product`**: Product differentiation and PMF (default: 15%)
- **`traction`**: Current metrics and growth (default: 15%)
- **`financials`**: Financial health and projections (default: 10%)
- **`businessModel`**: Revenue model and unit economics (default: 5%)
- **`competition`**: Competitive positioning (default: 5%)
- **`risks`**: Risk assessment (default: -5%)

### Customizing Thresholds

Set your own decision thresholds:

```json
{
  "thresholds": {
    "strong_buy": 8.5,  // Score >= 8.5 → STRONG BUY
    "buy": 7.0,         // Score >= 7.0 → BUY
    "hold": 5.5         // Score >= 5.5 → HOLD, else PASS
  }
}
```

---

## 🎯 Example Workflow

### Scenario: Screening 3 Startups

You're evaluating 3 startup opportunities and need to prepare for your next partner meeting.

#### Step 1: Analyze all three

```bash
npm start analyze startup-a.pdf
npm start analyze startup-b.pdf
npm start analyze startup-c.pdf
```

#### Step 2: Generate comparison

```bash
npm start compare startup-a.pdf startup-b.pdf startup-c.pdf --output pipeline-comparison.md
```

#### Step 3: Deep dive on top candidate

```bash
npm start report startup-a.pdf --format pdf --output memos/startup-a-full-analysis.pdf
```

#### Step 4: Extract key metrics for discussion

```bash
npm start extract startup-a.pdf market-size > market-data.txt
npm start extract startup-a.pdf team > team-info.txt
npm start extract startup-a.pdf traction > traction-metrics.txt
```

---

## 📈 Understanding the Output

### Overall Score

The overall score (0-10) is a weighted average across 8 dimensions:

- **8.0-10.0**: STRONG BUY - Exceptional opportunity
- **6.5-7.9**: BUY - Good investment opportunity
- **5.0-6.4**: HOLD - Needs more work or validation
- **0-4.9**: PASS - Not recommended at this time

### Individual Scores

Each dimension is scored 0-10:

- **9-10**: Exceptional
- **7-8**: Strong
- **5-6**: Average/Acceptable
- **3-4**: Below average
- **0-2**: Weak/Concerning

### Recommendation Levels

- **STRONG BUY**: High conviction, recommend investment
- **BUY**: Positive, recommend with standard diligence
- **HOLD**: Interesting but needs more validation
- **PASS**: Not recommended

---

## 🔧 Troubleshooting

### Issue: "File not found"

Make sure the file path is correct:

```bash
# Use absolute path
npm start analyze /full/path/to/pitch-deck.pdf

# Or relative path from project root
npm start analyze ./pitch-decks/startup-a.pdf
```

### Issue: "Cannot read PDF"

The tool currently supports text-based PDFs. For image-based PDFs, you may need to convert them to text first using OCR.

### Issue: "Low scores across the board"

The analyzer works best with comprehensive pitch decks that include:
- Market size data (TAM/SAM)
- Team backgrounds
- Traction metrics (users, revenue)
- Financial projections
- Competitive landscape

If your pitch deck is minimal, scores may be lower.

---

## 📚 Next Steps

1. ✅ Run your first analysis
2. 📖 Read the full [README.md](README.md) for detailed features
3. 🎨 Customize `.vcconfig.json` for your investment criteria
4. 📊 Start building your deal pipeline analysis
5. 🚀 Integrate into your investment workflow

---

## 💡 Tips

- **Use consistent filenames**: e.g., `companyname-pitch-deck.pdf`
- **Save all analyses**: Enable `save_history` in config to track decisions over time
- **Compare regularly**: Use the compare command before partner meetings
- **Extract for quick reviews**: Use extract commands for rapid screening
- **Customize weights**: Adjust scoring weights based on your fund's thesis

---

## 🆘 Need Help?

- 📖 Full documentation: [README.md](README.md)
- 🐛 Report issues: [GitHub Issues](https://github.com/ZhenRobotics/openclaw-venture-capitalist/issues)
- 💬 Discussions: [GitHub Discussions](https://github.com/ZhenRobotics/openclaw-venture-capitalist/discussions)

---

**Happy investing! 🚀📊**