Skill Seeker

https://github.com/yusufkaraaslan/skill_seekers
Admin
Skill Seeker is an automated tool that transforms any documentation website or PDF into a...
Tokens:291,995
Snippets:2,631
Trust Score:8.1
License:MIT
Update:8 months ago
Show doc for...
Tokens:
Raw
### Run Skill Seekers Setup Wizard

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/README.md

Launches the Skill Seekers setup wizard, which guides users through choosing installation options and configuring features based on their needs. It provides detailed feature lists and recommendations.

```bash
skill-seekers-setup
```

--------------------------------

### Markdown Guide Prerequisites Example

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/features/HOW_TO_GUIDES.md

An example of the prerequisites section in a generated markdown guide. It lists required modules, fixtures, setup code, and external dependencies needed to follow the guide.

```markdown
## Prerequisites

- [ ] Database connection configured
- [ ] User model imported

**Required Modules:**
- `from myapp import Database, User`
```

--------------------------------

### Complete Setup and First Skill Workflow

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/guides/MCP_SETUP.md

Outlines the steps for a complete end-to-end setup of the Skill Seekers project, including cloning the repository, running auto-configuration, starting the HTTP server, and testing with example user prompts.

```bash
# 1. Install from source
cd ~/Projects
git clone https://github.com/yusufkaraaslan/Skill_Seekers.git
cd Skill_Seekers

# 2. Run auto-configuration
./setup_mcp.sh

# 3. Follow prompts
# - Installs dependencies
# - Detects agents
# - Configures automatically

# 4. For HTTP agents, start server
python -m skill_seekers.mcp.server_fastmcp --http --port 3000

# 5. Restart your AI coding agent

# 6. Test in agent:

```

--------------------------------

### Extract Test Examples for Migration Guides (Bash)

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/features/HOW_TO_GUIDES.md

These commands demonstrate the process of generating migration guides by first extracting test examples from both old and new versions of a codebase. The extracted examples are saved to separate JSON files, which are then used to generate distinct sets of guides for comparison.

```bash
# Extract from old version tests
skill-seekers-extract-test-examples tests/ --output old-examples.json

# Extract from new version tests
skill-seekers-extract-test-examples tests/ --output new-examples.json

# Generate migration guides
skill-seekers-how-to-guides old-examples.json --output migration/old/
skill-seekers-how-to-guides new-examples.json --output migration/new/
```

--------------------------------

### Configure All Detected Agents

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/guides/SETUP_QUICK_REFERENCE.md

Executes the setup script and selects option 1 to configure all automatically detected agents. This is the simplest way to get started.

```bash
./setup_mcp.sh
# Choose option 1 when prompted
```

--------------------------------

### Generate API Usage Examples (Bash)

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/features/HOW_TO_GUIDES.md

This command extracts test examples from an API test directory and builds how-to guides. The resulting guides serve as step-by-step API integration examples derived directly from actual test workflows, aiding developers in understanding API usage.

```bash
skill-seekers analyze tests/api/ \
  --extract-test-examples \
  --build-how-to-guides
```

--------------------------------

### Python: Example of Setup Initialization

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/features/TEST_EXAMPLE_EXTRACTION.md

Demonstrates the extraction of initialization code commonly found in setUp() methods or test fixtures. This example shows the creation and connection of an API client.

```python
# Example from setUp
self.client = APIClient(api_key="test-key")
self.client.connect()
```

--------------------------------

### File Path Grouping Strategy Example

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/features/HOW_TO_GUIDES.md

This demonstrates the command-line usage for the 'file-path' grouping strategy, which organizes guides based on their original test file locations. An example output structure is provided.

```bash
skill-seekers-how-to-guides examples.json --group-by file-path
```

--------------------------------

### Install Dependencies with Pip

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/QUICKSTART.md

Installs the necessary Python packages, 'requests' for making HTTP requests and 'beautifulsoup4' for parsing HTML content. This is a prerequisite for running the skill-seekers tool.

```bash
pip3 install requests beautifulsoup4
```

--------------------------------

### Start MCP HTTP Server

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/guides/SETUP_QUICK_REFERENCE.md

