External/SuperClaude
1
0
Fork 0
mirror of https://github.com/SuperClaude-Org/SuperClaude_Framework.git synced 2025-12-29 16:16:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: comprehensive framework improvements (#447)

Browse Source 
* refactor(docs): move core docs into framework/business/research (move-only)

- framework/: principles, rules, flags (思想・行動規範)
- business/: symbols, examples (ビジネス領域)
- research/: config (調査設定)
- All files renamed to lowercase for consistency

* docs: update references to new directory structure

- Update ~/.claude/CLAUDE.md with new paths
- Add migration notice in core/MOVED.md
- Remove pm.md.backup
- All @superclaude/ references now point to framework/business/research/

* fix(setup): update framework_docs to use new directory structure

- Add validate_prerequisites() override for multi-directory validation
- Add _get_source_dirs() for framework/business/research directories
- Override _discover_component_files() for multi-directory discovery
- Override get_files_to_install() for relative path handling
- Fix get_size_estimate() to use get_files_to_install()
- Fix uninstall/update/validate to use install_component_subdir

Fixes installation validation errors for new directory structure.

Tested: make dev installs successfully with new structure
  - framework/: flags.md, principles.md, rules.md
  - business/: examples.md, symbols.md
  - research/: config.md

* refactor(modes): update component references for docs restructure

* chore: remove redundant docs after PLANNING.md migration

Cleanup after Self-Improvement Loop implementation:

**Deleted (21 files, ~210KB)**:
- docs/Development/ - All content migrated to PLANNING.md & TASK.md
  * ARCHITECTURE.md (15KB) → PLANNING.md
  * TASKS.md (3.7KB) → TASK.md
  * ROADMAP.md (11KB) → TASK.md
  * PROJECT_STATUS.md (4.2KB) → outdated
  * 13 PM Agent research files → archived in KNOWLEDGE.md
- docs/PM_AGENT.md - Old implementation status
- docs/pm-agent-implementation-status.md - Duplicate
- docs/templates/ - Empty directory

**Retained (valuable documentation)**:
- docs/memory/ - Active session metrics & context
- docs/patterns/ - Reusable patterns
- docs/research/ - Research reports
- docs/user-guide*/ - User documentation (4 languages)
- docs/reference/ - Reference materials
- docs/getting-started/ - Quick start guides
- docs/agents/ - Agent-specific guides
- docs/testing/ - Test procedures

**Result**:
- Eliminated redundancy after Root Documents consolidation
- Preserved all valuable content in PLANNING.md, TASK.md, KNOWLEDGE.md
- Maintained user-facing documentation structure

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* refactor: relocate PM modules to commands/modules

- Move modules to superclaude/commands/modules/
- Organize command-specific modules under commands/

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* feat: add self-improvement loop with 4 root documents

Implements Self-Improvement Loop based on Cursor's proven patterns:

**New Root Documents**:
- PLANNING.md: Architecture, design principles, 10 absolute rules
- TASK.md: Current tasks with priority (🔴🟡🟢⚪)
- KNOWLEDGE.md: Accumulated insights, best practices, failures
- README.md: Updated with developer documentation links

**Key Features**:
- Session Start Protocol: Read docs → Git status → Token budget → Ready
- Evidence-Based Development: No guessing, always verify
- Parallel Execution Default: Wave → Checkpoint → Wave pattern
- Mac Environment Protection: Docker-first, no host pollution
- Failure Pattern Learning: Past mistakes become prevention rules

**Cleanup**:
- Removed: docs/memory/checkpoint.json, current_plan.json (migrated to TASK.md)
- Enhanced: setup/components/commands.py (module discovery)

**Benefits**:
- LLM reads rules at session start → consistent quality
- Past failures documented → no repeats
- Progressive knowledge accumulation → continuous improvement
- 3.5x faster execution with parallel patterns

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* test: validate Self-Improvement Loop workflow

Tested complete cycle: Read docs → Extract rules → Execute task → Update docs

Test Results:
- Session Start Protocol: ✅ All 6 steps successful
- Rule Extraction: ✅ 10/10 absolute rules identified from PLANNING.md
- Task Identification: ✅ Next tasks identified from TASK.md
- Knowledge Application: ✅ Failure patterns accessed from KNOWLEDGE.md
- Documentation Update: ✅ TASK.md and KNOWLEDGE.md updated with completed work
- Confidence Score: 95% (exceeds 70% threshold)

Proved Self-Improvement Loop closes: Execute → Learn → Update → Improve

* refactor: responsibility-driven component architecture

Rename components to reflect their responsibilities:
- framework_docs.py → knowledge_base.py (KnowledgeBaseComponent)
- modes.py → behavior_modes.py (BehaviorModesComponent)
- agents.py → agent_personas.py (AgentPersonasComponent)
- commands.py → slash_commands.py (SlashCommandsComponent)
- mcp.py → mcp_integration.py (MCPIntegrationComponent)

