### Setup Example - Python Source: https://skillseekersweb.com/docs/manual/codebase-analysis/test-extraction Extracts initialization sequences from setUp() methods or pytest fixtures. This example demonstrates initializing an API client and connecting. ```python # Example from setUp self.client = APIClient(api_key="test-key") self.client.connect() ``` -------------------------------- ### Build How-To Guides from Examples Source: https://skillseekersweb.com/docs/manual/codebase-analysis/how-to-guides Generate markdown guides from extracted workflow examples. You can specify different grouping strategies to organize the tutorials. ```bash # Build guides from extracted examples skill-seekers-how-to-guides \ output/codebase/test_examples/test_examples.json \ --output output/codebase/tutorials/ ``` ```bash # Choose grouping strategy skill-seekers-how-to-guides examples.json \ --group-by ai-tutorial-group # AI-based (default) --group-by file-path # Group by test file --group-by test-name # Group by test name patterns --group-by complexity # Group by difficulty level ``` -------------------------------- ### Sample Output of MCP Setup Script Source: https://skillseekersweb.com/docs/manual/mcp/setup Example output demonstrating the detection and configuration process for AI agents during the MCP setup. ```text πŸ” Detecting installed AI agents... Found the following agents: βœ“ Claude Code (stdio) βœ“ Cursor (HTTP) βœ“ VS Code + Cline (stdio) Would you like to configure all agents? (Y/n): Y βœ… Configured Claude Code βœ… Configured Cursor βœ… Configured VS Code + Cline πŸš€ Starting HTTP server for Cursor... All agents configured successfully! ``` -------------------------------- ### Extract Test Examples and Build How-to Guides Source: https://skillseekersweb.com/docs/manual/codebase-analysis/how-to-guides Use this command to extract test examples from your codebase and build how-to guides. This is a prerequisite for generating guides. ```bash # Full pipeline skill-seekers-codebase tests/ \ --extract-test-examples \ --build-how-to-guides ``` -------------------------------- ### Adding Routing Examples Example Source: https://skillseekersweb.com/docs/reference/skill-architecture Shows how to add specific usage examples to the router documentation to guide its routing behavior. ```markdown ## Usage Examples "Load data into database" β†’ data_loading "Clean CSV file" β†’ data_transformation ``` -------------------------------- ### Run Interactive Setup Wizard Source: https://skillseekersweb.com/docs/community/changelog Access the interactive setup wizard for SkillSeekers to configure installation options. This wizard is shown on first run and stored at ~/.config/skill-seekers/.setup_shown. ```bash skill-seekers-setup ``` -------------------------------- ### Extract Examples and Generate Guides from GitHub Repository Source: https://skillseekersweb.com/docs/about/use-cases This command extracts API references, usage examples from test files, how-to guides, and best practices from a specified GitHub repository to enhance documentation. ```bash skill-seekers github \ --repository your-org/your-lib \ --local-repo-path /path/to/lib \ --enhance-local ``` -------------------------------- ### Troubleshooting Example with Diagnosis and Solution Source: https://skillseekersweb.com/docs/manual/codebase-analysis/how-to-guides Shows how a basic troubleshooting list is enhanced with detailed symptoms, diagnosis steps, and a concrete solution, including package installation commands. ```markdown ## Troubleshooting ### ImportError: No module named 'requests' **Symptoms:** - Import statement fails immediately - Module not found error in stack trace - Script exits before any execution **Diagnosis:** 1. Check if package is installed: `pip list | grep requests` 2. Verify virtual environment is active: `which python` 3. Confirm Python version compatibility: `python --version` **Solution:** ```bash # Activate virtual environment first (if using one) source venv/bin/activate # Install the missing package pip install requests # Verify installation python -c "import requests; print(requests.__version__)" ``` ``` -------------------------------- ### Complete Documentation Source Configuration Source: https://skillseekersweb.com/docs/reference/config-schema This example shows a comprehensive configuration for a documentation source, including base URL, API extraction, start URLs, selectors, URL patterns, categories, and rate limiting. ```json { "type": "documentation", "base_url": "https://docs.astro.build/en/", "extract_api": true, "start_urls": [ "https://docs.astro.build/en/getting-started/", "https://docs.astro.build/en/core-concepts/" ], "selectors": { "main_content": "article", "title": "h1", "code_blocks": "pre code" }, "url_patterns": { "include": ["/en/getting-started/", "/en/core-concepts/", "/en/guides/"], "exclude": ["/en/community/", "/en/blog/"] }, "categories": { "getting_started": ["getting-started", "install"], "core_concepts": ["project-structure", "components"], "integrations": ["integrations", "framework"] }, "rate_limit": 0.5 } ``` -------------------------------- ### Preset Config Examples Source: https://skillseekersweb.com/docs/cli/scrape Examples of using preset configurations for common frameworks and engines. ```bash # Game Engines skill-seekers scrape --config configs/godot.json ``` ```bash skill-seekers scrape --config configs/unity.json ``` ```bash # Web Frameworks skill-seekers scrape --config configs/react.json ``` ```bash skill-seekers scrape --config configs/vue.json ``` ```bash skill-seekers scrape --config configs/django.json ``` ```bash skill-seekers scrape --config configs/fastapi.json ``` -------------------------------- ### Clone Repository and Run Setup Script Source: https://skillseekersweb.com/docs/manual/mcp/setup Use this command to quickly set up the Skill Seekers MCP server. It automates dependency installation, agent detection, and configuration. ```bash # Clone repository git clone https://github.com/yusufkaraaslan/Skill_Seekers.git cd Skill_Seekers # Run setup script ./setup_mcp.sh ``` -------------------------------- ### Example llms.txt Structure Source: https://skillseekersweb.com/docs/reference/llms-txt-support This is an example of the structure for an llms.txt file, including a title, overview, installation, API reference, examples, and FAQ sections. ```markdown # Your Project Documentation > Complete documentation for Your Project - optimized for LLMs # Overview Brief description of your project... # Installation Step-by-step installation guide... # API Reference Complete API documentation... # Examples Practical code examples... # FAQ Common questions and answers... ``` -------------------------------- ### Generate How-to Guides with Default AI Enhancement Source: https://skillseekersweb.com/docs/manual/codebase-analysis/how-to-guides This command generates how-to guides using the default AI enhancement. It processes extracted examples from a JSON file. ```bash skill-seekers-how-to-guides examples.json # AI enabled by default ``` -------------------------------- ### Generate How-to Guides with AI Enhancement Source: https://skillseekersweb.com/docs/manual/codebase-analysis/how-to-guides This command generates how-to guides with AI enhancement for better grouping and explanations. It processes extracted examples from a JSON file. ```bash # With AI enhancement (default) skill-seekers-how-to-guides examples.json \ --group-by ai-tutorial-group ``` ```bash # Without AI (faster, basic grouping) skill-seekers-how-to-guides examples.json --no-ai ``` -------------------------------- ### Verify Workflow Examples Exist Source: https://skillseekersweb.com/docs/manual/codebase-analysis/how-to-guides Use this `jq` command to verify that workflow examples exist in your JSON file. This is a troubleshooting step for when no guides are generated. ```bash # Verify workflow examples exist jq '.examples[] | select(.category == "workflow")' examples.json ``` -------------------------------- ### Utility Command Examples Source: https://skillseekersweb.com/docs/cli/overview Examples of utility commands for configuration, resuming jobs, and validation. ```bash skill-seekers config --github ``` ```bash skill-seekers resume abc123 ``` ```bash skill-seekers estimate --config configs/react.json ``` ```bash skill-seekers validate configs/react.json ``` ```bash skill-seekers install output/react.zip ``` -------------------------------- ### Direct to GitHub Token Setup Source: https://skillseekersweb.com/docs/cli/config Opens the interactive menu directly to the GitHub token setup section. ```bash skill-seekers config --github ``` -------------------------------- ### Install Git on Linux Source: https://skillseekersweb.com/docs/getting-started/installation Install Git using apt. ```bash sudo apt install git ``` -------------------------------- ### Example Index File Structure Source: https://skillseekersweb.com/docs/manual/codebase-analysis/how-to-guides Illustrates the structure of an index file for auto-generated how-to guides, providing an overview and categorization by difficulty. ```markdown # How-To Guides Auto-generated guides from test workflow examples. ## By Difficulty ### Beginner (3 guides) - [Create and Save User](user-creation-workflow.md) - [Simple Database Query](database-query.md) - [User Authentication](authentication-flow.md) ### Intermediate (2 guides) - [Multi-Step User Registration](user-registration.md) - [Transaction Management](transactions.md) ### Advanced (1 guide) - [Complex API Integration](api-integration.md) ``` -------------------------------- ### Scraping YouTube Videos and Local Files Source: https://skillseekersweb.com/docs/manual/scraping/video Use these commands to scrape content from YouTube URLs, local video files, or YouTube playlists. The `--setup` command is for first-time installation of GPU-aware dependencies. ```bash skill-seekers video --url https://www.youtube.com/watch?v=... --name mytutorial ``` ```bash skill-seekers video --video-file tutorial.mp4 --name mytutorial ``` ```bash skill-seekers video --playlist https://www.youtube.com/playlist?list=... --name series ``` ```bash skill-seekers video --setup ``` -------------------------------- ### Core Command Examples Source: https://skillseekersweb.com/docs/cli/overview Examples of core commands for scraping documentation, GitHub repositories, and PDFs. ```bash skill-seekers scrape --config configs/react.json ``` ```bash skill-seekers github --repo facebook/react ``` ```bash skill-seekers pdf --pdf manual.pdf --name myskill ``` ```bash skill-seekers unified --config configs/react_unified.json ``` -------------------------------- ### Install and Enhance with Gemini Source: https://skillseekersweb.com/docs/manual/enhancement/ai-enhancement Install Gemini support, set the GOOGLE_API_KEY, and enhance a project targeting Gemini. ```bash # Install Gemini support pip install skill-seekers[gemini] # Set API key export GOOGLE_API_KEY=AIzaSy... # Enhance with Gemini skill-seekers enhance output/react/ --target gemini --mode api ``` -------------------------------- ### Install Dependencies Source: https://skillseekersweb.com/docs/community/contributing Install the project dependencies, including development and testing packages. ```bash pip install -e ".[dev,test]" ``` -------------------------------- ### Install Skill Seekers via PyPI Source: https://skillseekersweb.com/docs/getting-started/installation Use pip to install the base package or with specific LLM platform support. This is the recommended installation method. ```bash # Install base package pip install skill-seekers # Or install with specific LLM platform support pip install skill-seekers[gemini] # For Google Gemini pip install skill-seekers[openai] # For OpenAI ChatGPT pip install skill-seekers[all] # For all platforms ``` -------------------------------- ### Install Qdrant Client Source: https://skillseekersweb.com/docs/integrations/rag/qdrant Install the Qdrant Python client library using pip. This is necessary for interacting with Qdrant from Python. ```bash pip install qdrant-client ``` -------------------------------- ### Install Weaviate Client Source: https://skillseekersweb.com/docs/integrations/rag/weaviate Install the Weaviate Python client library version 4.0.0 or higher. ```bash pip install weaviate-client>=4.0.0 ``` -------------------------------- ### Install FAISS Source: https://skillseekersweb.com/docs/integrations/rag/faiss Install the FAISS library. Choose 'faiss-cpu' for CPU-only or 'faiss-gpu' if you have a compatible NVIDIA GPU and CUDA installed. ```bash pip install faiss-cpu # or faiss-gpu ``` -------------------------------- ### Processing Command Examples Source: https://skillseekersweb.com/docs/cli/overview Examples of commands for enhancing, packaging, and uploading AI skills. ```bash skill-seekers enhance output/react/ ``` ```bash skill-seekers package output/react/ --target claude ``` ```bash skill-seekers upload output/react.zip ``` -------------------------------- ### Generate Onboarding Tutorials Source: https://skillseekersweb.com/docs/manual/codebase-analysis/how-to-guides Generate tutorials for new team members by specifying the input JSON file, grouping strategy, and output directory. ```bash skill-seekers-how-to-guides tests/integration/test_examples.json \ --group-by ai-tutorial-group \ --output docs/tutorials/ ``` -------------------------------- ### Complete Workflow Example Source: https://skillseekersweb.com/docs/cli/upload Demonstrates the complete workflow from scraping documentation to uploading a skill. ```bash # 1. Scrape documentation skill-seekers scrape --config configs/react.json # 2. Enhance skill-seekers enhance output/react/ # 3. Package for platform skill-seekers package output/react/ --target claude # 4. Upload export ANTHROPIC_API_KEY=sk-ant-... skill-seekers upload output/react.zip ``` -------------------------------- ### Start HTTP Server with Custom Port Source: https://skillseekersweb.com/docs/manual/mcp/setup Configure and start the HTTP server to listen on a custom port. ```bash # Start HTTP server on custom port python -m skill_seekers.mcp.server_fastmcp --http --port 8080 ``` -------------------------------- ### Multi-Platform Workflow Example Source: https://skillseekersweb.com/docs/cli/overview Illustrates packaging and uploading a skill for multiple LLM platforms. ```bash # Scrape once skill-seekers scrape --config configs/react.json # Package for all platforms skill-seekers package output/react/ --target claude skill-seekers package output/react/ --target gemini skill-seekers package output/react/ --target openai skill-seekers package output/react/ --target markdown # Upload to platforms skill-seekers upload output/react.zip --target claude skill-seekers upload output/react-gemini.tar.gz --target gemini skill-seekers upload output/react-openai.zip --target openai ``` -------------------------------- ### Install SkillSeekers with MCP Options Source: https://skillseekersweb.com/docs/community/changelog Install SkillSeekers with different dependency profiles. Use '[mcp]' for full MCP support or '[all]' for all features. CLI-only installation is also available. ```bash pip install skill-seekers ``` ```bash pip install skill-seekers[mcp] ``` ```bash pip install skill-seekers[all] ``` -------------------------------- ### Complete Workflow Example Source: https://skillseekersweb.com/docs/cli/overview Demonstrates a typical end-to-end workflow for creating and deploying an AI skill. ```bash # 1. Scrape documentation skill-seekers scrape --config configs/react.json # 2. Enhance with AI skill-seekers enhance output/react/ # 3. Package for platform skill-seekers package output/react/ --target claude # 4. Upload to platform skill-seekers upload output/react.zip ``` -------------------------------- ### Example Guide Header Structure Source: https://skillseekersweb.com/docs/manual/codebase-analysis/how-to-guides Defines the header for a generated how-to guide, including title, difficulty, estimated time, and tags. ```markdown # How To: Create and Save User to Database **Difficulty**: Beginner **Estimated Time**: 10 minutes **Tags**: user, database, create ``` -------------------------------- ### FastAPI Unified Config Example Source: https://skillseekersweb.com/docs/cli/unified An example configuration for unified scraping of FastAPI, combining documentation, GitHub issues, and a PDF guide. ```json { "name": "fastapi", "description": "Complete FastAPI knowledge", "merge_mode": "ai-powered", "sources": [ { "type": "documentation", "base_url": "https://fastapi.tiangolo.com/" }, { "type": "github", "repo": "fastapi/fastapi", "include_issues": true, "max_issues": 100 }, { "type": "pdf", "pdf_path": "docs/fastapi_guide.pdf" } ] } ``` -------------------------------- ### Install and Enhance with OpenAI Source: https://skillseekersweb.com/docs/manual/enhancement/ai-enhancement Install OpenAI support, set the OPENAI_API_KEY, and enhance a project targeting OpenAI. ```bash # Install OpenAI support pip install skill-seekers[openai] # Set API key export OPENAI_API_KEY=sk-proj-... # Enhance with GPT-4o skill-seekers enhance output/react/ --target openai --mode api ``` -------------------------------- ### Example Python Code Snippet Source: https://skillseekersweb.com/docs/manual/scraping/pdf This Python code snippet demonstrates initializing a system by loading configuration and setting up logging. ```python def initialize_system(): config = load_config() setup_logging(config) return System(config) ``` -------------------------------- ### Install Git on macOS Source: https://skillseekersweb.com/docs/getting-started/installation Install Git using Homebrew. ```bash brew install git ``` -------------------------------- ### Complete Configuration File Example Source: https://skillseekersweb.com/docs/manual/scraping/pdf A comprehensive example of a configuration file for the skill-seekers tool, including PDF path, extraction options, and category definitions. ```json { "name": "godot_manual", "description": "Godot Engine documentation from PDF manual", "pdf_path": "docs/godot_manual.pdf", "extract_options": { "chunk_size": 15, "min_quality": 6.0, "extract_images": true, "min_image_size": 200, "ocr": false, "extract_tables": false, "parallel": false, "workers": 4 }, "categories": { "getting_started": [ "introduction", "getting started", "installation", "first steps" ], "scripting": [ "gdscript", "scripting", "code", "programming" ], "3d": [ "3d", "spatial", "mesh", "shader" ] } } ``` -------------------------------- ### Install Skill Seekers Core Package Source: https://skillseekersweb.com/docs/manual/platforms/multi-llm-support Installs the core package with default Claude AI support. Use this for the most basic setup. ```bash # Default installation (Claude support only) pip install skill-seekers ``` -------------------------------- ### Complete Install Workflow Source: https://skillseekersweb.com/docs/manual/mcp/setup Use this tool to complete the skill installation workflow. Requires a configuration path, target platform, and an option to enhance the skill. ```python result = await mcp.call_tool("install_skill", { "config_path": "configs/react.json", "target": "claude", "enhance": true }) ``` -------------------------------- ### Install Pinecone Client Source: https://skillseekersweb.com/docs/integrations/rag/pinecone Install the official Pinecone client library for Python to interact with the Pinecone service. ```bash pip install pinecone-client ``` -------------------------------- ### Install Gemini Support Source: https://skillseekersweb.com/docs/cli/upload Install the necessary package to enable support for Google Gemini uploads. ```bash # Install Gemini support pip install skill-seekers[gemini] ``` -------------------------------- ### Automatic Codebase Analysis Pipeline Source: https://skillseekersweb.com/docs/manual/codebase-analysis/how-to-guides Enable automatic guide generation as part of the codebase analysis pipeline. This command extracts test examples and builds guides in one go. Use --skip-how-to-guides to disable guide generation. ```bash # Automatic pipeline: extract tests β†’ build guides skill-seekers-codebase tests/ \ --extract-test-examples \ --build-how-to-guides \ --output output/codebase/ ``` ```bash # Skip guide generation skill-seekers-codebase tests/ \ --skip-how-to-guides ``` -------------------------------- ### Configuration Example - Python Source: https://skillseekersweb.com/docs/manual/codebase-analysis/test-extraction Extracts configuration dictionaries with two or more keys. This example shows a valid configuration dictionary for application settings. ```python # Example from test config = { "debug": True, "database_url": "postgresql://localhost/test", "cache_enabled": False } ``` -------------------------------- ### Create React Skill with Docs and GitHub Examples Source: https://skillseekersweb.com/docs/about/use-cases Use this command to scrape documentation and GitHub examples for a specific framework like React, creating a comprehensive AI skill for learning and reference. ```bash skill-seekers scrape --config configs/react.json skill-seekers enhance output/react/ skill-seekers package output/react/ --upload ``` -------------------------------- ### Test Skill with Example Prompts Source: https://skillseekersweb.com/docs/getting-started/first-skill After uploading, test the skill's performance by asking questions related to the documentation it was trained on. These example prompts cover utilities, components, and conceptual differences. ```bash "What are the Tailwind spacing utilities?" "Show me how to create a responsive navbar with Tailwind" "What's the difference between px-4 and p-4?" "Create a card component using Tailwind utilities" ``` -------------------------------- ### Method Call Example - Python Source: https://skillseekersweb.com/docs/manual/codebase-analysis/test-extraction Extracts method calls followed by assertions. This example demonstrates expected behavior by making an API GET request and asserting the status code. ```python # Example from test response = api.get("/users/1") assert response.status_code == 200 ``` -------------------------------- ### Install OpenAI Support Source: https://skillseekersweb.com/docs/cli/upload Install the necessary package to enable support for OpenAI ChatGPT uploads. ```bash # Install OpenAI support pip install skill-seekers[openai] ``` -------------------------------- ### Multi-Platform Workflow Example Source: https://skillseekersweb.com/docs/cli/package Illustrates a complete workflow: scraping, enhancing, and then packaging skills for all major LLM platforms. ```bash # 1. Scrape once skill-seekers scrape --config configs/react.json # 2. Enhance once skill-seekers enhance output/react/ # 3. Package for all platforms skill-seekers package output/react/ --target claude skill-seekers package output/react/ --target gemini skill-seekers package output/react/ --target openai skill-seekers package output/react/ --target markdown # Result: # - output/react.zip (Claude) # - output/react-gemini.tar.gz (Gemini) # - output/react-openai.zip (OpenAI) # - output/react-markdown.zip (Universal) ``` -------------------------------- ### Extract API Usage Examples Source: https://skillseekersweb.com/docs/manual/codebase-analysis/how-to-guides Extract usage patterns from test suites to generate step-by-step API integration guides. This command analyzes a specified directory. ```bash skill-seekers-codebase tests/api/ \ --extract-test-examples \ --build-how-to-guides ``` -------------------------------- ### Install with Sudo (Not Recommended) Source: https://skillseekersweb.com/docs/guides/troubleshooting Use sudo to install packages globally. This is generally not recommended due to potential permission conflicts. ```bash sudo pip3 install requests beautifulsoup4 ``` -------------------------------- ### C3.3 How-To Guide Generation - Step 2: Generate Authorization URL Source: https://skillseekersweb.com/docs/manual/codebase-analysis/c3x-codebase-analysis Example Python code for generating an OAuth authorization URL, as generated by C3.3. ```python auth_url = provider.get_authorization_url() # Redirect user to auth_url ``` -------------------------------- ### C3.3 How-To Guide Generation - Step 1: Create Provider Instance Source: https://skillseekersweb.com/docs/manual/codebase-analysis/c3x-codebase-analysis Example Python code for creating an OAuth provider instance, as generated by C3.3. ```python from fastmcp import GoogleProvider provider = GoogleProvider( client_id="your-client-id", client_secret="your-secret", redirect_uri="http://localhost:8000/callback" ) ``` -------------------------------- ### Install and Use GitHub Copilot Agent Source: https://skillseekersweb.com/docs/guides/multi-agent First, install the Copilot CLI extension, then use Skill Seekers with the Copilot agent. ```bash # Install Copilot CLI gh extension install github/copilot # Use with Skill Seekers skill-seekers enhance output/react/ --agent copilot ``` -------------------------------- ### C3.3 How-To Guide Generation - Step 3: Handle Callback Source: https://skillseekersweb.com/docs/manual/codebase-analysis/c3x-codebase-analysis Example Python code for handling an OAuth callback and retrieving user information, as generated by C3.3. ```python token = provider.exchange_code(request.params['code']) user_info = provider.get_user_info(token) ``` -------------------------------- ### Advanced Example with All Features Source: https://skillseekersweb.com/docs/cli/github A comprehensive example demonstrating the use of all available features, including deep code analysis, issue and release scraping, and specifying an output directory. ```bash export GITHUB_TOKEN=ghp_... skill-seekers github --repo fastapi/fastapi \ --code-analysis-depth deep \ --include-issues \ --max-issues 200 \ --include-changelog \ --include-releases \ --output output/fastapi ``` -------------------------------- ### CI/CD Workflow for Skill Updates Source: https://skillseekersweb.com/docs/getting-started/understanding-skills Example GitHub Actions workflow to automate the process of updating skills weekly. It checks out the code, installs 'skill-seekers', creates the skill, and uploads it. ```yaml # .github/workflows/update-skills.yml name: Update Skills on: schedule: - cron: '0 0 * * 0' # Weekly jobs: update: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - run: pip install skill-seekers - run: skill-seekers create https://react.dev --target claude - run: skill-seekers upload react-claude.zip --target claude ``` -------------------------------- ### CI/CD Enhancement Example Source: https://skillseekersweb.com/docs/manual/enhancement/ai-enhancement Example of integrating skill enhancement into a GitHub Actions workflow, using headless mode and checking for success. ```yaml # GitHub Actions example - name: Enhance skill run: | # Headless mode (blocks until done) skill-seekers enhance output/react/ --timeout 1200 --force # Check if enhancement succeeded if [ $? -eq 0 ]; then echo "βœ… Enhancement successful" else echo "❌ Enhancement failed" exit 1 fi ``` -------------------------------- ### Basic Usage of skill-seekers create Source: https://skillseekersweb.com/docs/cli/create The fundamental syntax for using the create command. Replace `` with the actual URL, file path, or repository identifier. ```bash skill-seekers create [options] ``` -------------------------------- ### Run Skill Seekers with Docker Source: https://skillseekersweb.com/docs/getting-started/installation Pull the Skill Seekers Docker image and run it to execute commands without installing Python locally. This example shows creating a skill. ```bash # Pull the image docker pull skillseekers/skill-seekers:latest # Run docker run -v $(pwd):/data skillseekers/skill-seekers:latest \ create https://react.dev --target claude --output /data/react/ ``` -------------------------------- ### Quick Scrape Examples Source: https://skillseekersweb.com/docs/cli/scrape Demonstrates various ways to quickly scrape documentation using presets, URLs, or interactive mode. ```bash # Use preset config (easiest) skill-seekers scrape --config configs/react.json ``` ```bash # Quick scrape without config skill-seekers scrape --url https://react.dev --name react ``` ```bash # Interactive mode skill-seekers scrape --interactive ``` ```bash # With async mode (3x faster) skill-seekers scrape --config configs/godot.json --async --workers 8 ``` -------------------------------- ### Selective C3.x Module Analysis Configuration Source: https://skillseekersweb.com/docs/manual/codebase-analysis/c3x-codebase-analysis Enables specific C3.x analysis modules (patterns, examples, configs, architecture) while disabling others (guides). Useful for targeted analysis. ```json { "c3x_modules": { "patterns": true, // C3.1 "examples": true, // C3.2 "guides": false, // C3.3 (skip) "configs": true, // C3.4 "architecture": true // C3.7 } } ``` -------------------------------- ### Comprehensive Quality Enhancement Source: https://skillseekersweb.com/docs/cli/enhance Enhance documentation thoroughly, including everything from standard quality plus advanced examples, troubleshooting guides, performance tips, and security considerations. This mode takes the longest. ```bash skill-seekers enhance output/react/ --quality comprehensive ``` -------------------------------- ### Python pytest Method Call Example Source: https://skillseekersweb.com/docs/manual/codebase-analysis/test-extraction This snippet shows how to extract method calls and assertions from a Python pytest test. It includes setting up a fixture for an API client and testing a GET request. ```python import pytest @pytest.fixture def client(): return APIClient(base_url="https://api.test.com") def test_get_user(client): """Test fetching user data""" response = client.get("/users/123") assert response.status_code == 200 assert response.json()["id"] == 123 ``` -------------------------------- ### Workflow 3: OpenAI ChatGPT Setup and Execution Source: https://skillseekersweb.com/docs/manual/platforms/multi-llm-support This workflow details the setup and steps for scraping, enhancing, packaging, and uploading content for OpenAI ChatGPT. ```bash # Setup (one-time) pip install skill-seekers[openai] export OPENAI_API_KEY=sk-proj-... # 1. Scrape (universal) skill-seekers scrape --config configs/react.json # 2. Enhance with GPT-4o skill-seekers enhance output/react/ --target openai # 3. Package for OpenAI skill-seekers package output/react/ --target openai # 4. Upload (creates Assistant + Vector Store) skill-seekers upload react-openai.zip --target openai # Access at: https://platform.openai.com/assistants/ ``` -------------------------------- ### Multi-Source Configuration Example Source: https://skillseekersweb.com/docs/reference/config-schema Defines a project with documentation from multiple sources: official docs, GitHub, and a PDF. Includes rate limiting and GitHub codebase analysis settings. ```json { "name": "enterprise-system", "description": "Complete enterprise system documentation from multiple sources.", "merge_mode": "claude-enhanced", "sources": [ { "type": "documentation", "base_url": "https://docs.enterprise.com/", "rate_limit": 1.0 }, { "type": "github", "repo": "company/enterprise-system", "enable_codebase_analysis": true, "code_analysis_depth": "full", "file_patterns": ["src/**/*.ts", "api/**/*.ts"] }, { "type": "pdf", "path": "/docs/enterprise-manual-v2.pdf", "extract_tables": true, "parallel": true } ] } ``` -------------------------------- ### Combine Documentation Sources for a Knowledge Base Source: https://skillseekersweb.com/docs/about/showcase This example illustrates how to combine documentation from multiple sources, including official docs and internal guidelines, into a unified skill package for AI models. ```shell # Multi-source knowledge base "Combine the Django docs with the Django REST framework docs and our internal API guidelines PDF, then package for Claude" ``` -------------------------------- ### Stream 1: Code Analysis Command Source: https://skillseekersweb.com/docs/reference/c3x-router-architecture Use this command to extract code structure, patterns, and implementation details from a GitHub repository. It can also extract test examples and build how-to guides from test workflows. ```bash skill-seekers-codebase path/to/repo/ \ --output output/project-code/ \ --extract-patterns \ --extract-test-examples \ --build-how-to-guides ``` -------------------------------- ### Deep Code Analysis Depth Source: https://skillseekersweb.com/docs/cli/github Perform a comprehensive code analysis that includes everything from medium depth, plus design pattern detection, test example extraction, how-to guide generation, configuration analysis, and architectural patterns. ```bash skill-seekers github --repo facebook/react --code-analysis-depth deep ``` -------------------------------- ### C3.x Analysis Depth Mode Command Source: https://skillseekersweb.com/docs/manual/advanced/three-stream-architecture Perform a comprehensive analysis of a GitHub repository using the 'c3x' depth mode. This includes all 'basic' mode features plus detailed analysis of design patterns, test examples, how-to guides, and configuration files. ```bash skill-seekers unified \ --repo-url https://github.com/fastapi/fastapi \ --depth c3x \ --fetch-github-metadata ``` -------------------------------- ### Generate How-to Guides with Specific Grouping Strategy Source: https://skillseekersweb.com/docs/manual/codebase-analysis/how-to-guides Use this command to generate how-to guides and specify a different grouping strategy, such as 'ai-tutorial-group', to potentially improve organization. ```bash # Try ai-tutorial-group instead of file-path skill-seekers-how-to-guides examples.json --group-by ai-tutorial-group ``` -------------------------------- ### List Available Configuration Presets Source: https://skillseekersweb.com/docs/getting-started/first-skill View all available configuration presets for popular frameworks that can be used with the `skill-seekers create` command. ```bash skill-seekers list-configs ``` -------------------------------- ### Install OpenAI Support Source: https://skillseekersweb.com/docs/manual/platforms/openai Install the Skill Seekers library with OpenAI dependencies. Verify the installation by listing installed packages. ```bash # Install with OpenAI dependencies pip install skill-seekers[openai] # Verify installation pip list | grep openai ``` -------------------------------- ### Multi-Source Configuration Example Source: https://skillseekersweb.com/docs/guides/submit-config Use this structure to combine data from multiple sources like documentation, GitHub, and PDFs. Ensure the merge strategy aligns with your data needs. ```json { "name": "advanced-framework", "description": "Complete knowledge from docs, GitHub, and PDF manual.", "merge_mode": "rule-based", "sources": [ { "type": "documentation", "base_url": "https://docs.framework.com" }, { "type": "github", "repo": "company/framework", "enable_codebase_analysis": true, "code_analysis_depth": "deep" }, { "type": "pdf", "path": "https://framework.com/manual.pdf" } ] } ``` -------------------------------- ### Install Skill Seekers with Gemini Dependencies Source: https://skillseekersweb.com/docs/manual/platforms/gemini Install the skill-seekers package with the necessary dependencies for Gemini integration. Verify the installation by listing installed packages. ```bash # Install with Gemini dependencies pip install skill-seekers[gemini] # Verify installation pip list | grep google-generativeai ``` -------------------------------- ### Install Python on macOS Source: https://skillseekersweb.com/docs/getting-started/installation Install Homebrew if you don't have it, then use Homebrew to install Python 3. ```bash # Install Homebrew (if not installed) /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" # Install Python brew install python3 ``` -------------------------------- ### Complete Custom Configuration Example Source: https://skillseekersweb.com/docs/tutorials/creating-configs A comprehensive example of a Skill Seekers configuration file, including name, version, base URL, selectors, URL patterns, rate limits, and headers. ```json { "name": "acme-platform-v2", "version": "2.3.1", "description": "Acme Platform v2.x internal documentation", "base_url": "https://internal-docs.acme.com/platform/", "selectors": { "content": "div.documentation-content", "title": "h1.doc-title", "code": "pre > code", "category": "nav.breadcrumb" }, "url_patterns": [ "^https://internal-docs.acme.com/platform/guide/", "^https://internal-docs.acme.com/platform/api/", "^https://internal-docs.acme.com/platform/tutorials/" ], "exclude_patterns": [ "/archive/", "/draft/", "/preview/", "\\?draft=true" ], "max_pages": 300, "rate_limit": 1.0, "async_mode": true, "request_timeout": 30, "headers": { "User-Agent": "SkillSeekers/3.0.0 (internal-scraper)" }, "enhancement": { "enabled": true, "method": "local", "platform": "claude" } } ``` -------------------------------- ### Troubleshooting OCR Installation Source: https://skillseekersweb.com/docs/cli/pdf Verifies the Tesseract OCR engine installation and provides commands to install it if not found. ```bash # Check Tesseract installation tesseract --version # If not found, install: # macOS: brew install tesseract # Linux: sudo apt install tesseract-ocr ``` -------------------------------- ### Install Anthropic Package Source: https://skillseekersweb.com/docs/manual/enhancement/ai-enhancement Command to install the necessary 'anthropic' Python package to resolve 'anthropic package not installed' errors. ```bash pip install anthropic ``` -------------------------------- ### Quick Start Cline Commands Source: https://skillseekersweb.com/docs/integrations/coding/cline Initial commands to set up Cline, including scraping a target and copying generated rules. ```bash skill-seekers scrape --target claude --config configs/react.json cp output/react-claude/.clinerules ./ ``` -------------------------------- ### Install Skill Seekers using uv Source: https://skillseekersweb.com Install the skill-seekers package using uv, a modern and fast package installer. ```bash uv tool install skill-seekers ``` -------------------------------- ### Configuration: Platform Selection Source: https://skillseekersweb.com/docs/manual/platforms/multi-llm-support This JSON configuration file shows how to specify multiple packaging targets and the AI enhancement provider. ```json { "name": "astro", "description": "Astro web framework documentation", "sources": [ { "type": "documentation", "base_url": "https://docs.astro.build" } ], "packaging": { "targets": ["claude", "gemini", "openai", "markdown"] }, "enhancement": { "enabled": true, "provider": "anthropic" // or "google", "openai" } } ``` -------------------------------- ### Multi-Platform Upload Example Source: https://skillseekersweb.com/docs/cli/upload Uploads a skill to all supported platforms by setting all relevant API keys and executing individual upload commands. ```bash # Set all API keys export ANTHROPIC_API_KEY=sk-ant-... export GOOGLE_API_KEY=AIzaSy... export OPENAI_API_KEY=sk-proj-... # Upload to all platforms skill-seekers upload output/react.zip --target claude skill-seekers upload output/react-gemini.tar.gz --target gemini skill-seekers upload output/react-openai.zip --target openai ``` -------------------------------- ### React Unified Config Example Source: https://skillseekersweb.com/docs/cli/unified A sample configuration file for unified scraping of React documentation and its GitHub repository. ```json { "name": "react", "description": "React docs + GitHub repo", "merge_mode": "rule-based", "sources": [ { "type": "documentation", "base_url": "https://react.dev/", "max_pages": 300 }, { "type": "github", "repo": "facebook/react", "code_analysis_depth": "deep" } ] } ``` -------------------------------- ### Install Skill Seekers Source: https://skillseekersweb.com/docs/about/faq Install the skill-seekers package using pip. Ensure you have Python 3.10+ and pip or uv installed. ```bash pip install skill-seekers ``` -------------------------------- ### Analyze GitHub Repo and Create Cursor Rules Source: https://skillseekersweb.com/docs/about/showcase This example demonstrates how to fetch a GitHub repository, analyze its codebase for patterns, and generate Cursor rules for development. ```shell # Analyze a GitHub repo and create Cursor rules "Fetch the repo https://github.com/facebook/react, analyze the codebase patterns, and create Cursor rules for React development" ``` -------------------------------- ### JSON Schema for Test Example Extraction Output Source: https://skillseekersweb.com/docs/manual/codebase-analysis/test-extraction Defines the structure of the JSON output from the test example extractor, including total examples, counts by category and language, average complexity, and a list of individual examples with detailed information. ```json { "total_examples": 42, "examples_by_category": { "instantiation": 15, "method_call": 12, "config": 8, "setup": 4, "workflow": 3 }, "examples_by_language": { "Python": 42 }, "avg_complexity": 0.65, "high_value_count": 28, "examples": [ { "example_id": "a3f2b1c0", "test_name": "test_database_connection", "category": "instantiation", "code": "db = Database(host=\"localhost\", port=5432)", "language": "Python", "description": "Instantiate Database: Test database connection", "expected_behavior": "self.assertTrue(db.connect())", "setup_code": null, "file_path": "tests/test_db.py", "line_start": 15, "line_end": 15, "complexity_score": 0.6, "confidence": 0.85, "tags": ["unittest"], "dependencies": ["unittest", "database"] } ] } ``` -------------------------------- ### List All Configurations with Estimate Command Source: https://skillseekersweb.com/docs/community/changelog Use the --all flag with the estimate command to list all available preset configurations, including their names, supported frameworks, and documentation URLs. This helps users discover supported frameworks before scraping. ```bash skill-seekers estimate --all ``` -------------------------------- ### Install MCP Dependencies Source: https://skillseekersweb.com/docs/manual/mcp/setup Install the necessary MCP dependencies using pip. This command installs the package in editable mode with MCP extras. ```bash # Install MCP dependencies pip install -e ".[mcp]" ``` -------------------------------- ### Generate Examples for Documentation Source: https://skillseekersweb.com/docs/manual/codebase-analysis/test-extraction Use this command to extract test examples and append them to a Markdown file, enhancing documentation with real usage scenarios. ```bash # Generate examples for SKILL.md skill-seekers extract-test-examples tests/ --markdown >> SKILL.md ``` -------------------------------- ### Install SkillSeekers with All Features Source: https://skillseekersweb.com/docs/community/changelog Install the SkillSeekers package with all available features and dependencies. This is a comprehensive installation for users who want access to every capability. ```bash pip install skill-seekers[all] ``` -------------------------------- ### Install Skill-Seekers with MCP Integration Source: https://skillseekersweb.com/docs/community/changelog Install the skill-seekers package including MCP integration. This command is for new installations that require MCP features. ```bash pip install skill-seekers[mcp] ``` -------------------------------- ### Install Python Dependencies Source: https://skillseekersweb.com/docs/guides/troubleshooting Install necessary Python packages like requests and beautifulsoup4 using pip3. For MCP, install from its requirements file. ```bash pip3 install requests beautifulsoup4 ``` ```bash pip3 install -r mcp/requirements.txt ``` -------------------------------- ### Workflow 2: Google Gemini Setup and Execution Source: https://skillseekersweb.com/docs/manual/platforms/multi-llm-support This workflow outlines the setup and steps required to scrape, enhance, package, and upload content specifically for Google Gemini. ```bash # Setup (one-time) pip install skill-seekers[gemini] export GOOGLE_API_KEY=AIzaSy... # 1. Scrape (universal) skill-seekers scrape --config configs/react.json # 2. Enhance for Gemini skill-seekers enhance output/react/ --target gemini # 3. Package for Gemini skill-seekers package output/react/ --target gemini # 4. Upload to Gemini skill-seekers upload react-gemini.tar.gz --target gemini # Access at: https://aistudio.google.com/files/ ``` -------------------------------- ### llms.txt Example Structure Source: https://skillseekersweb.com/docs/reference/llms-txt-support An example of the standard structure for an llms.txt file, which uses plain markdown with hierarchical organization and includes code examples. ```markdown # Example.com Documentation > AI-optimized documentation for Example.com # Getting Started ## Installation ```bash npm install example ``` ## Quick Start 1. Create a new project 2. Configure settings 3. Run the application # API Reference ## Core Functions ### `doSomething(param)` Description of the function… # Examples ## Basic Example ``` const result = doSomething(\'value\'); ``` ``` -------------------------------- ### Example of Auto-Detection Tool Usage Source: https://skillseekersweb.com/docs/community/roadmap Illustrates how the tool automatically detects a framework and generates a skill configuration quickly. ```text User: "Create skill from https://tailwindcss.com/docs" Tool: Auto-detects Tailwind, uses template, generates in 30 seconds ``` -------------------------------- ### Markdown Format for Test Example Extraction Report Source: https://skillseekersweb.com/docs/manual/codebase-analysis/test-extraction Example of a test example extraction report formatted in Markdown. It includes a summary of statistics and a detailed list of extracted examples with their category, description, expected behavior, confidence, and source location. ```markdown # Test Example Extraction Report **Total Examples**: 42 **High Value Examples** (confidence > 0.7): 28 **Average Complexity**: 0.65 ## Examples by Category - **instantiation**: 15 - **method_call**: 12 - **config**: 8 - **setup**: 4 - **workflow**: 3 ## Extracted Examples ### test_database_connection **Category**: instantiation **Description**: Instantiate Database: Test database connection **Expected**: self.assertTrue(db.connect()) **Confidence**: 0.85 **Tags**: unittest ```python db = Database(host="localhost", port=5432) ``` _Source: tests/test_db.py:15_ ``` -------------------------------- ### Quick Start Kubernetes Deployment Source: https://skillseekersweb.com/docs/deployments/kubernetes Apply the Kubernetes manifests and check the status of the Skill Seekers pods. Ensure kubectl is configured to your cluster. ```bash # Apply manifests kubectl apply -f k8s/ # Check status kubectl get pods -l app=skill-seekers ``` -------------------------------- ### Install SkillSeekers with OpenAI Support Source: https://skillseekersweb.com/docs/community/changelog Install SkillSeekers with optional dependencies for OpenAI. This command installs the base package along with the specific extras for OpenAI. ```bash pip install skill-seekers[openai] ``` -------------------------------- ### Setup Shared Team Repository Source: https://skillseekersweb.com/docs/reference/git-config-sources Initializes a Git repository for team configurations, adds initial configs, and pushes to a remote. Team members then add this as a source. ```bash # 1. Create git repository for team configs mkdir scraping-configs cd scraping-configs git init mkdir -p configs/{frontend,backend,internal} ``` ```bash # 2. Add configs # (create JSON files in configs/) ``` ```bash # 3. Push to team repo git add . git commit -m "Initial team configs" git remote add origin https://github.com/your-org/scraping-configs.git git push -u origin main ``` ```bash # Add team source skill-seekers add-git-source \ https://github.com/your-org/scraping-configs.git \ --name team-configs \ --token ghp_teamToken... ``` ```bash # Use team configs skill-seekers scrape --config team-configs:frontend/react.json ``` -------------------------------- ### Install with User Flag for Permissions Source: https://skillseekersweb.com/docs/getting-started/installation If you encounter permission errors during installation, use the `--user` flag with pip to install packages in your user directory. ```bash pip install --user skill-seekers ``` -------------------------------- ### Install Claude Code Source: https://skillseekersweb.com/docs/getting-started/installation Install Claude Code, which enables free local AI enhancement. Installation can be done via Homebrew on macOS or npm. ```bash # Install via Homebrew (macOS) brew install claude # Or via npm npm install -g @anthropic/claude-code # Verify claude --version ``` -------------------------------- ### Instantiation Example - Python Source: https://skillseekersweb.com/docs/manual/codebase-analysis/test-extraction Extracts object creation with real parameter values. This example shows valid initialization parameters for a Database object. ```python # Example from test db = Database( host="localhost", port=5432, user="admin", password="secret" ) ``` -------------------------------- ### Create Config Directory and Run Wizard Source: https://skillseekersweb.com/docs/cli/config Use these commands to create the necessary configuration directory and then run the Skill Seekers configuration wizard when the config file is not found. ```bash # Create config directory mkdir -p ~/.config/skill-seekers # Run config wizard skill-seekers config ``` -------------------------------- ### Install Skill Seekers with uv Source: https://skillseekersweb.com/docs/getting-started/installation Install uv, a fast Python package manager, and then use it to install Skill Seekers. This method is generally faster. ```bash # Install uv curl -LsSf https://astral.sh/uv/install.sh | sh # Install Skill Seekers uv tool install skill-seekers # Verify skill-seekers --version ``` -------------------------------- ### Install Skill Seekers with Helm Chart Source: https://skillseekersweb.com/docs/deployments/kubernetes Add the Skill Seekers Helm repository and install the chart. Customize the installation with specific configuration values. ```bash # Add repo helm repo add skillseekers https://charts.skillseekers.io # Install helm install skill-seekers skillseekers/skill-seekers \ --set config.name=react \ --set schedule="0 0 * * 0" ``` -------------------------------- ### Getting Help Source: https://skillseekersweb.com/docs/cli/overview Access general help or command-specific documentation using the --help flag. ```bash # General help skill-seekers --help # Command-specific help skill-seekers scrape --help skill-seekers github --help skill-seekers package --help skill-seekers config --help skill-seekers resume --help ``` -------------------------------- ### Install All Skill-Seekers Features Source: https://skillseekersweb.com/docs/community/changelog Install the skill-seekers package with all available features, including MCP support. This is a comprehensive installation for users who want access to every functionality. ```bash pip install -U skill-seekers[all] ``` -------------------------------- ### Package Documentation for OpenAI Source: https://skillseekersweb.com/docs/manual/platforms/openai Create a ZIP package containing assistant instructions, vector store files, and platform metadata, ready for upload to OpenAI Assistants. ```bash # Create ZIP package for OpenAI Assistants skill-seekers package output/react/ --target openai # Result: react-openai.zip ``` -------------------------------- ### Best Practices: Test with Sample Source: https://skillseekersweb.com/docs/reference/large-documentation Validate scraping configuration by running a test scrape on a small sample of pages. ```bash skill-seekers scrape --config X --max-pages 100 --output test/ ```