Starts the MCP HTTP server, either as part of the initial setup process or manually. It can be configured to run on a specific port.

```bash
# During setup
./setup_mcp.sh
# Choose option 1 for HTTP server

# Manual start
python3 -m skill_seekers.mcp.server_fastmcp --http --port 3000
```

--------------------------------

### Repository Structure Examples

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/reference/GIT_CONFIG_SOURCES.md

Illustrates recommended directory structures for Git configuration repositories. Supports both flat structures for smaller repos and organized structures with subdirectories for larger, more complex setups.

```bash
# Flat structure (recommended for small repos):
skill-configs/
├── README.md
├── react-internal.json
├── vue-internal.json
└── api-v2.json

# Organized structure (recommended for large repos):
skill-configs/
├── README.md
├── frontend/
│   ├── react-internal.json
│   └── vue-internal.json
├── backend/
│   ├── django-api.json
│   └── fastapi-platform.json
└── mobile/
    ├── react-native.json
    └── flutter.json
```

--------------------------------

### Full Pipeline for Analysis and Guide Building (Bash)

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/features/HOW_TO_GUIDES.md

This bash command initiates the full Skill Seekers pipeline, starting with analyzing a directory of tests, extracting relevant examples, and subsequently building how-to guides from the extracted data. It's a comprehensive command for end-to-end documentation generation.

```bash
# Full pipeline
skill-seekers analyze tests/ \
  --extract-test-examples \
  --build-how-to-guides
```

--------------------------------

### Complete Python Example in Markdown Guide

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/features/HOW_TO_GUIDES.md

A complete Python code example embedded within a markdown guide, combining multiple steps to demonstrate a full workflow, such as creating, saving, and verifying a user in a database.

```markdown
## Complete Example

```python
# Step 1: Create database connection
db = Database('test.db')

# Step 2: Create user object
user = User(name='Alice', email='alice@example.com')

# Step 3: Save to database
db.save(user)

# Step 4: Verify user was saved
saved_user = db.get_user('Alice')
assert saved_user.email == 'alice@example.com'
```
```

--------------------------------

### Build How-To Guides using skill-seekers CLI

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/features/HOW_TO_GUIDES.md

This command generates how-to guides from extracted test examples. It takes a JSON file of test examples as input and outputs markdown tutorials. Various grouping strategies can be applied to organize the generated guides.

```bash
skill-seekers-how-to-guides \
  output/codebase/test_examples/test_examples.json \
  --output output/codebase/tutorials/

# 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
```

--------------------------------

### View Usage Guide

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/guides/USAGE.md

This bash command shows the main usage guide for the project. It typically covers installation, basic usage, and common workflows.

```bash
cat docs/USAGE.md          # This file
```

--------------------------------

### JSON Output Format for Guide Metadata

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/features/HOW_TO_GUIDES.md

An example of the optional JSON output format for programmatic access to guide metadata. It includes total guide counts, guides categorized by complexity and use case, and detailed information for each guide.

```json
{
  "total_guides": 6,
  "guides_by_complexity": {
    "beginner": 3,
    "intermediate": 2,
    "advanced": 1
  },
  "guides_by_use_case": {
    "User Management": [
      {
        "guide_id": "user-creation",
        "title": "Create and Save User",
        "complexity_level": "beginner",
        "steps": 4,
        "tags": ["user", "database", "create"]
      }
    ]
  },
  "guides": [...]
}
```

--------------------------------

### One-Command Install Workflow Examples

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/README.md

Illustrates various ways to use the `skill-seekers install` command for automating the process of creating and uploading skills, including options for different configurations and behaviors.

```bash
# Install React skill from official configs (auto-uploads to Claude)
skill-seekers install --config react

# Install from local config file
skill-seekers install --config configs/custom.json

# Install without uploading (package only)
skill-seekers install --config django --no-upload

# Unlimited scraping (no page limits)
skill-seekers install --config godot --unlimited

# Preview workflow without executing
skill-seekers install --config react --dry-run
```

--------------------------------

### Quick Start Guide Generation (Bash)

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/features/HOW_TO_GUIDES.md