Each component now clearly documents its responsibility:
- knowledge_base: Framework knowledge initialization
- behavior_modes: Execution mode definitions
- agent_personas: AI agent personality definitions
- slash_commands: CLI command registration
- mcp_integration: External tool integration

Benefits:
- Self-documenting architecture
- Clear responsibility boundaries
- Easy to navigate and extend
- Scalable for future hierarchical organization

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* docs: add project-specific CLAUDE.md with UV rules

- Document UV as required Python package manager
- Add common operations and integration examples
- Document project structure and component architecture
- Provide development workflow guidelines

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* fix: resolve installation failures after framework_docs rename

## Problems Fixed
1. **Syntax errors**: Duplicate docstrings in all component files (line 1)
2. **Dependency mismatch**: Stale framework_docs references after rename to knowledge_base

## Changes
- Fix docstring format in all component files (behavior_modes, agent_personas, slash_commands, mcp_integration)
- Update all dependency references: framework_docs → knowledge_base
- Update component registration calls in knowledge_base.py (5 locations)
- Update install.py files in both setup/ and superclaude/ (5 locations total)
- Fix documentation links in README-ja.md and README-zh.md

## Verification
✅ All components load successfully without syntax errors
✅ Dependency resolution works correctly
✅ Installation completes in 0.5s with all validations passing
✅ make dev succeeds

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* feat: add automated README translation workflow

## New Features
- **Auto-translation workflow** using GPT-Translate
- Automatically translates README.md to Chinese (ZH) and Japanese (JA)
- Triggers on README.md changes to master/main branches
- Cost-effective: ~¥90/month for typical usage

## Implementation Details
- Uses OpenAI GPT-4 for high-quality translations
- GitHub Actions integration with gpt-translate@v1.1.11
- Secure API key management via GitHub Secrets
- Automatic commit and PR creation on translation updates

## Files Added
- `.github/workflows/translation-sync.yml` - Auto-translation workflow
- `docs/Development/translation-workflow.md` - Setup guide and documentation

## Setup Required
Add `OPENAI_API_KEY` to GitHub repository secrets to enable auto-translation.

## Benefits
- 🤖 Automated translation on every README update
- 💰 Low cost (~$0.06 per translation)
- 🛡️ Secure API key storage
- 🔄 Consistent translation quality across languages

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* fix(mcp): update airis-mcp-gateway URL to correct organization

Fixes #440

## Problem
Code referenced non-existent `oraios/airis-mcp-gateway` repository,
causing MCP installation to fail completely.

## Root Cause
- Repository was moved to organization: `agiletec-inc/airis-mcp-gateway`
- Old reference `oraios/airis-mcp-gateway` no longer exists
- Users reported "not a python/uv module" error

## Changes
- Update install_command URL: oraios → agiletec-inc
- Update run_command URL: oraios → agiletec-inc
- Location: setup/components/mcp_integration.py lines 37-38

## Verification
✅ Correct URL now references active repository
✅ MCP installation will succeed with proper organization
✅ No other code references oraios/airis-mcp-gateway

## Related Issues
- Fixes #440 (Airis-mcp-gateway url has changed)
- Related to #442 (MCP update issues)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* feat: replace cloud translation with local Neural CLI

## Changes

### Removed (OpenAI-dependent)
- ❌ `.github/workflows/translation-sync.yml` - GPT-Translate workflow
- ❌ `docs/Development/translation-workflow.md` - OpenAI setup docs

### Added (Local Ollama-based)
- ✅ `Makefile`: New `make translate` target using Neural CLI
- ✅ `docs/Development/translation-guide.md` - Neural CLI guide

## Benefits

**Before (GPT-Translate)**:
- 💰 Monthly cost: ~¥90 (OpenAI API)
- 🔑 Requires API key setup
- 🌐 Data sent to external API
- ⏱️ Network latency

**After (Neural CLI)**:
- ✅ **$0 cost** - Fully local execution
- ✅ **No API keys** - Zero setup friction
- ✅ **Privacy** - No external data transfer
- ✅ **Fast** - ~1-2 min per README
- ✅ **Offline capable** - Works without internet

## Technical Details

**Neural CLI**:
- Built in Rust with Tauri
- Uses Ollama + qwen2.5:3b model
- Binary size: 4.0MB
- Auto-installs to ~/.local/bin/

**Usage**:
```bash
make translate  # Translates README.md → README-zh.md, README-ja.md
```

## Requirements

- Ollama installed: `curl -fsSL https://ollama.com/install.sh | sh`
- Model downloaded: `ollama pull qwen2.5:3b`
- Neural CLI built: `cd ~/github/neural/src-tauri && cargo build --bin neural-cli --release`

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

