Updated 96 command examples across all documentation files: - README.md: 54 updates - QUICKSTART.md: 26 updates - BULLETPROOF_QUICKSTART.md: 11 updates - TROUBLESHOOTING.md: 5 updates Changes: - python3 cli/doc_scraper.py → skill-seekers scrape - python3 cli/github_scraper.py → skill-seekers github - python3 cli/pdf_scraper.py → skill-seekers pdf - python3 cli/unified_scraper.py → skill-seekers unified - python3 cli/enhance_skill*.py → skill-seekers enhance - python3 cli/package_skill.py → skill-seekers package - python3 cli/upload_skill.py → skill-seekers upload - python3 cli/estimate_pages.py → skill-seekers estimate Advanced tools (no entry points yet): - python3 cli/split_config.py → python3 -m skill_seekers.cli.split_config - python3 cli/generate_router.py → python3 -m skill_seekers.cli.generate_router - python3 cli/package_multi.py → python3 -m skill_seekers.cli.package_multi Result: ✅ 0 old patterns remaining in all documentation 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
3.7 KiB
3.7 KiB
Quick Start Guide
🚀 3 Steps to Create a Skill
Step 1: Install Dependencies
pip3 install requests beautifulsoup4
Note: Skill_Seekers automatically checks for llms.txt files first, which is 10x faster when available.
Step 2: Run the Tool
Option A: Use a Preset (Easiest)
skill-seekers scrape --config configs/godot.json
Option B: Interactive Mode
skill-seekers scrape --interactive
Option C: Quick Command
skill-seekers scrape --name react --url https://react.dev/
Option D: Unified Multi-Source (NEW - v2.0.0)
# Combine documentation + GitHub code in one skill
skill-seekers unified --config configs/react_unified.json
Detects conflicts between docs and code automatically!
Step 3: Enhance SKILL.md (Recommended)
# LOCAL enhancement (no API key, uses Claude Code Max)
skill-seekers enhance output/godot/
This takes 60 seconds and dramatically improves the SKILL.md quality!
Step 4: Package the Skill
skill-seekers package output/godot/
Done! You now have godot.zip ready to use.
📋 Available Presets
# Godot Engine
skill-seekers scrape --config configs/godot.json
# React
skill-seekers scrape --config configs/react.json
# Vue.js
skill-seekers scrape --config configs/vue.json
# Django
skill-seekers scrape --config configs/django.json
# FastAPI
skill-seekers scrape --config configs/fastapi.json
# Unified Multi-Source (NEW!)
skill-seekers unified --config configs/react_unified.json
skill-seekers unified --config configs/django_unified.json
skill-seekers unified --config configs/fastapi_unified.json
skill-seekers unified --config configs/godot_unified.json
⚡ Using Existing Data (Fast!)
If you already scraped once:
skill-seekers scrape --config configs/godot.json
# When prompted:
✓ Found existing data: 245 pages
Use existing data? (y/n): y
# Builds in seconds!
Or use --skip-scrape:
skill-seekers scrape --config configs/godot.json --skip-scrape
🎯 Complete Example (Recommended Workflow)
# 1. Install (once)
pip3 install requests beautifulsoup4
# 2. Scrape React docs with LOCAL enhancement
skill-seekers scrape --config configs/react.json --enhance-local
# Wait 15-30 minutes (scraping) + 60 seconds (enhancement)
# 3. Package
skill-seekers package output/react/
# 4. Use react.zip in Claude!
Alternative: Enhancement after scraping
# 2a. Scrape only (no enhancement)
skill-seekers scrape --config configs/react.json
# 2b. Enhance later
skill-seekers enhance output/react/
# 3. Package
skill-seekers package output/react/
💡 Pro Tips
Test with Small Pages First
Edit config file:
{
"max_pages": 20 // Test with just 20 pages
}
Rebuild Instantly
# After first scrape, you can rebuild instantly:
skill-seekers scrape --config configs/react.json --skip-scrape
Create Custom Config
# Copy a preset
cp configs/react.json configs/myframework.json
# Edit it
nano configs/myframework.json
# Use it
skill-seekers scrape --config configs/myframework.json
📁 What You Get
output/
├── godot_data/ # Raw scraped data (reusable!)
└── godot/ # The skill
├── SKILL.md # With real code examples!
└── references/ # Organized docs
❓ Need Help?
See README.md for:
- Complete documentation
- Config file structure
- Troubleshooting
- Advanced usage
🎮 Let's Go!
# Godot
skill-seekers scrape --config configs/godot.json
# Or interactive
skill-seekers scrape --interactive
That's it! 🚀