Initiates the process of analyzing a codebase for tests and generating how-to guides, outputting the results to a specified directory.

```bash
# Quick start
skill-seekers analyze tests/ --output output/codebase/
```

--------------------------------

### Generate Onboarding Documentation (Bash)

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/features/HOW_TO_GUIDES.md

This command generates onboarding tutorials from integration test examples. It uses the skill-seekers CLI with AI-powered grouping to create comprehensive guides for new team members, outputting them to a specified documentation directory.

```bash
skill-seekers-how-to-guides tests/integration/test_examples.json \
  --group-by ai-tutorial-group \
  --output docs/tutorials/
```

--------------------------------

### Run Multi-Agent Setup Script

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/guides/MULTI_AGENT_SETUP.md

Executes the primary setup script for automatic detection and configuration of AI coding agents. It checks Python version, verifies paths, installs dependencies, tests transports, detects agents, configures them, starts the HTTP server if needed, and validates configurations.

```bash
# Run the setup script
./setup_mcp.sh
```

--------------------------------

### Install Skill Seeker from PyPI

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/guides/MCP_SETUP.md

Installs the Skill Seeker package from the Python Package Index (PyPI). This is an alternative to cloning the repository for installation.

```bash
pip install skill-seekers
```

--------------------------------

### Add Example Team Configuration Source (Bash)

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/README.md

Demonstrates how to add a local configuration source using a `file://` URL for testing purposes. This is useful for verifying configurations without needing network access or authentication, as shown in the example team repository setup.

```bash
add_config_source(
    name="example",
    git_url="file://$(pwd)/configs/example-team",
    branch="master"
)
```

--------------------------------

### Development Install and CLI Usage

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/README.md

Instructions for cloning the repository, installing the package in editable mode, and subsequently using the unified CLI.

```bash
# Clone and install in editable mode
git clone https://github.com/yusufkaraaslan/Skill_Seekers.git
cd Skill_Seekers
pip install -e .

# Use the unified CLI
skill-seekers scrape --config configs/react.json
```

--------------------------------

### Quick Reference Card - Setup and Verification

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/guides/MCP_SETUP.md

A concise reference for setting up the Skill Seekers project, verifying its installation, and generating skills. It includes commands for installation, configuration, and common verification checks.

```text
SETUP:
1. Install: pip install -e .
2. Configure: ./setup_mcp.sh
3. Restart agent

VERIFY:
- "List all available MCP tools" (should show 18 tools)
- "List all available configs" (should show 24 configs)

GENERATE SKILL:
1. "Generate config for [name] at [url]"
2. "Estimate pages for configs/[name].json"
3. "Scrape docs using configs/[name].json"
4. "Package skill at output/[name]/"

```

--------------------------------

### Verify Uvicorn Installation

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/guides/MCP_SETUP.md

Confirms that the 'uvicorn' module can be imported successfully. This verifies that uvicorn is installed and available for use by the HTTP server.

```python
python3 -c "import uvicorn; print('OK')"
```

--------------------------------

### Create and Use Custom Configuration

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/QUICKSTART.md

Demonstrates how to create a custom configuration file by copying an existing preset and then editing it. This allows for tailored scraping settings for specific projects.

```bash
# 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
```

--------------------------------

### Bash Command for Installing Package

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/guides/TESTING_GUIDE.md

Shows the bash command to install a Python package in editable mode, often used for development setups to resolve import errors.

```bash
# Install package in editable mode
pip install -e ".[all-llms,dev]"
```

--------------------------------

### Set up Python Virtual Environment and Install Dependencies

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/README.md

This section outlines the steps to clone the repository, create and activate a Python virtual environment, and install necessary project dependencies using pip. It also covers saving the installed dependencies to a requirements file.

```bash
# Clone repository
git clone https://github.com/yusufkaraaslan/Skill_Seekers.git
cd Skill_Seekers

# Create virtual environment
python3 -m venv venv

# Activate virtual environment
source venv/bin/activate  # macOS/Linux
# OR on Windows: venv\Scripts\activate

# Install dependencies
pip install requests beautifulsoup4 pytest

# Save dependencies
pip freeze > requirements.txt

# Optional: Install anthropic for API-based enhancement (not needed for LOCAL enhancement)
# pip install anthropic
```