---------

Co-authored-by: kazuki <kazuki@kazukinoMacBook-Air.local>
Co-authored-by: Claude <noreply@anthropic.com>
This commit is contained in:
kazuki nakai
2025-10-18 23:58:10 +09:00
committed by GitHub
parent 882a0d8356
commit 00706f0ea9
52 changed files with 3277 additions and 6487 deletions
Download Patch File Download Diff File Expand all files Collapse all files

378
docs/Development/installation-flow-understanding.md
View File

@@ -1,378 +0,0 @@
# SuperClaude Installation Flow - Complete Understanding
> **学習内容**: インストーラーがどうやって `~/.claude/` にファイルを配置するかの完全理解
---
## 🔄 インストールフロー全体像
### ユーザー操作
```bash
# Step 1: パッケージインストール
pipx install SuperClaude
# または
npm install -g @bifrost_inc/superclaude
# Step 2: セットアップ実行
SuperClaude install
```
### 内部処理の流れ
```yaml
1. Entry Point:
File: superclaude/__main__.py → main()
2. CLI Parser:
File: superclaude/__main__.py → create_parser()
Command: "install" サブコマンド登録
3. Component Manager:
File: setup/cli/install.py
Role: インストールコンポーネントの調整
4. Commands Component:
File: setup/components/commands.py → CommandsComponent
Role: スラッシュコマンドのインストール
5. Source Files:
Location: superclaude/commands/*.md
Content: pm.md, implement.md, test.md, etc.
6. Destination:
Location: ~/.claude/commands/sc/*.md
Result: ユーザー環境に配置
```
---
## 📁 CommandsComponent の詳細
### クラス構造
```python
class CommandsComponent(Component):
"""
Role: スラッシュコマンドのインストール・管理
Parent: setup/core/base.py → Component
Install Path: ~/.claude/commands/sc/
"""
```
### 主要メソッド
#### 1. `__init__()`
```python
def __init__(self, install_dir: Optional[Path] = None):
super().__init__(install_dir, Path("commands/sc"))
```
**理解**:
- `install_dir`: `~/.claude/` （ユーザー環境）
- `Path("commands/sc")`: サブディレクトリ指定
- 結果: `~/.claude/commands/sc/` にインストール
#### 2. `_get_source_dir()`
```python
def _get_source_dir(self) -> Path:
# setup/components/commands.py の位置から計算
project_root = Path(__file__).parent.parent.parent
# → ~/github/SuperClaude_Framework/
return project_root / "superclaude" / "commands"
# → ~/github/SuperClaude_Framework/superclaude/commands/
```
**理解**:
```
Source: ~/github/SuperClaude_Framework/superclaude/commands/*.md
Target: ~/.claude/commands/sc/*.md
つまり:
superclaude/commands/pm.md
↓ コピー
~/.claude/commands/sc/pm.md
```
#### 3. `_install()` - インストール実行
```python
def _install(self, config: Dict[str, Any]) -> bool:
self.logger.info("Installing SuperClaude command definitions...")
# 既存コマンドのマイグレーション
self._migrate_existing_commands()
# 親クラスのインストール実行
return super()._install(config)
```
**理解**:
1. ログ出力
2. 旧バージョンからの移行処理
3. 実際のファイルコピー（親クラスで実行）
#### 4. `_migrate_existing_commands()` - マイグレーション
```python
def _migrate_existing_commands(self) -> None:
"""
旧Location: ~/.claude/commands/*.md
新Location: ~/.claude/commands/sc/*.md
V3 → V4 移行時の処理
"""
old_commands_dir = self.install_dir / "commands"
new_commands_dir = self.install_dir / "commands" / "sc"
# 旧場所からファイル検出
# 新場所へコピー
# 旧場所から削除
```
**理解**:
- V3: `/analyze` → V4: `/sc:analyze`
- 名前空間衝突を防ぐため `/sc:` プレフィックス
#### 5. `_post_install()` - メタデータ更新
```python
def _post_install(self) -> bool:
# メタデータ更新
metadata_mods = self.get_metadata_modifications()
self.settings_manager.update_metadata(metadata_mods)
# コンポーネント登録
self.settings_manager.add_component_registration(
"commands",
{
"version": __version__,
"category": "commands",
"files_count": len(self.component_files),
},
)
```
**理解**:
- `~/.claude/.superclaude.json` 更新
- インストール済みコンポーネント記録
- バージョン管理
---
## 📋 実際のファイルマッピング
### Source（このプロジェクト）
```
~/github/SuperClaude_Framework/superclaude/commands/
├── pm.md # PM Agent定義
├── implement.md # Implement コマンド
├── test.md # Test コマンド
├── analyze.md # Analyze コマンド
├── research.md # Research コマンド
├── ...（全26コマンド）
```
### Destination（ユーザー環境）
```
~/.claude/commands/sc/
├── pm.md # → /sc:pm で実行可能
├── implement.md # → /sc:implement で実行可能
├── test.md # → /sc:test で実行可能
├── analyze.md # → /sc:analyze で実行可能
├── research.md # → /sc:research で実行可能
├── ...（全26コマンド）
```
### Claude Code動作
```
User: /sc:pm "Build authentication"
Claude Code:
1. ~/.claude/commands/sc/pm.md 読み込み
2. YAML frontmatter 解析
3. Markdown本文を展開
4. PM Agent として実行
```
---
## 🔧 他のコンポーネント
### Modes Component
```python
File: setup/components/modes.py
Source: superclaude/modes/*.md
Target: ~/.claude/*.md
Example:
superclaude/modes/MODE_Brainstorming.md
↓
~/.claude/MODE_Brainstorming.md
```
### Agents Component
```python
File: setup/components/agents.py
Source: superclaude/agents/*.md
Target: ~/.claude/agents/*.md（または統合先）
```
### Core Component
```python
File: setup/components/core.py
Source: superclaude/core/CLAUDE.md
Target: ~/.claude/CLAUDE.md
これがグローバル設定！
```
---
## 💡 開発時の注意点
### ✅ 正しい変更方法
```bash
# 1. ソースファイルを変更（Git管理）
cd ~/github/SuperClaude_Framework
vim superclaude/commands/pm.md
# 2. テスト追加
Write tests/test_pm_command.py
# 3. テスト実行
pytest tests/test_pm_command.py -v
# 4. コミット
git add superclaude/commands/pm.md tests/
git commit -m "feat: enhance PM command"
# 5. 開発版インストール
pip install -e .
# または
SuperClaude install --dev
# 6. 動作確認
claude
/sc:pm "test"
```
### ❌ 間違った変更方法
```bash
# ダメ！Git管理外を直接変更
vim ~/.claude/commands/sc/pm.md
# 変更は次回インストール時に上書きされる
SuperClaude install # ← 変更が消える！
```
---
## 🎯 PM Mode改善の正しいフロー
### Phase 1: 理解（今ここ！）
```bash
✅ setup/components/commands.py 理解完了
✅ superclaude/commands/*.md の存在確認完了
✅ インストールフロー理解完了
```
### Phase 2: 現在の仕様確認
```bash
# ソース確認（Git管理）
Read superclaude/commands/pm.md
# インストール後確認（参考用）
Read ~/.claude/commands/sc/pm.md
# 「なるほど、こういう仕様になってるのか」
```
### Phase 3: 改善案作成
```bash
# このプロジェクト内で（Git管理）
Write docs/development/hypothesis-pm-enhancement-2025-10-14.md
内容:
- 現状の問題（ドキュメント寄りすぎ、PMO機能不足）
- 改善案（自律的PDCA、自己評価）
- 実装方針
- 期待される効果
```
### Phase 4: 実装
```bash
# ソースファイル修正
Edit superclaude/commands/pm.md
変更例:
- PDCA自動実行の強化
- docs/ ディレクトリ活用の明示
- 自己評価ステップの追加
- エラー時再学習フローの追加
```
### Phase 5: テスト・検証
```bash
# テスト追加
Write tests/test_pm_enhanced.py
# テスト実行
pytest tests/test_pm_enhanced.py -v
# 開発版インストール
SuperClaude install --dev
# 実際に使ってみる
claude
/sc:pm "test enhanced workflow"
```
### Phase 6: 学習記録
```bash
# 成功パターン記録
Write docs/patterns/pm-autonomous-workflow.md
# 失敗があれば記録
Write docs/mistakes/mistake-2025-10-14.md
```
---
## 📊 Component間の依存関係
```yaml
Commands Component:
depends_on: ["core"]
Core Component:
provides:
- ~/.claude/CLAUDE.md（グローバル設定）
- 基本ディレクトリ構造
Modes Component:
depends_on: ["core"]
provides:
- ~/.claude/MODE_*.md
Agents Component:
depends_on: ["core"]
provides:
- エージェント定義
MCP Component:
depends_on: ["core"]
provides:
- MCPサーバー設定
```
---
## 🚀 次のアクション
理解完了！次は：
1. ✅ `superclaude/commands/pm.md` の現在の仕様確認
2. ✅ 改善提案ドキュメント作成
3. ✅ 実装修正（PDCA強化、PMO機能追加）
4. ✅ テスト追加・実行
5. ✅ 動作確認
6. ✅ 学習記録
このドキュメント自体が**インストールフローの完全理解記録**として機能する。
次回のセッションで読めば、同じ説明を繰り返さなくて済む。