SuperClaude/README-zh.md
kazuki nakai 00706f0ea9
feat: comprehensive framework improvements (#447)
* 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>
2025-10-18 20:28:10 +05:30

11 KiB
Raw Blame History

🚀 SuperClaude 框架

将Claude Code转换为结构化开发平台

Version License PRs Welcome

Website PyPI npm

English 中文 日本語

快速开始支持项目新功能文档贡献


📊 框架统计

命令数 智能体 模式 MCP服务器
21 14 5 6
斜杠命令 专业AI 行为模式 集成服务

🎯 概述

SuperClaude是一个元编程配置框架通过行为指令注入和组件编排将Claude Code转换为结构化开发平台。它提供系统化的工作流自动化配备强大的工具和智能代理。

快速安装

选择您的安装方式

方式 命令 最适合
🐍 pipx pipx install SuperClaude && pipx upgrade SuperClaude && SuperClaude install 推荐 - Linux/macOS
📦 pip pip install SuperClaude && pip upgrade SuperClaude && SuperClaude install 传统Python环境
🌐 npm npm install -g @bifrost_inc/superclaude && superclaude install 跨平台Node.js用户
⚠️ 重要从SuperClaude V3升级

如果您已安装SuperClaude V3应在安装V4前先卸载它

# 先卸载V3
删除所有相关文件和目录:
*.md *.json 和 commands/

# 然后安装V4
pipx install SuperClaude && pipx upgrade SuperClaude && SuperClaude install

升级时保留的内容:

  • ✓ 您的自定义斜杠命令(commands/sc/之外的)
  • ✓ 您在CLAUDE.md中的自定义内容
  • ✓ Claude Code的.claude.json.credentials.jsonsettings.jsonsettings.local.json
  • ✓ 您添加的任何自定义代理和文件

⚠️ 注意: V3的其他SuperClaude相关.json文件可能会造成冲突,应当移除。

💡 PEP 668错误故障排除
# 选项1使用pipx推荐
pipx install SuperClaude

# 选项2用户安装
pip install --user SuperClaude

# 选项3强制安装谨慎使用
pip install --break-system-packages SuperClaude

💖 支持项目

说实话维护SuperClaude需要时间和资源。

仅Claude Max订阅每月就要100美元用于测试这还不包括在文档、bug修复和功能开发上花费的时间。 如果您在日常工作中发现SuperClaude的价值请考虑支持这个项目。 哪怕几美元也能帮助覆盖基础成本并保持开发活跃。

每个贡献者都很重要,无论是代码、反馈还是支持。感谢成为这个社区的一员!🙏

Ko-fi

Ko-fi

一次性贡献

🎯 Patreon

Patreon

月度支持

💜 GitHub

GitHub Sponsors

灵活层级

您的支持使以下工作成为可能:

项目 成本/影响
🔬 Claude Max测试 每月100美元用于验证和测试
功能开发 新功能和改进
📚 文档编写 全面的指南和示例
🤝 社区支持 快速问题响应和帮助
🔧 MCP集成 测试新服务器连接
🌐 基础设施 托管和部署成本

注意: 不过没有压力——无论如何框架都会保持开源。仅仅知道有人在使用和欣赏它就很有激励作用。贡献代码、文档或传播消息也很有帮助!🙏


🎉 V4版本新功能

第4版基于社区反馈和实际使用模式带来了重大改进。

🤖 更智能的代理系统

14个专业代理,具有领域专业知识:

  • 安全工程师发现真实漏洞
  • 前端架构师理解UI模式
  • 基于上下文的自动协调
  • 按需提供领域专业知识

📝 改进的命名空间

/sc:前缀用于所有命令:

  • 与自定义命令无冲突
  • 21个命令覆盖完整生命周期
  • 从头脑风暴到部署
  • 清晰有序的命令结构

🔧 MCP服务器集成

6个强大服务器协同工作:

  • Context7 → 最新文档
  • Sequential → 复杂分析
  • Magic → UI组件生成
  • Playwright → 浏览器测试
  • Morphllm → 批量转换
  • Serena → 会话持久化

🎯 行为模式

5种自适应模式适应不同上下文:

  • 头脑风暴 → 提出正确问题
  • 编排 → 高效工具协调
  • 令牌效率 → 30-50%上下文节省
  • 任务管理 → 系统化组织
  • 内省 → 元认知分析

优化性能

更小的框架,更大的项目:

  • 减少框架占用
  • 为您的代码提供更多上下文
  • 支持更长对话
  • 启用复杂操作

📚 文档全面改写

为开发者完全重写:

  • 真实示例和用例
  • 记录常见陷阱
  • 包含实用工作流
  • 更好的导航结构

🔬 深度研究能力

SuperClaude v4.2引入了全面的深度研究能力,实现自主、自适应和智能的网络研究。

🎯 自适应规划

三种智能策略:规划优先(直接执行)、意图规划(澄清模糊请求)、统一规划(协作细化,默认)

🔄 多跳推理

最多5次迭代搜索实体扩展、概念深化、时序进展、因果链

📊 质量评分

基于置信度的验证:来源可信度评估(0.0-1.0)、覆盖完整性跟踪、综合连贯性评估

🧠 案例学习

跨会话智能:模式识别和重用、策略优化、成功查询保存

研究命令使用

/sc:research "AI最新发展 2024"
/sc:research "量子计算突破" --depth exhaustive

集成工具编排

智能协调多个工具:Tavily MCP(网页搜索)、Playwright MCP(内容提取)、Sequential MCP(推理合成)、Serena MCP(记忆持久化)、Context7 MCP(技术文档)


📚 Documentation

Complete Guide to SuperClaude

🚀 快速开始 📖 用户指南 🛠️ 开发资源 📋 参考资料

🤝 贡献

加入SuperClaude社区

我们欢迎各种类型的贡献!以下是您可以帮助的方式:

优先级 领域 描述
📝 文档 改进指南,添加示例,修复错误
🔧 MCP集成 添加服务器配置,测试集成
🎯 工作流 创建命令模式和配方
🧪 测试 添加测试,验证功能
🌐 国际化 将文档翻译为其他语言

Contributing Guide Contributors


⚖️ 许可证

本项目基于MIT许可证授权 - 详情请参阅LICENSE文件。

MIT License


Star历史

Star History Chart

🚀 由SuperClaude社区倾情打造

为突破边界的开发者用❤️制作

返回顶部 ↑