--------------------------------

### Verify MCP Package Installation

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/guides/MCP_SETUP.md

Checks the installed version of the 'mcp' package. This ensures that the correct version is present and accessible in the Python environment.

```python
python3 -c "import mcp; print(mcp.__version__)"
# Should show: 1.25.0 or higher
```

--------------------------------

### AI Tutorial Grouping Strategy Example

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/features/HOW_TO_GUIDES.md

This demonstrates the command-line usage for the 'ai-tutorial-group' strategy, which intelligently groups workflows based on AI analysis for optimal topic organization. An example output structure is provided.

```bash
skill-seekers-how-to-guides examples.json --group-by ai-tutorial-group
```

--------------------------------

### Install Python Dependencies (Editable Mode)

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/guides/MCP_SETUP.md

Installs the Skill Seeker package and its dependencies in editable mode from the local repository. This is useful during development.

```bash
# Navigate to repository root
cd /path/to/Skill_Seekers

# Install package in editable mode (includes all dependencies)
pip install -e .
```

--------------------------------

### Skill Seekers Workflow Example

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/README.md

Demonstrates the complete workflow for using Skill Seekers, from scraping documentation to installing a skill on an agent. This process involves scraping, packaging, and installing skills.

```bash
# 1. Scrape documentation
skill-seekers scrape --config configs/react.json --enhance-local

# 2. Package skill
skill-seekers package output/react/

# 3. Install to your agent
skill-seekers install-agent output/react/ --agent cursor

# 4. Restart Cursor to load the skill

```

--------------------------------

### Clone Skill Seeker Repository

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/guides/MCP_SETUP.md

Clones the Skill Seeker repository from GitHub to your local machine. This is required for source installation and running the setup scripts.

```bash
git clone https://github.com/yusufkaraaslan/Skill_Seekers.git
cd Skill_Seekers
```

--------------------------------

### Complete Workflow: Install and Upload

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/FAQ.md

Installs a project for a specific target platform and uploads it. This command streamlines the process of preparing and deploying a project to an AI service.

```bash
skill-seekers install react --target claude --upload
```

--------------------------------

### Install MCP Package

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/guides/MCP_SETUP.md

Installs the 'mcp' package or its specific version range. This is required when the 'ModuleNotFoundError: No module named 'mcp'' error occurs.

```bash
# Install package
pip install -e .

# Or install dependencies manually
pip install "mcp>=1.25,<2" requests beautifulsoup4 uvicorn
```

--------------------------------

### Complete Workflow: Install Skills Across Platforms

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/reference/FEATURE_MATRIX.md

Illustrates a complete workflow for installing skills using the `skill-seekers install` command. It shows how to install skills for Claude (default), Gemini, OpenAI, and as a generic Markdown format, specifying the target platform with the `--target` flag.

```bash
# Install React skill for Claude (default)
skill-seekers install --config react

# Install Django skill for Gemini
skill-seekers install --config django --target gemini

# Install FastAPI skill for OpenAI
skill-seekers install --config fastapi --target openai

# Install Vue skill as generic markdown
skill-seekers install --config vue --target markdown
```

--------------------------------

### Install Specific Python Dependencies

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/guides/MCP_SETUP.md

Installs specific required Python packages for Skill Seeker manually. This includes the MCP SDK, FastMCP, uvicorn, requests, and beautifulsoup4.

```bash
pip install "mcp>=1.25,<2" requests beautifulsoup4 uvicorn
```

--------------------------------

### Quick Start Scraper and Enhancer

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/guides/USAGE.md

This bash command provides a quick start sequence for scraping and locally enhancing content. It first installs dependencies, then runs the scraper with enhancement enabled, and finally packages the result.

```bash
pip3 install requests beautifulsoup4
python3 cli/doc_scraper.py --config configs/react.json --enhance-local
python3 cli/package_skill.py output/react/
```

--------------------------------

### Verify MCP Server Installation

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/guides/MCP_SETUP.md

