From 4080794eb7fc4c999496079ba5cb5a3683ed09de Mon Sep 17 00:00:00 2001 From: yusyus Date: Mon, 10 Nov 2025 21:38:11 +0300 Subject: [PATCH] docs: Update all remaining old command patterns to unified CLI MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- BULLETPROOF_QUICKSTART.md | 22 ++++---- QUICKSTART.md | 52 +++++++++--------- README.md | 108 +++++++++++++++++++------------------- TROUBLESHOOTING.md | 10 ++-- 4 files changed, 96 insertions(+), 96 deletions(-) diff --git a/BULLETPROOF_QUICKSTART.md b/BULLETPROOF_QUICKSTART.md index 6d4a0e5..bc58668 100644 --- a/BULLETPROOF_QUICKSTART.md +++ b/BULLETPROOF_QUICKSTART.md @@ -236,7 +236,7 @@ Let's make sure everything works: ```bash # Test the main script can run -python3 cli/doc_scraper.py --help +skill-seekers scrape --help ``` **✅ Success looks like:** @@ -276,7 +276,7 @@ cat > configs/test.json << 'EOF' EOF # Run the scraper -python3 cli/doc_scraper.py --config configs/test.json +skill-seekers scrape --config configs/test.json ``` **What happens:** @@ -299,7 +299,7 @@ Page 2/5: Editor Setup ```bash # Use the React preset -python3 cli/doc_scraper.py --config configs/react.json --max-pages 50 +skill-seekers scrape --config configs/react.json --max-pages 50 ``` **⏱️ Time:** ~5 minutes @@ -325,7 +325,7 @@ head output/test-skill/SKILL.md ```bash # Package the skill -python3 cli/package_skill.py output/test-skill/ +skill-seekers package output/test-skill/ ``` **✅ Success looks like:** @@ -363,20 +363,20 @@ You now have a working Skill Seeker installation! Here's what you can do: ls configs/ # Try Vue.js -python3 cli/doc_scraper.py --config configs/vue.json --max-pages 50 +skill-seekers scrape --config configs/vue.json --max-pages 50 # Try Django -python3 cli/doc_scraper.py --config configs/django.json --max-pages 50 +skill-seekers scrape --config configs/django.json --max-pages 50 ``` ### Create Custom Skills ```bash # Interactive mode - answer questions -python3 cli/doc_scraper.py --interactive +skill-seekers scrape --interactive # Or create config for any website -python3 cli/doc_scraper.py \ +skill-seekers scrape \ --name myframework \ --url https://docs.myframework.com/ \ --description "My favorite framework" @@ -457,7 +457,7 @@ pip3 install --user requests beautifulsoup4 **Solution:** ```bash # Use smaller max_pages for testing -python3 cli/doc_scraper.py --config configs/react.json --max-pages 10 +skill-seekers scrape --config configs/react.json --max-pages 10 # Check internet connection ping google.com @@ -493,10 +493,10 @@ curl -I https://docs.yoursite.com # Your typical workflow: # 1. Create/use a config -python3 cli/doc_scraper.py --config configs/react.json --max-pages 50 +skill-seekers scrape --config configs/react.json --max-pages 50 # 2. Package it -python3 cli/package_skill.py output/react/ +skill-seekers package output/react/ # 3. Upload output/react.zip to Claude diff --git a/QUICKSTART.md b/QUICKSTART.md index 5e7d0ca..51f3793 100644 --- a/QUICKSTART.md +++ b/QUICKSTART.md @@ -14,23 +14,23 @@ pip3 install requests beautifulsoup4 **Option A: Use a Preset (Easiest)** ```bash -python3 cli/doc_scraper.py --config configs/godot.json +skill-seekers scrape --config configs/godot.json ``` **Option B: Interactive Mode** ```bash -python3 cli/doc_scraper.py --interactive +skill-seekers scrape --interactive ``` **Option C: Quick Command** ```bash -python3 cli/doc_scraper.py --name react --url https://react.dev/ +skill-seekers scrape --name react --url https://react.dev/ ``` **Option D: Unified Multi-Source (NEW - v2.0.0)** ```bash # Combine documentation + GitHub code in one skill -python3 cli/unified_scraper.py --config configs/react_unified.json +skill-seekers unified --config configs/react_unified.json ``` *Detects conflicts between docs and code automatically!* @@ -38,7 +38,7 @@ python3 cli/unified_scraper.py --config configs/react_unified.json ```bash # LOCAL enhancement (no API key, uses Claude Code Max) -python3 cli/enhance_skill_local.py output/godot/ +skill-seekers enhance output/godot/ ``` **This takes 60 seconds and dramatically improves the SKILL.md quality!** @@ -46,7 +46,7 @@ python3 cli/enhance_skill_local.py output/godot/ ### Step 4: Package the Skill ```bash -python3 cli/package_skill.py output/godot/ +skill-seekers package output/godot/ ``` **Done!** You now have `godot.zip` ready to use. @@ -57,25 +57,25 @@ python3 cli/package_skill.py output/godot/ ```bash # Godot Engine -python3 cli/doc_scraper.py --config configs/godot.json +skill-seekers scrape --config configs/godot.json # React -python3 cli/doc_scraper.py --config configs/react.json +skill-seekers scrape --config configs/react.json # Vue.js -python3 cli/doc_scraper.py --config configs/vue.json +skill-seekers scrape --config configs/vue.json # Django -python3 cli/doc_scraper.py --config configs/django.json +skill-seekers scrape --config configs/django.json # FastAPI -python3 cli/doc_scraper.py --config configs/fastapi.json +skill-seekers scrape --config configs/fastapi.json # Unified Multi-Source (NEW!) -python3 cli/unified_scraper.py --config configs/react_unified.json -python3 cli/unified_scraper.py --config configs/django_unified.json -python3 cli/unified_scraper.py --config configs/fastapi_unified.json -python3 cli/unified_scraper.py --config configs/godot_unified.json +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 ``` --- @@ -85,7 +85,7 @@ python3 cli/unified_scraper.py --config configs/godot_unified.json If you already scraped once: ```bash -python3 cli/doc_scraper.py --config configs/godot.json +skill-seekers scrape --config configs/godot.json # When prompted: ✓ Found existing data: 245 pages @@ -96,7 +96,7 @@ Use existing data? (y/n): y Or use `--skip-scrape`: ```bash -python3 cli/doc_scraper.py --config configs/godot.json --skip-scrape +skill-seekers scrape --config configs/godot.json --skip-scrape ``` --- @@ -108,11 +108,11 @@ python3 cli/doc_scraper.py --config configs/godot.json --skip-scrape pip3 install requests beautifulsoup4 # 2. Scrape React docs with LOCAL enhancement -python3 cli/doc_scraper.py --config configs/react.json --enhance-local +skill-seekers scrape --config configs/react.json --enhance-local # Wait 15-30 minutes (scraping) + 60 seconds (enhancement) # 3. Package -python3 cli/package_skill.py output/react/ +skill-seekers package output/react/ # 4. Use react.zip in Claude! ``` @@ -120,13 +120,13 @@ python3 cli/package_skill.py output/react/ **Alternative: Enhancement after scraping** ```bash # 2a. Scrape only (no enhancement) -python3 cli/doc_scraper.py --config configs/react.json +skill-seekers scrape --config configs/react.json # 2b. Enhance later -python3 cli/enhance_skill_local.py output/react/ +skill-seekers enhance output/react/ # 3. Package -python3 cli/package_skill.py output/react/ +skill-seekers package output/react/ ``` --- @@ -144,7 +144,7 @@ Edit config file: ### Rebuild Instantly ```bash # After first scrape, you can rebuild instantly: -python3 cli/doc_scraper.py --config configs/react.json --skip-scrape +skill-seekers scrape --config configs/react.json --skip-scrape ``` ### Create Custom Config @@ -156,7 +156,7 @@ cp configs/react.json configs/myframework.json nano configs/myframework.json # Use it -python3 cli/doc_scraper.py --config configs/myframework.json +skill-seekers scrape --config configs/myframework.json ``` --- @@ -187,10 +187,10 @@ See **README.md** for: ```bash # Godot -python3 cli/doc_scraper.py --config configs/godot.json +skill-seekers scrape --config configs/godot.json # Or interactive -python3 cli/doc_scraper.py --interactive +skill-seekers scrape --interactive ``` That's it! 🚀 diff --git a/README.md b/README.md index a83f86e..b14d081 100644 --- a/README.md +++ b/README.md @@ -410,13 +410,13 @@ source venv/bin/activate # Run this each time you start a new terminal session source venv/bin/activate # Optional: Estimate pages first (fast, 1-2 minutes) -python3 cli/estimate_pages.py configs/godot.json +skill-seekers estimate configs/godot.json # Use Godot preset -python3 cli/doc_scraper.py --config configs/godot.json +skill-seekers scrape --config configs/godot.json # Use React preset -python3 cli/doc_scraper.py --config configs/react.json +skill-seekers scrape --config configs/react.json # See all presets ls configs/ @@ -425,13 +425,13 @@ ls configs/ ### Interactive Mode ```bash -python3 cli/doc_scraper.py --interactive +skill-seekers scrape --interactive ``` ### Quick Mode ```bash -python3 cli/doc_scraper.py \ +skill-seekers scrape \ --name react \ --url https://react.dev/ \ --description "React framework for UIs" @@ -448,10 +448,10 @@ Once your skill is packaged, you need to upload it to Claude: export ANTHROPIC_API_KEY=sk-ant-... # Package and upload automatically -python3 cli/package_skill.py output/react/ --upload +skill-seekers package output/react/ --upload # OR upload existing .zip -python3 cli/upload_skill.py output/react.zip +skill-seekers upload output/react.zip ``` **Benefits:** @@ -466,7 +466,7 @@ python3 cli/upload_skill.py output/react.zip ```bash # Package skill -python3 cli/package_skill.py output/react/ +skill-seekers package output/react/ # This will: # 1. Create output/react.zip @@ -538,7 +538,7 @@ doc-to-skill/ ### 1. Fast Page Estimation (NEW!) ```bash -python3 cli/estimate_pages.py configs/react.json +skill-seekers estimate configs/react.json # Output: 📊 ESTIMATION RESULTS @@ -558,7 +558,7 @@ python3 cli/estimate_pages.py configs/react.json ### 2. Auto-Detect Existing Data ```bash -python3 cli/doc_scraper.py --config configs/godot.json +skill-seekers scrape --config configs/godot.json # If data exists: ✓ Found existing data: 245 pages @@ -603,23 +603,23 @@ Automatically infers categories from: ```bash # Scrape once -python3 cli/doc_scraper.py --config configs/react.json +skill-seekers scrape --config configs/react.json # Later, just rebuild (instant) -python3 cli/doc_scraper.py --config configs/react.json --skip-scrape +skill-seekers scrape --config configs/react.json --skip-scrape ``` ### 6. Async Mode for Faster Scraping (2-3x Speed!) ```bash # Enable async mode with 8 workers (recommended for large docs) -python3 cli/doc_scraper.py --config configs/react.json --async --workers 8 +skill-seekers scrape --config configs/react.json --async --workers 8 # Small docs (~100-500 pages) -python3 cli/doc_scraper.py --config configs/mydocs.json --async --workers 4 +skill-seekers scrape --config configs/mydocs.json --async --workers 4 # Large docs (2000+ pages) with no rate limiting -python3 cli/doc_scraper.py --config configs/largedocs.json --async --workers 8 --no-rate-limit +skill-seekers scrape --config configs/largedocs.json --async --workers 8 --no-rate-limit ``` **Performance Comparison:** @@ -641,16 +641,16 @@ python3 cli/doc_scraper.py --config configs/largedocs.json --async --workers 8 - # Option 1: During scraping (API-based, requires API key) pip3 install anthropic export ANTHROPIC_API_KEY=sk-ant-... -python3 cli/doc_scraper.py --config configs/react.json --enhance +skill-seekers scrape --config configs/react.json --enhance # Option 2: During scraping (LOCAL, no API key - uses Claude Code Max) -python3 cli/doc_scraper.py --config configs/react.json --enhance-local +skill-seekers scrape --config configs/react.json --enhance-local # Option 3: After scraping (API-based, standalone) -python3 cli/enhance_skill.py output/react/ +skill-seekers enhance output/react/ # Option 4: After scraping (LOCAL, no API key, standalone) -python3 cli/enhance_skill_local.py output/react/ +skill-seekers enhance output/react/ ``` **What it does:** @@ -676,10 +676,10 @@ python3 cli/enhance_skill_local.py output/react/ ```bash # 1. Estimate first (discover page count) -python3 cli/estimate_pages.py configs/godot.json +skill-seekers estimate configs/godot.json # 2. Auto-split into focused sub-skills -python3 cli/split_config.py configs/godot.json --strategy router +python3 -m skill_seekers.cli.split_config configs/godot.json --strategy router # Creates: # - godot-scripting.json (5K pages) @@ -690,15 +690,15 @@ python3 cli/split_config.py configs/godot.json --strategy router # 3. Scrape all in parallel (4-8 hours instead of 20-40!) for config in configs/godot-*.json; do - python3 cli/doc_scraper.py --config $config & + skill-seekers scrape --config $config & done wait # 4. Generate intelligent router/hub skill -python3 cli/generate_router.py configs/godot-*.json +python3 -m skill_seekers.cli.generate_router configs/godot-*.json # 5. Package all skills -python3 cli/package_multi.py output/godot*/ +python3 -m skill_seekers.cli.package_multi output/godot*/ # 6. Upload all .zip files to Claude # Users just ask questions naturally! @@ -748,7 +748,7 @@ python3 cli/package_multi.py output/godot*/ } # If scrape is interrupted (Ctrl+C or crash) -python3 cli/doc_scraper.py --config configs/godot.json --resume +skill-seekers scrape --config configs/godot.json --resume # Resume from last checkpoint ✅ Resuming from checkpoint (12,450 pages scraped) @@ -756,7 +756,7 @@ python3 cli/doc_scraper.py --config configs/godot.json --resume 🔄 Continuing from where we left off... # Start fresh (clear checkpoint) -python3 cli/doc_scraper.py --config configs/godot.json --fresh +skill-seekers scrape --config configs/godot.json --fresh ``` **Benefits:** @@ -771,14 +771,14 @@ python3 cli/doc_scraper.py --config configs/godot.json --fresh ```bash # 1. Scrape + Build + AI Enhancement (LOCAL, no API key) -python3 cli/doc_scraper.py --config configs/godot.json --enhance-local +skill-seekers scrape --config configs/godot.json --enhance-local # 2. Wait for new terminal to close (enhancement completes) # Check the enhanced SKILL.md: cat output/godot/SKILL.md # 3. Package -python3 cli/package_skill.py output/godot/ +skill-seekers package output/godot/ # 4. Done! You have godot.zip with excellent SKILL.md ``` @@ -789,11 +789,11 @@ python3 cli/package_skill.py output/godot/ ```bash # 1. Use cached data + Local Enhancement -python3 cli/doc_scraper.py --config configs/godot.json --skip-scrape -python3 cli/enhance_skill_local.py output/godot/ +skill-seekers scrape --config configs/godot.json --skip-scrape +skill-seekers enhance output/godot/ # 2. Package -python3 cli/package_skill.py output/godot/ +skill-seekers package output/godot/ # 3. Done! ``` @@ -804,10 +804,10 @@ python3 cli/package_skill.py output/godot/ ```bash # 1. Scrape + Build (no enhancement) -python3 cli/doc_scraper.py --config configs/godot.json +skill-seekers scrape --config configs/godot.json # 2. Package -python3 cli/package_skill.py output/godot/ +skill-seekers package output/godot/ # 3. Done! (SKILL.md will be basic template) ``` @@ -830,22 +830,22 @@ python3 cli/package_skill.py output/godot/ ```bash # Godot -python3 cli/doc_scraper.py --config configs/godot.json +skill-seekers scrape --config configs/godot.json # React -python3 cli/doc_scraper.py --config configs/react.json +skill-seekers scrape --config configs/react.json # Vue -python3 cli/doc_scraper.py --config configs/vue.json +skill-seekers scrape --config configs/vue.json # Django -python3 cli/doc_scraper.py --config configs/django.json +skill-seekers scrape --config configs/django.json # FastAPI -python3 cli/doc_scraper.py --config configs/fastapi.json +skill-seekers scrape --config configs/fastapi.json # Ansible -python3 cli/doc_scraper.py --config configs/ansible-core.json +skill-seekers scrape --config configs/ansible-core.json ``` ## 🎨 Creating Your Own Config @@ -853,7 +853,7 @@ python3 cli/doc_scraper.py --config configs/ansible-core.json ### Option 1: Interactive ```bash -python3 cli/doc_scraper.py --interactive +skill-seekers scrape --interactive # Follow prompts, it will create the config for you ``` @@ -867,7 +867,7 @@ cp configs/react.json configs/myframework.json nano configs/myframework.json # Use it -python3 cli/doc_scraper.py --config configs/myframework.json +skill-seekers scrape --config configs/myframework.json ``` ### Config Structure @@ -918,19 +918,19 @@ output/ ```bash # Interactive mode -python3 cli/doc_scraper.py --interactive +skill-seekers scrape --interactive # Use config file -python3 cli/doc_scraper.py --config configs/godot.json +skill-seekers scrape --config configs/godot.json # Quick mode -python3 cli/doc_scraper.py --name react --url https://react.dev/ +skill-seekers scrape --name react --url https://react.dev/ # Skip scraping (use existing data) -python3 cli/doc_scraper.py --config configs/godot.json --skip-scrape +skill-seekers scrape --config configs/godot.json --skip-scrape # With description -python3 cli/doc_scraper.py \ +skill-seekers scrape \ --name react \ --url https://react.dev/ \ --description "React framework for building UIs" @@ -951,11 +951,11 @@ Edit `max_pages` in config to test: ```bash # Scrape once -python3 cli/doc_scraper.py --config configs/react.json +skill-seekers scrape --config configs/react.json # Rebuild multiple times (instant) -python3 cli/doc_scraper.py --config configs/react.json --skip-scrape -python3 cli/doc_scraper.py --config configs/react.json --skip-scrape +skill-seekers scrape --config configs/react.json --skip-scrape +skill-seekers scrape --config configs/react.json --skip-scrape ``` ### 3. Finding Selectors @@ -992,7 +992,7 @@ cat output/godot/references/index.md # Categories ```bash # Force re-scrape rm -rf output/myframework_data/ -python3 cli/doc_scraper.py --config configs/myframework.json +skill-seekers scrape --config configs/myframework.json ``` ### Categories Not Good? @@ -1004,7 +1004,7 @@ Edit the config `categories` section with better keywords. rm -rf output/godot_data/ # Re-scrape -python3 cli/doc_scraper.py --config configs/godot.json +skill-seekers scrape --config configs/godot.json ``` ## 📈 Performance @@ -1061,13 +1061,13 @@ python3 cli/doc_scraper.py --config configs/godot.json ```bash # Try Godot -python3 cli/doc_scraper.py --config configs/godot.json +skill-seekers scrape --config configs/godot.json # Try React -python3 cli/doc_scraper.py --config configs/react.json +skill-seekers scrape --config configs/react.json # Or go interactive -python3 cli/doc_scraper.py --interactive +skill-seekers scrape --interactive ``` ## 📝 License diff --git a/TROUBLESHOOTING.md b/TROUBLESHOOTING.md index 93dcaa0..75b7ae9 100644 --- a/TROUBLESHOOTING.md +++ b/TROUBLESHOOTING.md @@ -123,12 +123,12 @@ FileNotFoundError: configs/react.json 2. **Use full path:** ```bash - python3 cli/doc_scraper.py --config $(pwd)/configs/react.json + skill-seekers scrape --config $(pwd)/configs/react.json ``` 3. **Create missing config:** ```bash - python3 cli/doc_scraper.py --interactive + skill-seekers scrape --interactive ``` --- @@ -223,7 +223,7 @@ nano ~/.config/claude-code/mcp.json 3. **Test CLI tools directly:** ```bash - python3 cli/doc_scraper.py --help + skill-seekers scrape --help ``` --- @@ -242,7 +242,7 @@ nano ~/.config/claude-code/mcp.json 2. **Use smaller max_pages for testing:** ```bash - python3 cli/doc_scraper.py --config configs/test.json --max-pages 5 + skill-seekers scrape --config configs/test.json --max-pages 5 ``` 3. **Increase rate_limit in config:** @@ -386,7 +386,7 @@ ls configs/ cat ~/.config/claude-code/mcp.json # 5. Test scraper -python3 cli/doc_scraper.py --help +skill-seekers scrape --help # 6. Test MCP server timeout 3 python3 mcp/server.py || echo "Server OK"