mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-02-14 02:42:04 +08:00
a944e31962
- Introduced new analysis templates for architecture, implementation patterns, performance, quality, and security. - Created detailed development templates for component creation, debugging, feature implementation, refactoring, testing, and migration planning. - Established structured documentation guidelines for root, domain, module, and sub-module levels to enhance clarity and organization. - Implemented a hierarchy analysis template to optimize project structure and documentation depth. - Updated codex-unified documentation to reflect new command structures, template usage, and best practices for autonomous development workflows.
181 lines
6.7 KiB
Markdown
181 lines
6.7 KiB
Markdown
---
|
|
name: gemini-unified
|
|
description: Consolidated Gemini CLI guidelines - core rules, syntax, patterns, templates, and best practices
|
|
type: technical-guideline
|
|
---
|
|
|
|
### 🚀 Command Overview: `gemini`
|
|
|
|
- **Purpose**: A CLI tool for comprehensive codebase analysis, context gathering, and pattern detection across multiple files.
|
|
- **Primary Triggers**:
|
|
- When user intent is to "analyze", "get context", or "understand the codebase".
|
|
- When a task requires understanding relationships between multiple files.
|
|
- When the problem scope exceeds a single file.
|
|
- **Core Use Cases**:
|
|
- Project-wide context acquisition.
|
|
- Architectural analysis and pattern detection.
|
|
- Identification of coding standards and conventions.
|
|
|
|
### ⚙️ Command Syntax & Arguments
|
|
|
|
- **Basic Structure**:
|
|
```bash
|
|
gemini [flags] -p "@{patterns} {template} prompt"
|
|
```
|
|
- **Key Arguments**:
|
|
- `--all-files`: Includes all files in the current working directory.
|
|
- `-p`: The prompt string, which must contain file reference patterns and the analysis query.
|
|
- `{template}`: Template injection using `$(cat ~/.claude/workflows/cli-templates/prompts/[category]/[template].txt)` for standardized analysis
|
|
- `@{pattern}`: A special syntax for referencing files and directories.
|
|
|
|
- **Template Usage**:
|
|
```bash
|
|
# Without template (manual prompt)
|
|
gemini -p "@{src/**/*} @{CLAUDE.md} Analyze code patterns and conventions"
|
|
|
|
# With template (recommended)
|
|
gemini -p "@{src/**/*} @{CLAUDE.md} $(cat ~/.claude/workflows/cli-templates/prompts/analysis/pattern.txt)"
|
|
|
|
# Multi-template composition
|
|
gemini -p "@{src/**/*} @{CLAUDE.md} $(cat <<'EOF'
|
|
$(cat ~/.claude/workflows/cli-templates/prompts/analysis/architecture.txt)
|
|
|
|
Additional Security Focus:
|
|
$(cat ~/.claude/workflows/cli-templates/prompts/analysis/security.txt)
|
|
EOF
|
|
)"
|
|
```
|
|
|
|
|
|
### 📂 File Pattern Rules
|
|
|
|
- **Syntax**:
|
|
- `@{pattern}`: Single file or directory pattern.
|
|
- `@{pattern1,pattern2}`: Multiple patterns, comma-separated.
|
|
- **Wildcards**:
|
|
```bash
|
|
* # Any character (excluding path separators)
|
|
** # Any directory levels (recursive)
|
|
? # Any single character
|
|
[abc] # Any character within the brackets
|
|
{a,b,c} # Any of the options within the braces
|
|
```
|
|
- **Cross-Platform Rules**:
|
|
- Always use forward slashes (`/`) for paths.
|
|
- Enclose paths with spaces in quotes: `@{"My Project/src/**/*"}`.
|
|
- Escape special characters like brackets: `@{src/**/*\[bracket\]*}`.
|
|
|
|
|
|
### TPL (Templates)
|
|
|
|
#### 🗂️ Shared Template Directory Structure
|
|
Templates are shared between gemini and codex. This structure can be located at either `~/.claude/workflows/cli-templates/` (global) or `./.claude/workflows/cli-templates/` (project-specific).
|
|
|
|
~/.claude/workflows/cli-templates/
|
|
├── prompts/
|
|
│ ├── analysis/ # Code analysis templates
|
|
│ │ ├── pattern.txt # ✨ Implementation patterns & conventions
|
|
│ │ ├── architecture.txt # 🏗️ System architecture & dependencies
|
|
│ │ ├── security.txt # 🔒 Security vulnerabilities & protection
|
|
│ │ ├── performance.txt # ⚡ Performance bottlenecks & optimization
|
|
│ │ └── quality.txt # 📊 Code quality & maintainability
|
|
│ ├── planning/ # Planning templates
|
|
│ │ ├── task-breakdown.txt # 📋 Task decomposition & dependencies
|
|
│ │ └── migration.txt # 🚀 System migration & modernization
|
|
│ ├── implementation/ # Development templates
|
|
│ │ └── component.txt # 🧩 Component design & implementation
|
|
│ ├── review/ # Review templates
|
|
│ │ └── code-review.txt # ✅ Comprehensive review checklist
|
|
│ └── dms/ # DMS-specific
|
|
│ └── hierarchy-analysis.txt # 📚 Documentation structure optimization
|
|
└── commands/ # Command examples
|
|
|
|
|
|
#### 🧭 Template Selection Guide
|
|
| Task Type | Primary Template | Purpose |
|
|
|---|---|---|
|
|
| Understand Existing Code | `pattern.txt` | Codebase learning, onboarding. |
|
|
| Plan New Features | `task-breakdown.txt`| Feature development planning. |
|
|
| Security Review | `security.txt` | Security audits, vulnerability assessment. |
|
|
| Performance Tuning | `performance.txt` | Bottleneck investigation. |
|
|
| Code Quality Improvement | `quality.txt` | Refactoring, technical debt reduction. |
|
|
| System Modernization | `migration.txt` | Tech upgrades, architectural changes. |
|
|
| Component Development | `component.txt` | Building reusable components. |
|
|
| Pre-Release Review | `code-review.txt` | Release readiness checks. |
|
|
|
|
|
|
### 📦 Standard Command Structures
|
|
|
|
These are recommended command templates for common scenarios.
|
|
|
|
- **Basic Structure (Manual Prompt)**
|
|
```bash
|
|
gemini --all-files -p "@{target_patterns} @{CLAUDE.md,**/*CLAUDE.md}
|
|
|
|
Context: [Analysis type] targeting @{target_patterns}
|
|
Guidelines: Include CLAUDE.md standards
|
|
|
|
## Analysis:
|
|
1. [Point 1]
|
|
2. [Point 2]
|
|
|
|
## Output:
|
|
- File:line references
|
|
- Code examples"
|
|
```
|
|
|
|
- **Template-Enhanced (Recommended)**
|
|
```bash
|
|
# Using a predefined template for consistent, high-quality analysis
|
|
gemini --all-files -p "@{target_patterns} @{CLAUDE.md,**/*CLAUDE.md} $(cat ~/.claude/workflows/cli-templates/prompts/[category]/[template].txt)
|
|
|
|
## Analysis:
|
|
1. [Point 1]
|
|
2. [Point 2]
|
|
|
|
## Output:
|
|
- File:line references
|
|
- Code examples"
|
|
"
|
|
```
|
|
|
|
- **Multi-Template Composition**
|
|
```bash
|
|
gemini -p "@{src/**/*} @{CLAUDE.md}
|
|
$(cat ~/.claude/workflows/cli-templates/prompts/analysis/pattern.txt)
|
|
|
|
Additional Security Focus:
|
|
$(cat ~/.claude/workflows/cli-templates/prompts/analysis/security.txt)
|
|
|
|
## Analysis:
|
|
1. [Point 1]
|
|
2. [Point 2]
|
|
|
|
## Output:
|
|
- File:line references
|
|
- Code examples"
|
|
"
|
|
```
|
|
|
|
### ⭐ Best Practices & Rules
|
|
|
|
|
|
**When to Use @ Patterns:**
|
|
1. **User explicitly provides @ patterns** - ALWAYS preserve them exactly
|
|
2. **Cross-directory analysis** - When analyzing relationships between modules
|
|
3. **Configuration files** - When analyzing scattered config files
|
|
4. **Selective inclusion** - When you only need specific file types
|
|
|
|
**CLAUDE.md Loading Rules:**
|
|
- **With --all-files**: CLAUDE.md files automatically included (no @ needed)
|
|
- **Without --all-files**: Must use `@{CLAUDE.md}` or `@{**/CLAUDE.md}`
|
|
|
|
|
|
#### ⚠️ Error Prevention
|
|
|
|
- **Quote paths with spaces**: Use proper shell quoting
|
|
- **Test patterns first**: Validate @ patterns match existing files
|
|
- **Prefer directory navigation**: Reduces complexity and improves performance
|
|
- **Preserve user patterns**: When user provides @, always keep them
|
|
|