Tests the installation of the MCP server by attempting to run it in stdio mode with a timeout and checking for HTTP support. This helps confirm that the server is functional.

```bash
# Test stdio mode
timeout 3 python3 -m skill_seekers.mcp.server_fastmcp || echo "Server OK (timeout expected)"

# Test HTTP mode
python3 -c "import uvicorn; print('HTTP support available')"
```

--------------------------------

### Fetch Example Team Configuration (Bash)

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/README.md

Fetches a specific configuration named 'react-custom' from the 'example' source, which is configured to point to a local directory using a `file://` URL. This command is part of the end-to-end testing process for the example team repository.

```bash
fetch_config(source="example", config_name="react-custom")
```

--------------------------------

### Start HTTP Server with API Keys

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/guides/MCP_SETUP.md

Starts the HTTP MCP server after setting environment variables for API keys. This ensures that any requests made by the server to external services are authenticated.

```bash
export ANTHROPIC_API_KEY=sk-ant-your-key-here
export GITHUB_TOKEN=ghp_your-token-here
python -m skill_seekers.mcp.server_fastmcp --http --port 3000
```

--------------------------------

### Install Uvicorn for HTTP Server

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/guides/MCP_SETUP.md

Installs the 'uvicorn' package, which is necessary for running the Skill Seekers MCP server with the HTTP transport. This resolves 'ModuleNotFoundError: No module named 'uvicorn''.

```bash
# Install uvicorn
pip install uvicorn

# Or install with extras
pip install -e ".[mcp]"
```

--------------------------------

### Fetch Configuration with Source and Name (Enterprise Bash Example)

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/README.md

Shows how developers can fetch configurations after sources have been pre-configured. The `fetch_config` command intelligently resolves which source to use based on the `config_name` and the defined priorities, simplifying configuration management for large organizations.

```bash
fetch_config(config_name="internal-platform")  # Finds in platform source
fetch_config(config_name="react")              # Falls back to official API
```

--------------------------------

### Test Git-Based Config Sources with an Example Repository

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/reference/GIT_CONFIG_SOURCES.md

This example demonstrates how to test the Git-based configuration system by adding a local directory as a Git source and then fetching a configuration. It also includes instructions for running an end-to-end test script.

```bash
cd /path/to/Skill_Seekers

# Run E2E test
python3 configs/example-team/test_e2e.py

# Or test manually
add_config_source(
    name="example",
    git_url="file://$(pwd)/configs/example-team",
    branch="master"
)

fetch_config(source="example", config_name="react-custom")
```

--------------------------------

### Install Skill Seekers Package with MCP Dependencies

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/guides/MCP_SETUP.md

Installs the Skill Seekers package in editable mode, including necessary MCP dependencies. This is essential for resolving 'ModuleNotFoundError' and enabling MCP functionality.

```bash
# Navigate to Skill Seekers directory
cd /path/to/Skill_Seekers

# Install package with MCP dependencies
pip3 install -e ".[mcp]"
```

--------------------------------

### Add Multiple Configuration Sources (Enterprise Bash Example)

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/README.md

Illustrates how an IT department can pre-configure multiple configuration sources for an enterprise environment using `add_config_source`. This allows for centralized management and priority-based resolution of configurations across different teams or projects.

```bash
# IT pre-configures sources for everyone
add_config_source(name="platform", git_url="gitlab.company.com/platform/configs", priority=1)
add_config_source(name="mobile", git_url="gitlab.company.com/mobile/configs", priority=2)
add_config_source(name="official", git_url="api.skillseekersweb.com", priority=3)
```

--------------------------------

### Run All How-To Guide Tests (Bash)

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/features/HOW_TO_GUIDES.md

Executes the entire test suite for the how-to guide builder component using pytest, reporting verbose output.

```bash
# All how-to guide tests (21 tests)
pytest tests/test_how_to_guide_builder.py -v
```

--------------------------------

### Start HTTP Server (Python)

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/guides/MCP_SETUP.md

Starts the Skill Seeker HTTP server on a specified port. This is necessary for HTTP agents to connect. You can specify the host and port, defaulting to localhost and port 3000.

