generated from Paul.Kim/tpl-superclaude
Initial commit
This commit is contained in:
141
README.md
Normal file
141
README.md
Normal file
@ -0,0 +1,141 @@
|
||||
# SuperClaude 기반 프로젝트 템플릿 🚀
|
||||
|
||||
이 템플릿은 SuperClaude v3를 기반으로 한 프로젝트 구조를 제공합니다. Claude Code를 확장하여 개발을 효율화합니다.
|
||||
|
||||
**📢 상태**: 기본 템플릿. 추가 커스터마이징 권장.
|
||||
|
||||
## 소개
|
||||
|
||||
세 가지 강력한 AI 개발 도구를 결합한 프로젝트 템플릿입니다:
|
||||
|
||||
- Claude Code - Anthropic의 Claude용 CLI
|
||||
- Task Master - 태그 기반 작업 관리 시스템
|
||||
- Cursor - 정밀한 코드 리뷰 워크플로를 위한 AI 기반 IDE (선택 사항)
|
||||
|
||||
## 시작하기
|
||||
|
||||
### Claude Code 실행
|
||||
|
||||
```bash
|
||||
claude
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```
|
||||
ccr code # calude code router 사용 시
|
||||
```
|
||||
|
||||
### Task Studio 열기 (선택적 웹 인터페이스)
|
||||
|
||||
```bash
|
||||
npx task-studio@latest
|
||||
```
|
||||
|
||||
## 주요 기능 ✨
|
||||
|
||||
- 🛠️ **SuperClaude 명령어**: 16개 전문 명령어 (e.g., `/sc:implement`, `/sc:analyze`).
|
||||
- 🎭 **스마트 페르소나**: 자동 전문가 선택 (architect, frontend 등).
|
||||
- 🔧 **MCP 통합**: 외부 도구 연동 (Context7, Sequential 등).
|
||||
- ⚡ **토큰 최적화**: 긴 대화 효율적 처리.
|
||||
|
||||
프로젝트 구조: `src/`, `data/`, `tests/` 등 확장.
|
||||
|
||||
## 설정 ⚙️
|
||||
|
||||
`~/.claude/settings.json` 편집으로 커스터마이징. 기본 설정 충분.
|
||||
|
||||
또한 `.mcp.json` 파일을 통해 MCP(Model Context Protocol) 서버를 구성할 수 있습니다. 이 파일은 다양한 AI 도구와의 통합을 정의합니다. 기본적으로 다음과 같은 서버가 설정되어 있습니다:
|
||||
|
||||
- taskmaster-ai: 태그 기반 작업 관리 시스템
|
||||
- sequential-thinking: 복잡한 분석을 위한 순차적 사고 엔진
|
||||
- playwright: 브라우저 자동화 및 테스트
|
||||
- magic: UI 컴포넌트 생성
|
||||
- context7: 라이브러리 문서 검색
|
||||
|
||||
이 서버들을 필요에 따라 추가하거나 커스터마이징할 수 있습니다. 예를 들어, 새로운 MCP 서버를 추가하여 도구를 확장하세요. 자세한 내용은 MCP 문서를 참조하세요.
|
||||
|
||||
## 문서 📖
|
||||
|
||||
- [User Guide](https://github.com/NomenAK/SuperClaude/blob/master/Docs/superclaude-user-guide.md)
|
||||
- [Commands Guide](https://github.com/NomenAK/SuperClaude/blob/master/Docs/commands-guide.md)
|
||||
|
||||
## FAQ 🙋
|
||||
|
||||
**Q: 어떤 프로젝트에 사용하나요?**
|
||||
|
||||
A: 데이터 분석, 앱 개발 등. SuperClaude 명령어로 자동화.
|
||||
|
||||
## 라이선스
|
||||
|
||||
MIT - [LICENSE](https://opensource.org/licenses/MIT)
|
||||
|
||||
*SuperClaude로 효율적 개발 시작! 🙂*
|
||||
|
||||
## Claude Code Commands
|
||||
|
||||
아래 테이블은 Claude Code의 모든 명령어를 요약한 것입니다. 명령어는 콜론(:)으로 구분된 형식으로 표시되며, 각 분류 내에서 알파벳 순으로 정렬되었습니다.
|
||||
|
||||
| 명령어 | 설명 | 분류 |
|
||||
| ------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------- |
|
||||
| /canvas:create_from_dir | Analyzes markdown files in a specified directory, groups related content, and generates a JSON Canvas with nodes and edges. | Canvas |
|
||||
| /debug | Debug command instructions for troubleshooting. | Debug |
|
||||
| /design:1-system-architecture:1-create-architecture-framework | Creates the initial architecture framework document with system overview and component inventory. | Design - System Architecture |
|
||||
| /design:1-system-architecture:2-design-components | Designs detailed component architecture with implementation patterns and integration points. | Design - System Architecture |
|
||||
| /design:1-system-architecture:3-integration-architecture | Designs system integration architecture with data flow and API specifications. | Design - System Architecture |
|
||||
| /design:1-system-architecture:4-generate-architecture-summary | Generates comprehensive architecture summary document with visual diagrams and recommendations. | Design - System Architecture |
|
||||
| /planning:1-mrd:1-start-session | Starts a new or updated MRD (Market Requirements Document) research session. | Planning - MRD |
|
||||
| /planning:1-mrd:2-analyze-research-data | Analyzes user-submitted research data, provides insights, and suggests the next research step. | Planning - MRD |
|
||||
| /planning:1-mrd:3-generate-mrd-document | Generates the final MRD document by consolidating all research and analysis from a session. | Planning - MRD |
|
||||
| /planning:1-mrd:4-compare-mrd-versions | Compares two different MRD versions (sessions) and generates a strategic change report. | Planning - MRD |
|
||||
| /planning:2-brainstorm:1-start-brainstorm | Starts a new brainstorming session for creative idea generation and systematic organization. | Planning - Brainstorm |
|
||||
| /planning:2-brainstorm:2-analyze-ideas | Analyzes generated ideas from brainstorming session, categorizes them, and suggests next steps for refinement. | Planning - Brainstorm |
|
||||
| /planning:2-brainstorm:3-generate-brainstorm-summary | Generates the final brainstorm summary document by consolidating all ideation and analysis from a session. | Planning - Brainstorm |
|
||||
| /planning:3-roadmap:1-create-from-mrd | Creates a PRD direction roadmap from an existing MRD, suggesting phased PRD development for key features with improvement directions. | Planning - Roadmap |
|
||||
| /planning:3-roadmap:2-create-from-brainstorm | Creates a PRD direction roadmap from a brainstorming session, suggesting phased PRD development for key features with improvement directions. | Planning - Roadmap |
|
||||
| /planning:create-app-design | Generate comprehensive app design document with project stage assessment. | Planning |
|
||||
| /planning:create-doc | Feature Documentation Generator instructions. | Planning |
|
||||
| /planning:create-prd-interactive | Generate a PRD interactively with clarifying questions for complex features. | Planning |
|
||||
| /planning:create-prd | Creates a PRD document compatible with Task Master's parse-prd command, with quick and interactive modes. | Planning |
|
||||
| /planning:create-rule | Create a new Cursor rule file with proper structure and conventions. | Planning |
|
||||
| /planning:create-tech-stack | Generate comprehensive technical stack documentation from codebase analysis. | Planning |
|
||||
| /planning:parse-prd | Parse a Product Requirements Document (PRD) text file to automatically generate initial tasks. | Planning |
|
||||
| /planning:update-app-design | Update existing app design document based on codebase changes and project evolution. | Planning |
|
||||
| /planning:update-project-structure | Update project structure documentation by running tree script. | Planning |
|
||||
| /planning:update-rule | Update an existing Cursor rule file with proper structure and conventions. | Planning |
|
||||
| /planning:update-tech-stack | Update existing tech stack documentation from codebase analysis. | Planning |
|
||||
| /research:architecture | Perform in-depth research on architectural patterns and best practices. | Research |
|
||||
| /research:security | Conduct comprehensive security research and vulnerability assessment. | Research |
|
||||
| /research:task | Research specific task implementation with best practices and alternatives. | Research |
|
||||
| /research:tech | Research technical solutions, frameworks, and implementation strategies. | Research |
|
||||
| /snippets:create-snippet | Generates a snippet template based on provided example code. | Snippets |
|
||||
| /task:add-interactive | Add new task interactively with guided questions. | Task Management |
|
||||
| /task:add | Add new task to project task list. | Task Management |
|
||||
| /task:done | Mark task as completed and update dependencies. | Task Management |
|
||||
| /task:expand | Expand task into subtasks with detailed planning. | Task Management |
|
||||
| /task:generate | Generate individual task files from tasks.json. | Task Management |
|
||||
| /task:list | List all project tasks with status. | Task Management |
|
||||
| /task:move | Move task to new position in hierarchy. | Task Management |
|
||||
| /task:next | Show next available task based on dependencies. | Task Management |
|
||||
| /task:research | Perform research for specific task. | Task Management |
|
||||
| /task:show | Display detailed task information. | Task Management |
|
||||
| /task:spec | Generate detailed task specification following end-to-end feature implementation guide. | Task Management |
|
||||
| /task:update-task-interactive | Update task interactively with guided questions. | Task Management |
|
||||
| /task:update-task | Update existing task with new information. | Task Management |
|
||||
| /sc:analyze | Performs multi-dimensional code and system analysis. | SuperClaude |
|
||||
| /sc:build | Project builder with framework detection. | SuperClaude |
|
||||
| /sc:cleanup | Project cleanup and technical debt reduction. | SuperClaude |
|
||||
| /sc:design | Design orchestration with MCP integration. | SuperClaude |
|
||||
| /sc:document | Create focused documentation for specific components or features. | SuperClaude |
|
||||
| /sc:estimate | Provide evidence-based time and cost estimates. | SuperClaude |
|
||||
| /sc:explain | Provide clear explanations of code, concepts, or system behavior. | SuperClaude |
|
||||
| /sc:git | Git workflow assistant with automation. | SuperClaude |
|
||||
| /sc:implement | Feature and code implementation with intelligent persona activation. | SuperClaude |
|
||||
| /sc:improve | Evidence-based code enhancement and optimization. | SuperClaude |
|
||||
| /sc:index | Command catalog browsing and discovery. | SuperClaude |
|
||||
| /sc:load | Project context loading and analysis. | SuperClaude |
|
||||
| /sc:spawn | Task orchestration with multi-agent coordination. | SuperClaude |
|
||||
| /sc:task | Long-term project management and task handling. | SuperClaude |
|
||||
| /sc:test | Testing workflow orchestration. | SuperClaude |
|
||||
| /sc:troubleshoot | Systematic problem investigation and resolution. | SuperClaude |
|
||||
| /sc:workflow | Generate structured implementation workflows from PRDs and feature requirements with expert guidance. | SuperClaude |
|
||||
Reference in New Issue
Block a user