mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-29 16:16:08 +00:00
feat: Add complete multilingual README support with quality automation (#318)
## Changes Made
### 🌍 Multilingual README Implementation
- **README-zh.md**: Complete Chinese translation linking to existing
`Docs/User-Guide-zh/` documentation
- **README-ja.md**: Complete Japanese translation linking to existing
`Docs/User-Guide-jp/` documentation
- **README.md**: Updated with professional language selector badges
matching existing project styling
### Documentation Structure
- README.md → Docs/User-Guide/ (English)
- README-zh.md → Docs/User-Guide-zh/ (Chinese)
- README-ja.md → Docs/User-Guide-jp/ (Japanese)
This commit is contained in:
Mithun Gowda B
300
.github/workflows/readme-quality-check.yml
vendored
Normal file
300
.github/workflows/readme-quality-check.yml
vendored
Normal file
@@ -0,0 +1,300 @@
|
||||
name: README Quality Check
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
paths:
|
||||
- 'README*.md'
|
||||
- 'Docs/**/*.md'
|
||||
push:
|
||||
branches: [main, master, develop]
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
readme-quality-check:
|
||||
name: Multi-language README Quality Assessment
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: '3.11'
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
python -m pip install --upgrade pip
|
||||
pip install requests beautifulsoup4 pyyaml
|
||||
|
||||
- name: Create quality checker script
|
||||
run: |
|
||||
cat > readme_checker.py << 'EOF'
|
||||
#!/usr/bin/env python3
|
||||
# -*- coding: utf-8 -*-
|
||||
"""
|
||||
SuperClaude多语言README质量检查器
|
||||
检查版本同步、链接有效性、结构一致性
|
||||
"""
|
||||
|
||||
import os
|
||||
import re
|
||||
import requests
|
||||
import json
|
||||
from pathlib import Path
|
||||
from urllib.parse import urljoin
|
||||
|
||||
class READMEQualityChecker:
|
||||
def __init__(self):
|
||||
self.readme_files = ['README.md', 'README-zh.md', 'README-ja.md']
|
||||
self.results = {
|
||||
'structure_consistency': [],
|
||||
'link_validation': [],
|
||||
'translation_sync': [],
|
||||
'overall_score': 0
|
||||
}
|
||||
|
||||
def check_structure_consistency(self):
|
||||
"""检查结构一致性"""
|
||||
print("🔍 检查结构一致性...")
|
||||
|
||||
structures = {}
|
||||
for file in self.readme_files:
|
||||
if os.path.exists(file):
|
||||
with open(file, 'r', encoding='utf-8') as f:
|
||||
content = f.read()
|
||||
# 提取标题结构
|
||||
headers = re.findall(r'^#{1,6}\s+(.+)$', content, re.MULTILINE)
|
||||
structures[file] = len(headers)
|
||||
|
||||
# 比较结构差异
|
||||
line_counts = [structures.get(f, 0) for f in self.readme_files if f in structures]
|
||||
if line_counts:
|
||||
max_diff = max(line_counts) - min(line_counts)
|
||||
consistency_score = max(0, 100 - (max_diff * 5))
|
||||
|
||||
self.results['structure_consistency'] = {
|
||||
'score': consistency_score,
|
||||
'details': structures,
|
||||
'status': 'PASS' if consistency_score >= 90 else 'WARN'
|
||||
}
|
||||
|
||||
print(f"✅ 结构一致性: {consistency_score}/100")
|
||||
for file, count in structures.items():
|
||||
print(f" {file}: {count} headers")
|
||||
|
||||
def check_link_validation(self):
|
||||
"""检查链接有效性"""
|
||||
print("🔗 检查链接有效性...")
|
||||
|
||||
all_links = {}
|
||||
broken_links = []
|
||||
|
||||
for file in self.readme_files:
|
||||
if os.path.exists(file):
|
||||
with open(file, 'r', encoding='utf-8') as f:
|
||||
content = f.read()
|
||||
|
||||
# 提取所有链接
|
||||
links = re.findall(r'\[([^\]]+)\]\(([^)]+)\)', content)
|
||||
all_links[file] = []
|
||||
|
||||
for text, url in links:
|
||||
link_info = {'text': text, 'url': url, 'status': 'unknown'}
|
||||
|
||||
# 检查本地文件链接
|
||||
if not url.startswith(('http://', 'https://', '#')):
|
||||
if os.path.exists(url):
|
||||
link_info['status'] = 'valid'
|
||||
else:
|
||||
link_info['status'] = 'broken'
|
||||
broken_links.append(f"{file}: {url}")
|
||||
|
||||
# HTTP链接检查（简化版）
|
||||
elif url.startswith(('http://', 'https://')):
|
||||
try:
|
||||
# 只检查几个关键链接，避免过多请求
|
||||
if any(domain in url for domain in ['github.com', 'pypi.org', 'npmjs.com']):
|
||||
response = requests.head(url, timeout=10, allow_redirects=True)
|
||||
link_info['status'] = 'valid' if response.status_code < 400 else 'broken'
|
||||
else:
|
||||
link_info['status'] = 'skipped'
|
||||
except:
|
||||
link_info['status'] = 'error'
|
||||
else:
|
||||
link_info['status'] = 'anchor'
|
||||
|
||||
all_links[file].append(link_info)
|
||||
|
||||
# 计算链接健康度
|
||||
total_links = sum(len(links) for links in all_links.values())
|
||||
broken_count = len(broken_links)
|
||||
link_score = max(0, 100 - (broken_count * 10)) if total_links > 0 else 100
|
||||
|
||||
self.results['link_validation'] = {
|
||||
'score': link_score,
|
||||
'total_links': total_links,
|
||||
'broken_links': broken_count,
|
||||
'broken_list': broken_links[:10], # 最多显示10个
|
||||
'status': 'PASS' if link_score >= 80 else 'FAIL'
|
||||
}
|
||||
|
||||
print(f"✅ 链接有效性: {link_score}/100")
|
||||
print(f" 总链接数: {total_links}")
|
||||
print(f" 损坏链接: {broken_count}")
|
||||
|
||||
def check_translation_sync(self):
|
||||
"""检查翻译同步性"""
|
||||
print("🌍 检查翻译同步性...")
|
||||
|
||||
if not all(os.path.exists(f) for f in self.readme_files):
|
||||
print("⚠️ 缺少某些README文件")
|
||||
self.results['translation_sync'] = {
|
||||
'score': 60,
|
||||
'status': 'WARN',
|
||||
'message': '缺少某些README文件'
|
||||
}
|
||||
return
|
||||
|
||||
# 检查文件修改时间
|
||||
mod_times = {}
|
||||
for file in self.readme_files:
|
||||
mod_times[file] = os.path.getmtime(file)
|
||||
|
||||
# 计算时间差异（秒）
|
||||
times = list(mod_times.values())
|
||||
time_diff = max(times) - min(times)
|
||||
|
||||
# 根据时间差评分（7天内修改认为是同步的）
|
||||
sync_score = max(0, 100 - (time_diff / (7 * 24 * 3600) * 20))
|
||||
|
||||
self.results['translation_sync'] = {
|
||||
'score': int(sync_score),
|
||||
'time_diff_days': round(time_diff / (24 * 3600), 2),
|
||||
'status': 'PASS' if sync_score >= 80 else 'WARN',
|
||||
'mod_times': {f: f"{os.path.getmtime(f):.0f}" for f in self.readme_files}
|
||||
}
|
||||
|
||||
print(f"✅ 翻译同步性: {int(sync_score)}/100")
|
||||
print(f" 最大时间差: {round(time_diff / (24 * 3600), 1)} 天")
|
||||
|
||||
def generate_report(self):
|
||||
"""生成质量报告"""
|
||||
print("\n📊 生成质量报告...")
|
||||
|
||||
# 计算总分
|
||||
scores = [
|
||||
self.results['structure_consistency'].get('score', 0),
|
||||
self.results['link_validation'].get('score', 0),
|
||||
self.results['translation_sync'].get('score', 0)
|
||||
]
|
||||
overall_score = sum(scores) // len(scores)
|
||||
self.results['overall_score'] = overall_score
|
||||
|
||||
# 生成GitHub Actions摘要
|
||||
summary = f"""## 📊 README质量检查报告
|
||||
|
||||
### 🏆 总体评分: {overall_score}/100
|
||||
|
||||
| 检查项目 | 分数 | 状态 | 详情 |
|
||||
|----------|------|------|------|
|
||||
| 📐 结构一致性 | {self.results['structure_consistency'].get('score', 0)}/100 | {self.results['structure_consistency'].get('status', 'N/A')} | {len(self.results['structure_consistency'].get('details', {}))} 个文件 |
|
||||
| 🔗 链接有效性 | {self.results['link_validation'].get('score', 0)}/100 | {self.results['link_validation'].get('status', 'N/A')} | {self.results['link_validation'].get('broken_links', 0)} 个损坏链接 |
|
||||
| 🌍 翻译同步性 | {self.results['translation_sync'].get('score', 0)}/100 | {self.results['translation_sync'].get('status', 'N/A')} | {self.results['translation_sync'].get('time_diff_days', 0)} 天差异 |
|
||||
|
||||
### 📋 详细信息
|
||||
|
||||
**结构一致性详情:**
|
||||
"""
|
||||
|
||||
for file, count in self.results['structure_consistency'].get('details', {}).items():
|
||||
summary += f"\n- `{file}`: {count} 个标题"
|
||||
|
||||
if self.results['link_validation'].get('broken_links'):
|
||||
summary += f"\n\n**损坏链接列表:**\n"
|
||||
for link in self.results['link_validation']['broken_list']:
|
||||
summary += f"\n- ❌ {link}"
|
||||
|
||||
summary += f"\n\n### 🎯 建议\n"
|
||||
|
||||
if overall_score >= 90:
|
||||
summary += "✅ 质量优秀！继续保持。"
|
||||
elif overall_score >= 70:
|
||||
summary += "⚠️ 质量良好，有改进空间。"
|
||||
else:
|
||||
summary += "🚨 需要改进！请检查上述问题。"
|
||||
|
||||
# 写入GitHub Actions摘要
|
||||
github_step_summary = os.environ.get('GITHUB_STEP_SUMMARY')
|
||||
if github_step_summary:
|
||||
with open(github_step_summary, 'w', encoding='utf-8') as f:
|
||||
f.write(summary)
|
||||
|
||||
# 保存详细结果
|
||||
with open('readme-quality-report.json', 'w', encoding='utf-8') as f:
|
||||
json.dump(self.results, f, indent=2, ensure_ascii=False)
|
||||
|
||||
print("✅ 报告已生成")
|
||||
|
||||
# 根据分数决定退出码
|
||||
return 0 if overall_score >= 70 else 1
|
||||
|
||||
def run_all_checks(self):
|
||||
"""运行所有检查"""
|
||||
print("🚀 开始README质量检查...\n")
|
||||
|
||||
self.check_structure_consistency()
|
||||
self.check_link_validation()
|
||||
self.check_translation_sync()
|
||||
|
||||
exit_code = self.generate_report()
|
||||
|
||||
print(f"\n🎯 检查完成！总分: {self.results['overall_score']}/100")
|
||||
return exit_code
|
||||
|
||||
if __name__ == "__main__":
|
||||
checker = READMEQualityChecker()
|
||||
exit_code = checker.run_all_checks()
|
||||
exit(exit_code)
|
||||
EOF
|
||||
|
||||
- name: Run README quality check
|
||||
run: python readme_checker.py
|
||||
|
||||
- name: Upload quality report
|
||||
if: always()
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: readme-quality-report
|
||||
path: readme-quality-report.json
|
||||
retention-days: 30
|
||||
|
||||
- name: Comment PR (if applicable)
|
||||
if: github.event_name == 'pull_request' && always()
|
||||
uses: actions/github-script@v7
|
||||
with:
|
||||
script: |
|
||||
const fs = require('fs');
|
||||
|
||||
if (fs.existsSync('readme-quality-report.json')) {
|
||||
const report = JSON.parse(fs.readFileSync('readme-quality-report.json', 'utf8'));
|
||||
|
||||
const score = report.overall_score;
|
||||
const emoji = score >= 90 ? '🏆' : score >= 70 ? '✅' : '⚠️';
|
||||
|
||||
const comment = `${emoji} **README质量检查结果: ${score}/100**
|
||||
|
||||
📐 结构一致性: ${report.structure_consistency?.score || 0}/100
|
||||
🔗 链接有效性: ${report.link_validation?.score || 0}/100
|
||||
🌍 翻译同步性: ${report.translation_sync?.score || 0}/100
|
||||
|
||||
查看详细报告请点击 Actions 标签页。`;
|
||||
|
||||
github.rest.issues.createComment({
|
||||
issue_number: context.issue.number,
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
body: comment
|
||||
});
|
||||
}
|
||||
408
README-ja.md
Normal file
408
README-ja.md
Normal file
@@ -0,0 +1,408 @@
|
||||
<div align="center">
|
||||
|
||||
# 🚀 SuperClaudeフレームワーク
|
||||
|
||||
### **Claude Codeを構造化開発プラットフォームに変換**
|
||||
|
||||
<p align="center">
|
||||
<img src="https://img.shields.io/badge/version-4.0.8-blue" alt="Version">
|
||||
<img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License">
|
||||
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs Welcome">
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://superclaude.netlify.app/">
|
||||
<img src="https://img.shields.io/badge/🌐_ウェブサイトを訪問-blue" alt="Website">
|
||||
</a>
|
||||
<a href="https://pypi.org/project/SuperClaude/">
|
||||
<img src="https://img.shields.io/pypi/v/SuperClaude.svg?" alt="PyPI">
|
||||
</a>
|
||||
<a href="https://www.npmjs.com/package/@bifrost_inc/superclaude">
|
||||
<img src="https://img.shields.io/npm/v/@bifrost_inc/superclaude.svg" alt="npm">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
<!-- Language Selector -->
|
||||
<p align="center">
|
||||
<a href="README.md">
|
||||
<img src="https://img.shields.io/badge/🇺🇸_English-blue" alt="English">
|
||||
</a>
|
||||
<a href="README-zh.md">
|
||||
<img src="https://img.shields.io/badge/🇨🇳_中文-red" alt="中文">
|
||||
</a>
|
||||
<a href="README-ja.md">
|
||||
<img src="https://img.shields.io/badge/🇯🇵_日本語-green" alt="日本語">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="#-クイックインストール">クイックスタート</a> •
|
||||
<a href="#-プロジェクトを支援">支援</a> •
|
||||
<a href="#-v4の新機能">新機能</a> •
|
||||
<a href="#-ドキュメント">ドキュメント</a> •
|
||||
<a href="#-貢献">貢献</a>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
## 📊 **フレームワーク統計**
|
||||
|
||||
| **コマンド数** | **エージェント** | **モード** | **MCPサーバー** |
|
||||
|:------------:|:----------:|:---------:|:---------------:|
|
||||
| **21** | **14** | **5** | **6** |
|
||||
| スラッシュコマンド | 専門AI | 動作モード | 統合サービス |
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
## 🎯 **概要**
|
||||
|
||||
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ユーザー |
|
||||
|
||||
</div>
|
||||
|
||||
<details>
|
||||
<summary><b>⚠️ 重要：SuperClaude V3からのアップグレード</b></summary>
|
||||
|
||||
**SuperClaude V3がインストールされている場合は、V4をインストールする前にアンインストールする必要があります：**
|
||||
|
||||
```bash
|
||||
# V3を最初にアンインストール
|
||||
関連するファイルとディレクトリをすべて削除：
|
||||
*.md *.json および commands/
|
||||
|
||||
# その後V4をインストール
|
||||
pipx install SuperClaude && pipx upgrade SuperClaude && SuperClaude install
|
||||
```
|
||||
|
||||
**✅ アップグレード時に保持される内容：**
|
||||
- ✓ カスタムスラッシュコマンド（`commands/sc/`外のもの）
|
||||
- ✓ `CLAUDE.md`内のカスタム内容
|
||||
- ✓ Claude Codeの`.claude.json`、`.credentials.json`、`settings.json`、`settings.local.json`
|
||||
- ✓ 追加したカスタムエージェントとファイル
|
||||
|
||||
**⚠️ 注意：** V3の他のSuperClaude関連`.json`ファイルは競合を引き起こす可能性があるため削除してください。
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>💡 PEP 668エラーのトラブルシューティング</b></summary>
|
||||
|
||||
```bash
|
||||
# オプション1：pipxを使用（推奨）
|
||||
pipx install SuperClaude
|
||||
|
||||
# オプション2：ユーザーインストール
|
||||
pip install --user SuperClaude
|
||||
|
||||
# オプション3：強制インストール（注意して使用）
|
||||
pip install --break-system-packages SuperClaude
|
||||
```
|
||||
</details>
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
## 💖 **プロジェクトを支援**
|
||||
|
||||
> 正直に言うと、SuperClaudeの維持には時間とリソースが必要です。
|
||||
>
|
||||
> *Claude Maxサブスクリプションだけでもテスト用に月100ドルかかり、それに加えてドキュメント、バグ修正、機能開発に費やす時間があります。*
|
||||
> *日常の作業でSuperClaudeの価値を感じていただけるなら、プロジェクトの支援をご検討ください。*
|
||||
> *数ドルでも基本コストをカバーし、開発を継続することができます。*
|
||||
>
|
||||
> コード、フィードバック、または支援を通じて、すべての貢献者が重要です。このコミュニティの一員でいてくれてありがとう！🙏
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" width="33%">
|
||||
|
||||
### ☕ **Ko-fi**
|
||||
[](https://ko-fi.com/superclaude)
|
||||
|
||||
*一回限りの貢献*
|
||||
|
||||
</td>
|
||||
<td align="center" width="33%">
|
||||
|
||||
### 🎯 **Patreon**
|
||||
[](https://patreon.com/superclaude)
|
||||
|
||||
*月額支援*
|
||||
|
||||
</td>
|
||||
<td align="center" width="33%">
|
||||
|
||||
### 💜 **GitHub**
|
||||
[](https://github.com/sponsors/SuperClaude-Org)
|
||||
|
||||
*柔軟な階層*
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
### **あなたの支援により可能になること：**
|
||||
|
||||
| 項目 | コスト/影響 |
|
||||
|------|-------------|
|
||||
| 🔬 **Claude Maxテスト** | 検証とテスト用に月100ドル |
|
||||
| ⚡ **機能開発** | 新機能と改善 |
|
||||
| 📚 **ドキュメンテーション** | 包括的なガイドと例 |
|
||||
| 🤝 **コミュニティサポート** | 迅速な問題対応とヘルプ |
|
||||
| 🔧 **MCP統合** | 新しいサーバー接続のテスト |
|
||||
| 🌐 **インフラストラクチャ** | ホスティングとデプロイメントのコスト |
|
||||
|
||||
> **注意：** ただし、プレッシャーはありません。フレームワークはいずれにしてもオープンソースのままです。人々がそれを使用し、評価していることを知るだけでもモチベーションになります。コード、ドキュメント、または情報の拡散による貢献も助けになります！🙏
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
## 🎉 **V4の新機能**
|
||||
|
||||
> *バージョン4は、コミュニティフィードバックと実際の使用パターンに基づいて重要な改善をもたらします。*
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td width="50%">
|
||||
|
||||
### 🤖 **よりスマートなエージェントシステム**
|
||||
**14の専門エージェント**がドメイン専門知識を持ちます：
|
||||
- セキュリティエンジニアが実際の脆弱性をキャッチ
|
||||
- フロントエンドアーキテクトがUIパターンを理解
|
||||
- コンテキストに基づく自動調整
|
||||
- オンデマンドでドメイン固有の専門知識
|
||||
|
||||
</td>
|
||||
<td width="50%">
|
||||
|
||||
### 📝 **改良された名前空間**
|
||||
すべてのコマンドに**`/sc:`プレフィックス**：
|
||||
- カスタムコマンドとの競合なし
|
||||
- 完全なライフサイクルをカバーする21のコマンド
|
||||
- ブレインストーミングからデプロイメントまで
|
||||
- 整理されたコマンド構造
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="50%">
|
||||
|
||||
### 🔧 **MCPサーバー統合**
|
||||
**6つの強力なサーバー**が連携：
|
||||
- **Context7** → 最新ドキュメント
|
||||
- **Sequential** → 複雑な分析
|
||||
- **Magic** → UIコンポーネント生成
|
||||
- **Playwright** → ブラウザテスト
|
||||
- **Morphllm** → 一括変換
|
||||
- **Serena** → セッション持続
|
||||
|
||||
</td>
|
||||
<td width="50%">
|
||||
|
||||
### 🎯 **動作モード**
|
||||
異なるコンテキストのための**5つの適応モード**：
|
||||
- **ブレインストーミング** → 適切な質問をする
|
||||
- **オーケストレーション** → 効率的なツール調整
|
||||
- **トークン効率** → 30-50%のコンテキスト節約
|
||||
- **タスク管理** → システム化された組織
|
||||
- **内省** → メタ認知分析
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="50%">
|
||||
|
||||
### ⚡ **最適化されたパフォーマンス**
|
||||
**より小さなフレームワーク、より大きなプロジェクト：**
|
||||
- フレームワークフットプリントの削減
|
||||
- コードのためのより多くのコンテキスト
|
||||
- より長い会話が可能
|
||||
- 複雑な操作の有効化
|
||||
|
||||
</td>
|
||||
<td width="50%">
|
||||
|
||||
### 📚 **ドキュメントの全面見直し**
|
||||
**開発者のための完全な書き直し：**
|
||||
- 実際の例とユースケース
|
||||
- 一般的な落とし穴の文書化
|
||||
- 実用的なワークフローを含む
|
||||
- より良いナビゲーション構造
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
## 📚 **ドキュメント**
|
||||
|
||||
### **🇯🇵 SuperClaude完全日本語ガイド**
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th align="center">🚀 はじめに</th>
|
||||
<th align="center">📖 ユーザーガイド</th>
|
||||
<th align="center">🛠️ 開発者リソース</th>
|
||||
<th align="center">📋 リファレンス</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top">
|
||||
|
||||
- 📝 [**クイックスタートガイド**](Docs/Getting-Started/quick-start.md)
|
||||
*すぐに開始*
|
||||
|
||||
- 💾 [**インストールガイド**](Docs/Getting-Started/installation.md)
|
||||
*詳細なセットアップ手順*
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
|
||||
- 🎯 [**コマンドリファレンス**](Docs/User-Guide-jp/commands.md)
|
||||
*全21のスラッシュコマンド*
|
||||
|
||||
- 🤖 [**エージェントガイド**](Docs/User-Guide-jp/agents.md)
|
||||
*14の専門エージェント*
|
||||
|
||||
- 🎨 [**動作モード**](Docs/User-Guide-jp/modes.md)
|
||||
*5つの適応モード*
|
||||
|
||||
- 🚩 [**フラグガイド**](Docs/User-Guide-jp/flags.md)
|
||||
*動作制御パラメータ*
|
||||
|
||||
- 🔧 [**MCPサーバー**](Docs/User-Guide-jp/mcp-servers.md)
|
||||
*6つのサーバー統合*
|
||||
|
||||
- 💼 [**セッション管理**](Docs/User-Guide-jp/session-management.md)
|
||||
*状態の保存と復元*
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
|
||||
- 🏗️ [**技術アーキテクチャ**](Docs/Developer-Guide/technical-architecture.md)
|
||||
*システム設計の詳細*
|
||||
|
||||
- 💻 [**コード貢献**](Docs/Developer-Guide/contributing-code.md)
|
||||
*開発ワークフロー*
|
||||
|
||||
- 🧪 [**テスト＆デバッグ**](Docs/Developer-Guide/testing-debugging.md)
|
||||
*品質保証*
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
|
||||
- ✨ [**ベストプラクティス**](Docs/Reference/quick-start-practices.md)
|
||||
*プロのコツとパターン*
|
||||
|
||||
- 📓 [**サンプル集**](Docs/Reference/examples-cookbook.md)
|
||||
*実際の使用例*
|
||||
|
||||
- 🔍 [**トラブルシューティング**](Docs/Reference/troubleshooting.md)
|
||||
*一般的な問題と修正*
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
## 🤝 **貢献**
|
||||
|
||||
### **SuperClaudeコミュニティに参加**
|
||||
|
||||
あらゆる種類の貢献を歓迎します！お手伝いできる方法は以下のとおりです：
|
||||
|
||||
| 優先度 | 領域 | 説明 |
|
||||
|:--------:|------|-------------|
|
||||
| 📝 **高** | ドキュメント | ガイドの改善、例の追加、タイプミス修正 |
|
||||
| 🔧 **高** | MCP統合 | サーバー設定の追加、統合テスト |
|
||||
| 🎯 **中** | ワークフロー | コマンドパターンとレシピの作成 |
|
||||
| 🧪 **中** | テスト | テストの追加、機能の検証 |
|
||||
| 🌐 **低** | 国際化 | ドキュメントの他言語への翻訳 |
|
||||
|
||||
<p align="center">
|
||||
<a href="CONTRIBUTING.md">
|
||||
<img src="https://img.shields.io/badge/📖_読む-貢献ガイド-blue" alt="Contributing Guide">
|
||||
</a>
|
||||
<a href="https://github.com/SuperClaude-Org/SuperClaude_Framework/graphs/contributors">
|
||||
<img src="https://img.shields.io/badge/👥_表示-すべての貢献者-green" alt="Contributors">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
## ⚖️ **ライセンス**
|
||||
|
||||
このプロジェクトは**MITライセンス**の下でライセンスされています - 詳細は[LICENSE](LICENSE)ファイルを参照してください。
|
||||
|
||||
<p align="center">
|
||||
<img src="https://img.shields.io/badge/License-MIT-yellow.svg?" alt="MIT License">
|
||||
</p>
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
## ⭐ **Star履歴**
|
||||
|
||||
<a href="https://www.star-history.com/#SuperClaude-Org/SuperClaude_Framework&Timeline">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=SuperClaude-Org/SuperClaude_Framework&type=Timeline&theme=dark" />
|
||||
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=SuperClaude-Org/SuperClaude_Framework&type=Timeline" />
|
||||
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=SuperClaude-Org/SuperClaude_Framework&type=Timeline" />
|
||||
</picture>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
### **🚀 SuperClaudeコミュニティによって情熱をもって構築**
|
||||
|
||||
<p align="center">
|
||||
<sub>境界を押し広げる開発者のために❤️で作られました</sub>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="#-superclaudeフレームワーク">トップに戻る ↑</a>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
409
README-zh.md
Normal file
409
README-zh.md
Normal file
@@ -0,0 +1,409 @@
|
||||
<div align="center">
|
||||
|
||||
# 🚀 SuperClaude 框架
|
||||
|
||||
### **将Claude Code转换为结构化开发平台**
|
||||
|
||||
<p align="center">
|
||||
<img src="https://img.shields.io/badge/version-4.0.8-blue" alt="Version">
|
||||
<img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License">
|
||||
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs Welcome">
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://superclaude.netlify.app/">
|
||||
<img src="https://img.shields.io/badge/🌐_访问网站-blue" alt="Website">
|
||||
</a>
|
||||
<a href="https://pypi.org/project/SuperClaude/">
|
||||
<img src="https://img.shields.io/pypi/v/SuperClaude.svg?" alt="PyPI">
|
||||
</a>
|
||||
<a href="https://www.npmjs.com/package/@bifrost_inc/superclaude">
|
||||
<img src="https://img.shields.io/npm/v/@bifrost_inc/superclaude.svg" alt="npm">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
<!-- Language Selector -->
|
||||
<p align="center">
|
||||
<a href="README.md">
|
||||
<img src="https://img.shields.io/badge/🇺🇸_English-blue" alt="English">
|
||||
</a>
|
||||
<a href="README-zh.md">
|
||||
<img src="https://img.shields.io/badge/🇨🇳_中文-red" alt="中文">
|
||||
</a>
|
||||
<a href="README-ja.md">
|
||||
<img src="https://img.shields.io/badge/🇯🇵_日本語-green" alt="日本語">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="#-快速安装">快速开始</a> •
|
||||
<a href="#-支持项目">支持项目</a> •
|
||||
<a href="#-v4版本新功能">新功能</a> •
|
||||
<a href="#-文档">文档</a> •
|
||||
<a href="#-贡献">贡献</a>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
## 📊 **框架统计**
|
||||
|
||||
| **命令数** | **智能体** | **模式** | **MCP服务器** |
|
||||
|:------------:|:----------:|:---------:|:---------------:|
|
||||
| **21** | **14** | **5** | **6** |
|
||||
| 斜杠命令 | 专业AI | 行为模式 | 集成服务 |
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
## 🎯 **概述**
|
||||
|
||||
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用户 |
|
||||
|
||||
</div>
|
||||
|
||||
<details>
|
||||
<summary><b>⚠️ 重要：从SuperClaude V3升级</b></summary>
|
||||
|
||||
**如果您已安装SuperClaude V3，应在安装V4前先卸载它：**
|
||||
|
||||
```bash
|
||||
# 先卸载V3
|
||||
删除所有相关文件和目录：
|
||||
*.md *.json 和 commands/
|
||||
|
||||
# 然后安装V4
|
||||
pipx install SuperClaude && pipx upgrade SuperClaude && SuperClaude install
|
||||
```
|
||||
|
||||
**✅ 升级时保留的内容：**
|
||||
- ✓ 您的自定义斜杠命令（`commands/sc/`之外的）
|
||||
- ✓ 您在`CLAUDE.md`中的自定义内容
|
||||
- ✓ Claude Code的`.claude.json`、`.credentials.json`、`settings.json`和`settings.local.json`
|
||||
- ✓ 您添加的任何自定义代理和文件
|
||||
|
||||
**⚠️ 注意：** V3的其他SuperClaude相关`.json`文件可能会造成冲突，应当移除。
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>💡 PEP 668错误故障排除</b></summary>
|
||||
|
||||
```bash
|
||||
# 选项1：使用pipx（推荐）
|
||||
pipx install SuperClaude
|
||||
|
||||
# 选项2：用户安装
|
||||
pip install --user SuperClaude
|
||||
|
||||
# 选项3：强制安装（谨慎使用）
|
||||
pip install --break-system-packages SuperClaude
|
||||
```
|
||||
</details>
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
## 💖 **支持项目**
|
||||
|
||||
> 说实话，维护SuperClaude需要时间和资源。
|
||||
>
|
||||
> *仅Claude Max订阅每月就要100美元用于测试，这还不包括在文档、bug修复和功能开发上花费的时间。*
|
||||
> *如果您在日常工作中发现SuperClaude的价值，请考虑支持这个项目。*
|
||||
> *哪怕几美元也能帮助覆盖基础成本并保持开发活跃。*
|
||||
>
|
||||
> 每个贡献者都很重要，无论是代码、反馈还是支持。感谢成为这个社区的一员！🙏
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" width="33%">
|
||||
|
||||
### ☕ **Ko-fi**
|
||||
[](https://ko-fi.com/superclaude)
|
||||
|
||||
*一次性贡献*
|
||||
|
||||
</td>
|
||||
<td align="center" width="33%">
|
||||
|
||||
### 🎯 **Patreon**
|
||||
[](https://patreon.com/superclaude)
|
||||
|
||||
*月度支持*
|
||||
|
||||
</td>
|
||||
<td align="center" width="33%">
|
||||
|
||||
### 💜 **GitHub**
|
||||
[](https://github.com/sponsors/SuperClaude-Org)
|
||||
|
||||
*灵活层级*
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
### **您的支持使以下工作成为可能：**
|
||||
|
||||
| 项目 | 成本/影响 |
|
||||
|------|-------------|
|
||||
| 🔬 **Claude Max测试** | 每月100美元用于验证和测试 |
|
||||
| ⚡ **功能开发** | 新功能和改进 |
|
||||
| 📚 **文档编写** | 全面的指南和示例 |
|
||||
| 🤝 **社区支持** | 快速问题响应和帮助 |
|
||||
| 🔧 **MCP集成** | 测试新服务器连接 |
|
||||
| 🌐 **基础设施** | 托管和部署成本 |
|
||||
|
||||
> **注意：** 不过没有压力——无论如何框架都会保持开源。仅仅知道有人在使用和欣赏它就很有激励作用。贡献代码、文档或传播消息也很有帮助！🙏
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
## 🎉 **V4版本新功能**
|
||||
|
||||
> *第4版基于社区反馈和实际使用模式带来了重大改进。*
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td width="50%">
|
||||
|
||||
### 🤖 **更智能的代理系统**
|
||||
**14个专业代理**，具有领域专业知识：
|
||||
- 安全工程师发现真实漏洞
|
||||
- 前端架构师理解UI模式
|
||||
- 基于上下文的自动协调
|
||||
- 按需提供领域专业知识
|
||||
|
||||
</td>
|
||||
<td width="50%">
|
||||
|
||||
### 📝 **改进的命名空间**
|
||||
**`/sc:`前缀**用于所有命令：
|
||||
- 与自定义命令无冲突
|
||||
- 21个命令覆盖完整生命周期
|
||||
- 从头脑风暴到部署
|
||||
- 清晰有序的命令结构
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="50%">
|
||||
|
||||
### 🔧 **MCP服务器集成**
|
||||
**6个强大服务器**协同工作：
|
||||
- **Context7** → 最新文档
|
||||
- **Sequential** → 复杂分析
|
||||
- **Magic** → UI组件生成
|
||||
- **Playwright** → 浏览器测试
|
||||
- **Morphllm** → 批量转换
|
||||
- **Serena** → 会话持久化
|
||||
|
||||
</td>
|
||||
<td width="50%">
|
||||
|
||||
### 🎯 **行为模式**
|
||||
**5种自适应模式**适应不同上下文：
|
||||
- **头脑风暴** → 提出正确问题
|
||||
- **编排** → 高效工具协调
|
||||
- **令牌效率** → 30-50%上下文节省
|
||||
- **任务管理** → 系统化组织
|
||||
- **内省** → 元认知分析
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="50%">
|
||||
|
||||
### ⚡ **优化性能**
|
||||
**更小的框架，更大的项目：**
|
||||
- 减少框架占用
|
||||
- 为您的代码提供更多上下文
|
||||
- 支持更长对话
|
||||
- 启用复杂操作
|
||||
|
||||
</td>
|
||||
<td width="50%">
|
||||
|
||||
### 📚 **文档全面改写**
|
||||
**为开发者完全重写：**
|
||||
- 真实示例和用例
|
||||
- 记录常见陷阱
|
||||
- 包含实用工作流
|
||||
- 更好的导航结构
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
## 📚 **Documentation**
|
||||
|
||||
### **Complete Guide to SuperClaude**
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th align="center">🚀 快速开始</th>
|
||||
<th align="center">📖 用户指南</th>
|
||||
<th align="center">🛠️ 开发资源</th>
|
||||
<th align="center">📋 参考资料</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top">
|
||||
|
||||
- 📝 [**快速开始指南**](Docs/Getting-Started/quick-start.md)
|
||||
*快速上手使用*
|
||||
|
||||
- 💾 [**安装指南**](Docs/Getting-Started/installation.md)
|
||||
*详细的安装说明*
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
|
||||
- 🎯 [**命令参考**](Docs/User-Guide-zh/commands.md)
|
||||
*全部21个斜杠命令*
|
||||
|
||||
- 🤖 [**智能体指南**](Docs/User-Guide-zh/agents.md)
|
||||
*14个专业智能体*
|
||||
|
||||
- 🎨 [**行为模式**](Docs/User-Guide-zh/modes.md)
|
||||
*5种自适应模式*
|
||||
|
||||
- 🚩 [**标志指南**](Docs/User-Guide-zh/flags.md)
|
||||
*控制行为参数*
|
||||
|
||||
- 🔧 [**MCP服务器**](Docs/User-Guide-zh/mcp-servers.md)
|
||||
*6个服务器集成*
|
||||
|
||||
- 💼 [**会话管理**](Docs/User-Guide-zh/session-management.md)
|
||||
*保存和恢复状态*
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
|
||||
- 🏗️ [**技术架构**](Docs/Developer-Guide/technical-architecture.md)
|
||||
*系统设计详情*
|
||||
|
||||
- 💻 [**贡献代码**](Docs/Developer-Guide/contributing-code.md)
|
||||
*开发工作流程*
|
||||
|
||||
- 🧪 [**测试与调试**](Docs/Developer-Guide/testing-debugging.md)
|
||||
*质量保证*
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
|
||||
- ✨ [**最佳实践**](Docs/Reference/quick-start-practices.md)
|
||||
*专业技巧和模式*
|
||||
|
||||
- 📓 [**示例手册**](Docs/Reference/examples-cookbook.md)
|
||||
*实际应用示例*
|
||||
|
||||
- 🔍 [**故障排除**](Docs/Reference/troubleshooting.md)
|
||||
*常见问题和修复*
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
## 🤝 **贡献**
|
||||
|
||||
### **加入SuperClaude社区**
|
||||
|
||||
我们欢迎各种类型的贡献！以下是您可以帮助的方式：
|
||||
|
||||
| 优先级 | 领域 | 描述 |
|
||||
|:--------:|------|-------------|
|
||||
| 📝 **高** | 文档 | 改进指南，添加示例，修复错误 |
|
||||
| 🔧 **高** | MCP集成 | 添加服务器配置，测试集成 |
|
||||
| 🎯 **中** | 工作流 | 创建命令模式和配方 |
|
||||
| 🧪 **中** | 测试 | 添加测试，验证功能 |
|
||||
| 🌐 **低** | 国际化 | 将文档翻译为其他语言 |
|
||||
|
||||
<p align="center">
|
||||
<a href="CONTRIBUTING.md">
|
||||
<img src="https://img.shields.io/badge/📖_阅读-贡献指南-blue" alt="Contributing Guide">
|
||||
</a>
|
||||
<a href="https://github.com/SuperClaude-Org/SuperClaude_Framework/graphs/contributors">
|
||||
<img src="https://img.shields.io/badge/👥_查看-所有贡献者-green" alt="Contributors">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
## ⚖️ **许可证**
|
||||
|
||||
本项目基于**MIT许可证**授权 - 详情请参阅[LICENSE](LICENSE)文件。
|
||||
|
||||
<p align="center">
|
||||
<img src="https://img.shields.io/badge/License-MIT-yellow.svg?" alt="MIT License">
|
||||
</p>
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
## ⭐ **Star历史**
|
||||
|
||||
<a href="https://www.star-history.com/#SuperClaude-Org/SuperClaude_Framework&Timeline">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=SuperClaude-Org/SuperClaude_Framework&type=Timeline&theme=dark" />
|
||||
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=SuperClaude-Org/SuperClaude_Framework&type=Timeline" />
|
||||
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=SuperClaude-Org/SuperClaude_Framework&type=Timeline" />
|
||||
</picture>
|
||||
</a>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
### **🚀 由SuperClaude社区倾情打造**
|
||||
|
||||
<p align="center">
|
||||
<sub>为突破边界的开发者用❤️制作</sub>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="#-superclaude-框架">返回顶部 ↑</a>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
12
README.md
12
README.md
@@ -22,6 +22,18 @@
|
||||
</a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="README.md">
|
||||
<img src="https://img.shields.io/badge/🇺🇸_English-blue" alt="English">
|
||||
</a>
|
||||
<a href="README-zh.md">
|
||||
<img src="https://img.shields.io/badge/🇨🇳_中文-red" alt="中文">
|
||||
</a>
|
||||
<a href="README-ja.md">
|
||||
<img src="https://img.shields.io/badge/🇯🇵_日本語-green" alt="日本語">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="#-quick-installation">Quick Start</a> •
|
||||
<a href="#-support-the-project">Support</a> •
|
||||
|
||||
Reference in New Issue
Block a user