```bash
# Start HTTP server on port 3000
python -m skill_seekers.mcp.server_fastmcp --http --port 3000

# Or use custom host/port
python -m skill_seekers.mcp.server_fastmcp --http --host 0.0.0.0 --port 8080
```

--------------------------------

### Virtual Environment vs System Install for Skill Seekers

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/guides/MULTI_AGENT_SETUP.md

Compares the setup and usage of skill_seekers within a virtual environment versus a global system installation. It highlights the recommended approach and shows how commands and configurations differ.

```bash
# Virtual Environment (Recommended):
./setup_mcp.sh

# Config uses Python module execution
"command": "python",
"args": ["-m", "skill_seekers.mcp.server_fastmcp"]

# System Install:
# Install globally via pip
pip install skill-seekers

# Config uses CLI command
"command": "skill-seekers",
"args": ["mcp"]
```

--------------------------------

### Install Skill for Specific Platform

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/README.md

Examples of using the `skill-seekers install` command to create and upload skills for a specific target platform.

```bash
# Install for specific platform
skill-seekers install --config django --target gemini
skill-seekers install --config fastapi --target openai
```

--------------------------------

### Use Skill Seekers Presets for Scraping

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/README.md

Demonstrates how to use predefined configuration files to scrape documentation for various presets like Godot or React. It also shows how to list available configuration files.

```bash
# Make sure venv is activated (you should see (venv) in your prompt)
source venv/bin/activate

# Optional: Estimate pages first (fast, 1-2 minutes)
skill-seekers estimate configs/godot.json

# Use Godot preset
skill-seekers scrape --config configs/godot.json

# Use React preset
skill-seekers scrape --config configs/react.json

# See all presets
ls configs/
```

--------------------------------

### Example User Prompts for Skill Generation

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/guides/MCP_SETUP.md

Provides example user commands to interact with the AI coding agent for skill generation tasks. These commands cover listing configurations, scraping documentation, and packaging skills.

```text
User: List all available configs
User: Scrape docs using configs/react.json with max 50 pages
User: Package skill at output/react/

```

--------------------------------

### Use Simpler Grouping Strategy (Bash)

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/features/HOW_TO_GUIDES.md

Command-line instruction to group generated guides by file path, which is a faster alternative to AI-based grouping strategies.

```bash
# file-path is faster than ai-tutorial-group
skill-seekers-how-to-guides examples.json --group-by file-path
```

--------------------------------

### Start skill_seekers HTTP Server (Bash)

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/guides/MCP_SETUP.md

Starts the skill_seekers MCP server as an HTTP server. This command can be used with various agents that support HTTP transport. It allows specifying the port, host, and log level for the server.

```bash
# Terminal 1 - Run HTTP server
python -m skill_seekers.mcp.server_fastmcp --http --port 3000

# Should show:
# INFO: Started server process
# INFO: Uvicorn running on http://127.0.0.1:3000
```

```bash
# Terminal 1 - Run HTTP server
python -m skill_seekers.mcp.server_fastmcp --http --port 3001

# Use different port if Cursor is using 3000
```

```bash
# Terminal 1 - Run HTTP server
python -m skill_seekers.mcp.server_fastmcp --http --port 3002
```

```bash
# Default (port 8000)
python -m skill_seekers.mcp.server_fastmcp --http

# Custom port
python -m skill_seekers.mcp.server_fastmcp --http --port 3000

# Custom host and port
python -m skill_seekers.mcp.server_fastmcp --http --host 0.0.0.0 --port 8080

# Debug mode
python -m skill_seekers.mcp.server_fastmcp --http --log-level DEBUG
```

--------------------------------

### Start HTTP MCP Server

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/guides/MCP_SETUP.md

Starts the MCP server using HTTP, making it accessible via a specified port. This configuration is used by agents like Cursor, Windsurf, and IntelliJ. It requires the server to be running before agents can connect.

```bash
python -m skill_seekers.mcp.server_fastmcp --http --port 3000
```

--------------------------------

### Legacy CLI Installation and Usage

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/README.md

Provides steps for installing dependencies and running scripts using the older, legacy CLI method for backwards compatibility.

