Skip to content

Commit c27ed8c

Browse files
catlog22claude
andcommitted
docs: Add comprehensive configuration sections
### Added Configuration Details - **Gemini CLI Setup**: Essential settings.json configuration - **.geminiignore**: Performance optimization guidelines - **MCP Tools**: Complete setup guide with links and benefits - Exa MCP Server for external API patterns - Code Index MCP for advanced code search - Benefits and automatic fallback explanation ### Improvements - Organized configuration into three clear sections: Essential, Recommended, Optional - Added installation guide links for MCP servers - Clarified that MCP tools are completely optional - Consistent bilingual documentation structure 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 39051e5 commit c27ed8c

File tree

2 files changed

+80
-6
lines changed

2 files changed

+80
-6
lines changed

README.md

Lines changed: 40 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,17 +116,54 @@ After installation, run the following command to ensure CCW is working:
116116

117117
---
118118

119-
## ⚙️ Essential Configuration
119+
## ⚙️ Configuration
120120

121-
For optimal integration, configure your Gemini CLI settings by creating a `settings.json` file in `~/.gemini/`:
121+
### **Essential: Gemini CLI Setup**
122+
123+
Configure Gemini CLI for optimal integration:
122124

123125
```json
124126
// ~/.gemini/settings.json
125127
{
126128
"contextFileName": "CLAUDE.md"
127129
}
128130
```
129-
This ensures CCW's intelligent documentation system works seamlessly with the Gemini CLI.
131+
132+
### **Recommended: .geminiignore**
133+
134+
Optimize performance by excluding unnecessary files:
135+
136+
```bash
137+
# .geminiignore (in project root)
138+
/dist/
139+
/build/
140+
/node_modules/
141+
/.next/
142+
*.tmp
143+
*.log
144+
/temp/
145+
146+
# Include important docs
147+
!README.md
148+
!**/CLAUDE.md
149+
```
150+
151+
### **Optional: MCP Tools** *(Enhanced Analysis)*
152+
153+
MCP (Model Context Protocol) tools provide advanced codebase analysis. **Completely optional** - CCW works perfectly without them.
154+
155+
#### Available MCP Servers
156+
157+
| MCP Server | Purpose | Installation Guide |
158+
|------------|---------|-------------------|
159+
| **Exa MCP** | External API patterns & best practices | [Install Guide](https://github.com/exa-labs/exa-mcp-server) |
160+
| **Code Index MCP** | Advanced internal code search | [Install Guide](https://github.com/johnhuang316/code-index-mcp) |
161+
162+
#### Benefits When Enabled
163+
- 📊 **Faster Analysis**: Direct codebase indexing vs manual searching
164+
- 🌐 **External Context**: Real-world API patterns and examples
165+
- 🔍 **Advanced Search**: Pattern matching and similarity detection
166+
- ⚡ **Automatic Fallback**: Uses traditional tools when MCP unavailable
130167

131168
---
132169

README_CN.md

Lines changed: 40 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,17 +116,54 @@ bash <(curl -fsSL https://raw.githubusercontent.com/catlog22/Claude-Code-Workflo
116116

117117
---
118118

119-
## ⚙️ 核心配置
119+
## ⚙️ 配置
120120

121-
为实现最佳集成,请在 `~/.gemini/` 中创建一个 `settings.json` 文件来配置您的 Gemini CLI 设置:
121+
### **必需: Gemini CLI 设置**
122+
123+
配置 Gemini CLI 以实现最佳集成:
122124

123125
```json
124126
// ~/.gemini/settings.json
125127
{
126128
"contextFileName": "CLAUDE.md"
127129
}
128130
```
129-
这确保了 CCW 的智能文档系统能与 Gemini CLI 无缝协作。
131+
132+
### **推荐: .geminiignore**
133+
134+
通过排除不必要的文件来优化性能:
135+
136+
```bash
137+
# .geminiignore (在项目根目录)
138+
/dist/
139+
/build/
140+
/node_modules/
141+
/.next/
142+
*.tmp
143+
*.log
144+
/temp/
145+
146+
# 包含重要文档
147+
!README.md
148+
!**/CLAUDE.md
149+
```
150+
151+
### **可选: MCP 工具** *(增强分析)*
152+
153+
MCP (模型上下文协议) 工具提供高级代码库分析。**完全可选** - CCW 在没有它们的情况下也能完美工作。
154+
155+
#### 可用的 MCP 服务器
156+
157+
| MCP 服务器 | 用途 | 安装指南 |
158+
|------------|------|---------|
159+
| **Exa MCP** | 外部 API 模式和最佳实践 | [安装指南](https://github.com/exa-labs/exa-mcp-server) |
160+
| **Code Index MCP** | 高级内部代码搜索 | [安装指南](https://github.com/johnhuang316/code-index-mcp) |
161+
162+
#### 启用后的好处
163+
- 📊 **更快分析**: 直接代码库索引 vs 手动搜索
164+
- 🌐 **外部上下文**: 真实世界的 API 模式和示例
165+
- 🔍 **高级搜索**: 模式匹配和相似性检测
166+
- ⚡ **自动回退**: MCP 不可用时使用传统工具
130167

131168
---
132169

0 commit comments

Comments
 (0)