From 5a78522dbc635d6f30f5e5c92533f6b8c9091331 Mon Sep 17 00:00:00 2001 From: yusyus Date: Thu, 29 Jan 2026 22:56:33 +0300 Subject: [PATCH] docs: Update all documentation to use new 'analyze' command - Update Chinese README (README.zh-CN.md) with new preset flags - Update docs/features/*.md (PATTERN_DETECTION, HOW_TO_GUIDES, BOOTSTRAP_SKILL_TECHNICAL) - Update scripts/bootstrap_skill.sh to use 'skill-seekers analyze' - Update scripts/skill_header.md command examples - Update tests/test_bootstrap_skill.py assertions - Fix CHANGELOG.md historical entry with correct command name All references to 'skill-seekers-codebase' updated to 'skill-seekers analyze' except where needed for backward compatibility (pyproject.toml, E2E tests). Related to Phase 1 implementation from previous commits. --- CHANGELOG.md | 2 +- README.zh-CN.md | 16 ++++++------- docs/features/BOOTSTRAP_SKILL_TECHNICAL.md | 2 +- docs/features/HOW_TO_GUIDES.md | 26 +++++++++++----------- docs/features/PATTERN_DETECTION.md | 4 ++-- scripts/bootstrap_skill.sh | 6 ++--- scripts/skill_header.md | 4 ++-- tests/test_bootstrap_skill.py | 2 +- 8 files changed, 30 insertions(+), 32 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8ad6d84..a17267d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -530,7 +530,7 @@ This **minor feature release** completes the C3.x codebase analysis suite with s - Includes language statistics, analysis depth indicators, and feature checkboxes - Creates references/ directory with organized outputs (API, dependencies, patterns, architecture, config) - Integration points: - - CLI tool: `skill-seekers-codebase-scraper --directory /path/to/code --output /path/to/output` + - CLI tool: `skill-seekers analyze --directory /path/to/code --output /path/to/output` - Unified scraper: Automatic SKILL.md generation when using codebase analysis - Format helpers for all C3.x sections (patterns, examples, API, architecture, config) - Perfect for local codebase documentation without GitHub diff --git a/README.zh-CN.md b/README.zh-CN.md index b295fb5..dcd9e5f 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -305,17 +305,17 @@ ls ~/.claude/skills/skill-seekers/SKILL.md **用法：** ```bash -# AUTO 模式（默认）- 自动检测最佳选项 -skill-seekers-codebase tests/ --build-how-to-guides --ai-mode auto +# 快速分析（1-2 分钟，基础功能） +skill-seekers analyze --directory tests/ --quick -# API 模式 - 快速、高效（需要 ANTHROPIC_API_KEY） -skill-seekers-codebase tests/ --build-how-to-guides --ai-mode api +# 综合分析（20-60 分钟，所有功能 + AI） +skill-seekers analyze --directory tests/ --comprehensive -# LOCAL 模式 - 使用 Claude Code Max 免费（无需 API 密钥） -skill-seekers-codebase tests/ --build-how-to-guides --ai-mode local +# 启用 AI 增强（自动检测 API 或 LOCAL） +skill-seekers analyze --directory tests/ --enhance -# 禁用增强 - 仅基础指南 -skill-seekers-codebase tests/ --build-how-to-guides --ai-mode none +# 自定义：禁用特定功能 +skill-seekers analyze --directory tests/ --skip-how-to-guides ``` **完整文档：**[docs/HOW_TO_GUIDES.md](docs/HOW_TO_GUIDES.md#ai-enhancement-new) diff --git a/docs/features/BOOTSTRAP_SKILL_TECHNICAL.md b/docs/features/BOOTSTRAP_SKILL_TECHNICAL.md index d7fb60e..309d729 100644 --- a/docs/features/BOOTSTRAP_SKILL_TECHNICAL.md +++ b/docs/features/BOOTSTRAP_SKILL_TECHNICAL.md @@ -148,7 +148,7 @@ Fails fast with helpful installation instructions. **Step 2: Codebase Analysis (lines 37-45)** ```bash rm -rf "$OUTPUT_DIR" 2>/dev/null || true -uv run skill-seekers-codebase \ +uv run skill-seekers analyze \ --directory "$PROJECT_ROOT" \ --output "$OUTPUT_DIR" \ --depth deep \ diff --git a/docs/features/HOW_TO_GUIDES.md b/docs/features/HOW_TO_GUIDES.md index 90c63aa..18ede21 100644 --- a/docs/features/HOW_TO_GUIDES.md +++ b/docs/features/HOW_TO_GUIDES.md @@ -31,7 +31,7 @@ First, extract workflow examples from your test files: ```bash # Extract test examples including workflows -skill-seekers-codebase tests/ \ +skill-seekers analyze tests/ \ --extract-test-examples \ --output output/codebase/ @@ -64,13 +64,13 @@ Enable guide generation during codebase analysis: ```bash # Automatic pipeline: extract tests → build guides -skill-seekers-codebase tests/ \ +skill-seekers analyze tests/ \ --extract-test-examples \ --build-how-to-guides \ --output output/codebase/ # Skip guide generation -skill-seekers-codebase tests/ \ +skill-seekers analyze tests/ \ --skip-how-to-guides ``` @@ -284,7 +284,7 @@ AI enhancement happens automatically with AUTO mode detection: ```bash # Auto-detects best mode (API if key set, else LOCAL) -skill-seekers-codebase tests/ \ +skill-seekers analyze tests/ \ --extract-test-examples \ --build-how-to-guides \ --ai-mode auto @@ -299,7 +299,7 @@ Use Claude API directly (requires ANTHROPIC_API_KEY): export ANTHROPIC_API_KEY=sk-ant-... # Enable API mode -skill-seekers-codebase tests/ \ +skill-seekers analyze tests/ \ --build-how-to-guides \ --ai-mode api ``` @@ -316,7 +316,7 @@ Use Claude Code CLI (no API key needed): ```bash # Uses your Claude Code Max plan (FREE!) -skill-seekers-codebase tests/ \ +skill-seekers analyze tests/ \ --build-how-to-guides \ --ai-mode local ``` @@ -334,7 +334,7 @@ Generate basic guides without AI: ```bash # Faster, but basic quality -skill-seekers-codebase tests/ \ +skill-seekers analyze tests/ \ --build-how-to-guides \ --ai-mode none ``` @@ -358,7 +358,7 @@ skill-seekers-codebase tests/ \ ```bash # 1. Extract test examples from your codebase -skill-seekers-codebase tests/ \ +skill-seekers analyze tests/ \ --extract-test-examples \ --output output/codebase/ @@ -401,7 +401,7 @@ which claude **Issue: Enhancement takes too long** ```bash # Switch to API mode for faster processing -skill-seekers-codebase tests/ \ +skill-seekers analyze tests/ \ --build-how-to-guides \ --ai-mode api # Much faster than LOCAL @@ -873,7 +873,7 @@ How-to guides are built from workflow examples extracted by C3.2: ```bash # Full pipeline -skill-seekers-codebase tests/ \ +skill-seekers analyze tests/ \ --extract-test-examples \ --build-how-to-guides ``` @@ -907,7 +907,7 @@ skill-seekers-how-to-guides examples.json --no-ai Automatic guide generation during codebase analysis: ```bash -skill-seekers-codebase /path/to/repo/ \ +skill-seekers analyze /path/to/repo/ \ --extract-test-examples \ --build-how-to-guides \ --output output/codebase/ @@ -946,7 +946,7 @@ skill-seekers-how-to-guides tests/integration/test_examples.json \ Extract usage patterns from test suites: ```bash -skill-seekers-codebase tests/api/ \ +skill-seekers analyze tests/api/ \ --extract-test-examples \ --build-how-to-guides ``` @@ -1375,7 +1375,7 @@ pytest tests/test_how_to_guide_builder.py --cov=skill_seekers.cli.how_to_guide_b **Get Started:** ```bash # Quick start -skill-seekers-codebase tests/ --output output/codebase/ +skill-seekers analyze tests/ --output output/codebase/ # Check your new guides cat output/codebase/tutorials/index.md diff --git a/docs/features/PATTERN_DETECTION.md b/docs/features/PATTERN_DETECTION.md index 06655e2..aefa787 100644 --- a/docs/features/PATTERN_DETECTION.md +++ b/docs/features/PATTERN_DETECTION.md @@ -119,10 +119,10 @@ The `--detect-patterns` flag integrates with codebase analysis: ```bash # Analyze codebase + detect patterns -skill-seekers-codebase --directory src/ --detect-patterns +skill-seekers analyze --directory src/ --detect-patterns # With other features -skill-seekers-codebase \ +skill-seekers analyze \ --directory src/ \ --detect-patterns \ --build-api-reference \ diff --git a/scripts/bootstrap_skill.sh b/scripts/bootstrap_skill.sh index 04f6f2e..0496b79 100755 --- a/scripts/bootstrap_skill.sh +++ b/scripts/bootstrap_skill.sh @@ -37,11 +37,9 @@ echo "✓ Done" # Step 2: Run codebase analysis echo "Step 2: Analyzing codebase..." rm -rf "$OUTPUT_DIR" 2>/dev/null || true -uv run skill-seekers-codebase \ +uv run skill-seekers analyze \ --directory "$PROJECT_ROOT" \ - --output "$OUTPUT_DIR" \ - --depth deep \ - --ai-mode none 2>&1 | grep -E "^(INFO|✅)" || true + --output "$OUTPUT_DIR" 2>&1 | grep -E "^(INFO|✅)" || true echo "✓ Done" # Step 3: Prepend header to SKILL.md diff --git a/scripts/skill_header.md b/scripts/skill_header.md index ce2bfb3..d2d8d02 100644 --- a/scripts/skill_header.md +++ b/scripts/skill_header.md @@ -16,7 +16,7 @@ pip install skill-seekers | Source | Command | |--------|---------| -| Local code | `skill-seekers-codebase --directory ./path` | +| Local code | `skill-seekers analyze --directory ./path` | | Docs URL | `skill-seekers scrape --url https://...` | | GitHub | `skill-seekers github --repo owner/repo` | | PDF | `skill-seekers pdf --file doc.pdf` | @@ -25,7 +25,7 @@ pip install skill-seekers ```bash # Analyze local codebase -skill-seekers-codebase --directory /path/to/project --output output/my-skill/ +skill-seekers analyze --directory /path/to/project --output output/my-skill/ # Package for Claude yes | skill-seekers package output/my-skill/ --no-open diff --git a/tests/test_bootstrap_skill.py b/tests/test_bootstrap_skill.py index 62e1a78..330f462 100644 --- a/tests/test_bootstrap_skill.py +++ b/tests/test_bootstrap_skill.py @@ -37,7 +37,7 @@ class TestBootstrapSkillScript: # Must have commands table assert "## Commands" in content, "Header must have Commands section" - assert "skill-seekers-codebase" in content, "Header must mention codebase command" + assert "skill-seekers analyze" in content, "Header must mention analyze command" assert "skill-seekers scrape" in content, "Header must mention scrape command" assert "skill-seekers github" in content, "Header must mention github command"