```bash
# Install dependencies
pip3 install requests beautifulsoup4

# Run scripts directly (old method)
python3 src/skill_seekers/cli/doc_scraper.py --config configs/react.json

# Upload output/react.zip to Claude - Done!
```

--------------------------------

### Run Auto-Configuration Script

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/guides/MCP_SETUP.md

Executes a shell script to automatically detect and configure installed AI coding agents for Skill Seeker MCP. This script handles dependency installation, agent detection, and configuration for both stdio and HTTP agents.

```bash
# Navigate to repository
cd /path/to/Skill_Seekers

# Run setup script
./setup_mcp.sh
```

--------------------------------

### Verify Python Version

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/guides/MCP_SETUP.md

Checks if the installed Python version meets the minimum requirement of 3.10 or higher. This is a prerequisite for running Skill Seeker.

```bash
python3 --version
# Should show: Python 3.10.x or higher
```

--------------------------------

### Generate How-To Guides with Grouping Strategy

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/features/HOW_TO_GUIDES.md

This bash command generates how-to guides from example files, allowing specification of a grouping strategy. The `--group-by ai-tutorial-group` option uses AI for more intelligent grouping, while `file-path` uses the file structure.

```bash
skill-seekers-how-to-guides examples.json  # AI enabled by default
skill-seekers-how-to-guides examples.json --group-by ai-tutorial-group
skill-seekers-how-to-guides examples.json --group-by file-path
```

--------------------------------

### HTTP Transport Mode

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/guides/MCP_SETUP.md

Instructions for using the HTTP transport mode for the Skill Seekers MCP server, including starting the server and testing endpoints.

```APIDOC
## HTTP Transport (New)

### Description
Instructions for using the HTTP transport mode for the Skill Seekers MCP server, including starting the server and testing endpoints. This mode allows multiple agents to share a single server and is easier to debug.

### Method
N/A (Usage Guide)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A

### How it works
- MCP server runs as an HTTP server.
- Agents connect via SSE (Server-Sent Events).
- A single server can support multiple agents.

### Advantages
- Multiple agents can share one server.
- Easier debugging (can test with `curl`).
- Production-ready with `uvicorn`.

### Usage
**Step 1: Start HTTP Server**

```bash
# Default (port 8000)
python -m skill_seekers.mcp.server_fastmcp --http

# Custom port
python -m skill_seekers.mcp.server_fastmcp --http --port 3000

# Custom host and port
python -m skill_seekers.mcp.server_fastmcp --http --host 0.0.0.0 --port 8080

# Debug mode
python -m skill_seekers.mcp.server_fastmcp --http --log-level DEBUG
```

**Step 2: Configure Agent**

```json
{
  "url": "http://localhost:8000/sse"
}
```

**Step 3: Test Endpoints**

```bash
# Health check
curl http://localhost:8000/health
# Returns: {"status": "ok"}

# SSE endpoint (agent connects here)
curl http://localhost:8000/sse
# Returns SSE stream
```
```

--------------------------------

### Running Skill Seekers for Godot and React

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/README.md

Example commands to initiate the scraping and skill generation process for the Godot and React documentation using their respective configuration files, or to start in interactive mode.

```bash
# Try Godot
skill-seekers scrape --config configs/godot.json

# Try React
skill-seekers scrape --config configs/react.json

# Or go interactive
skill-seekers scrape --interactive
```

--------------------------------

### Get Current Directory Path

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/guides/MCP_SETUP.md

Prints the absolute path of the current working directory. This is useful for noting the repository path needed for manual configuration.

```bash
# Get absolute path
pwd

# Example output: /Users/username/Projects/Skill_Seekers
# or: /home/username/Skill_Seekers
```

--------------------------------

### Markdown Guide Header Example

Source: https://github.com/yusufkaraaslan/skill_seekers/blob/development/docs/features/HOW_TO_GUIDES.md

An example of the header section for a generated markdown guide. It includes the title, difficulty level, estimated time, and relevant tags for the workflow.

```markdown
# How To: Create and Save User to Database

**Difficulty**: Beginner
**Estimated Time**: 10 minutes
**Tags**: user, database, create
```
Tokens:
Raw