Skip to content

Commit 22336f7

Browse files
olasunkanmi-SEolasunkanmi-SE
authored
Merge pull request #294 from olasunkanmi-SE/development
update readMe
2 parents bfcb295 + 381d892 commit 22336f7

File tree

1 file changed

+54
-52
lines changed

1 file changed

+54
-52
lines changed

‎README.md‎

Lines changed: 54 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -30,47 +30,47 @@ flowchart TB
3030
Commands["⚡ Commands<br/>(Actions)"]
3131
Orchestrator["🎯 Orchestrator<br/>(Event Publisher)"]
3232
end
33-
33+
3434
subgraph AgentLayer["🤖 Agent Service Layer"]
3535
DeveloperAgent["🧠 Developer Agent<br/>(DeepAgents)"]
36-
36+
3737
subgraph SubAgents["Specialized Sub-Agents"]
3838
CodeAnalyzer["🔍 Code<br/>Analyzer"]
3939
DocWriter["📝 Doc<br/>Writer"]
4040
Debugger["🐛 Debugger"]
4141
FileOrganizer["📁 File<br/>Organizer"]
4242
end
4343
end
44-
44+
4545
subgraph Tools["🔧 Tool Provider"]
4646
WebSearch["🌐 Web<br/>Search"]
4747
FileTool["📄 File<br/>Tool"]
4848
ThinkTool["💭 Think<br/>Tool"]
4949
TavilySearch["🔎 Tavily<br/>Search"]
5050
end
51-
51+
5252
subgraph Backends["💾 Backend Systems"]
5353
Filesystem["📂 Filesystem<br/>(/workspace/)"]
5454
Store["🗄️ Store<br/>(/docs/)"]
5555
State["⚡ State<br/>(/ ephemeral)"]
5656
end
5757
end
58-
58+
5959
subgraph External["☁️ External Services"]
6060
Gemini["Gemini"]
6161
Anthropic["Anthropic"]
6262
Groq["Groq"]
6363
Deepseek["Deepseek"]
6464
Tavily["Tavily API"]
6565
end
66-
66+
6767
Webview --> DeveloperAgent
6868
Commands --> DeveloperAgent
6969
Orchestrator --> DeveloperAgent
70-
70+
7171
DeveloperAgent --> SubAgents
7272
DeveloperAgent --> Tools
73-
73+
7474
Tools --> Backends
7575
Tools --> External
7676
```
@@ -90,11 +90,11 @@ The core of CodeBuddy is built on **DeepAgents** and **LangGraph**, providing:
9090

9191
CodeBuddy uses a sophisticated three-tier storage system:
9292

93-
| Path | Backend | Persistence | Purpose |
94-
|------|---------|-------------|---------|
95-
| `/workspace/` | Filesystem | Permanent | Real file operations on your codebase |
96-
| `/docs/` | Store | Cross-session | Long-term knowledge and documentation |
97-
| `/` (root) | State | Session only | Temporary scratch space |
93+
| Path | Backend | Persistence | Purpose |
94+
| ------------- | ---------- | ------------- | ------------------------------------- |
95+
| `/workspace/` | Filesystem | Permanent | Real file operations on your codebase |
96+
| `/docs/` | Store | Cross-session | Long-term knowledge and documentation |
97+
| `/` (root) | State | Session only | Temporary scratch space |
9898

9999
---
100100

@@ -174,14 +174,14 @@ CodeBuddy uses a sophisticated three-tier storage system:
174174

175175
### Getting Your API Keys
176176

177-
| Provider | Get API Key |
178-
|----------|-------------|
179-
| Gemini | [Google AI Studio](https://aistudio.google.com/app/apikey) |
177+
| Provider | Get API Key |
178+
| --------- | --------------------------------------------------------------------------- |
179+
| Gemini | [Google AI Studio](https://aistudio.google.com/app/apikey) |
180180
| Anthropic | [Anthropic Console](https://docs.anthropic.com/en/docs/about-claude/models) |
181-
| Groq | [Groq Console](https://console.groq.com/keys) |
182-
| Deepseek | [Deepseek Platform](https://platform.deepseek.com/api_keys) |
183-
| XGrok | [X.AI Console](https://console.x.ai/) |
184-
| Tavily | [Tavily Dashboard](https://app.tavily.com/home) (for web search) |
181+
| Groq | [Groq Console](https://console.groq.com/keys) |
182+
| Deepseek | [Deepseek Platform](https://platform.deepseek.com/api_keys) |
183+
| XGrok | [X.AI Console](https://console.x.ai/) |
184+
| Tavily | [Tavily Dashboard](https://app.tavily.com/home) (for web search) |
185185

186186
---
187187

@@ -191,35 +191,33 @@ CodeBuddy uses a sophisticated three-tier storage system:
191191

192192
Right-click on selected code to access:
193193

194-
| Feature | Description |
195-
|---------|-------------|
196-
| 💭 Add Comments | Intelligent code documentation |
197-
| 🔍 Review Code | Comprehensive code analysis |
198-
| 🔄 Refactor Code | Smart code improvements |
199-
| ⚡ Optimize Code | Performance enhancements |
200-
| 💬 Explain Code | Clear explanations |
201-
| 📝 Generate Commit | Smart Git commit messages |
202-
| 💫 Inline Chat | Context-aware discussions |
203-
| 📚 Interview Me | Technical interview prep |
204-
| 📊 Generate Diagram | Mermaid diagram creation |
205-
| 🏗️ Analyze Codebase | Deep architectural analysis |
206-
| 🔍 Review PR | Pull request review |
194+
| Feature | Description |
195+
| ------------------- | ------------------------------ |
196+
| 💭 Add Comments | Intelligent code documentation |
197+
| 🔍 Review Code | Comprehensive code analysis |
198+
| 🔄 Refactor Code | Smart code improvements |
199+
| ⚡ Optimize Code | Performance enhancements |
200+
| 💬 Explain Code | Clear explanations |
201+
| 📝 Generate Commit | Smart Git commit messages |
202+
| 💫 Inline Chat | Context-aware discussions |
203+
| 📚 Interview Me | Technical interview prep |
204+
| 📊 Generate Diagram | Mermaid diagram creation |
205+
| 🏗️ Analyze Codebase | Deep architectural analysis |
206+
| 🔍 Review PR | Pull request review |
207207

208208
### ⌨️ Keyboard Shortcuts
209209

210-
| Command | Windows/Linux | macOS |
211-
|---------|---------------|-------|
212-
| Add Comment | `Ctrl+Shift+C` | `Cmd+Shift+C` |
213-
| Review Code | `Ctrl+Shift+R` | `Cmd+Shift+R` |
214-
| Refactor Code | `Ctrl+Shift+F` | `Cmd+Shift+F` |
215-
| Optimize Code | `Ctrl+Shift+O` | `Cmd+Shift+O` |
216-
| Explain Code | `Ctrl+Shift+E` | `Cmd+Shift+E` |
217-
| Generate Commit | `Ctrl+Shift+G` | `Cmd+Shift+G` |
218-
| Inline Chat | `Ctrl+Shift+I` | `Cmd+Shift+I` |
219-
| Interview Me | `Ctrl+Shift+M` | `Cmd+Shift+M` |
220-
| Generate Diagram | `Ctrl+Shift+D` | `Cmd+Shift+D` |
221-
| Analyze Codebase | `Ctrl+Shift+A` | `Cmd+Shift+A` |
222-
| Review PR | `Ctrl+Shift+P` | `Cmd+Shift+P` |
210+
| Command | Windows/Linux | macOS |
211+
| ----------------------------- | -------------- | ------------- |
212+
| Add Comment | `Ctrl+Shift+J` | `Cmd+Shift+J` |
213+
| Review Code | `Ctrl+Shift+R` | `Cmd+Shift+R` |
214+
| Refactor Code | `Ctrl+Shift+;` | `Cmd+Shift+;` |
215+
| Optimize Code | `Ctrl+Shift+O` | `Cmd+Shift+O` |
216+
| Explain Code | `Ctrl+Shift+1` | `Cmd+Shift+1` |
217+
| Generate Commit | `Ctrl+Shift+2` | `Cmd+Shift+2` |
218+
| Inline Chat | `Ctrl+Shift+8` | `Cmd+Shift+8` |
219+
| Generate Architecture Diagram | `Ctrl+Shift+8` | `Cmd+Shift+8` |
220+
| Analyze Codebase | `Ctrl+Shift+6` | `Cmd+Shift+6` |
223221

224222
> **Note:** Customize shortcuts in VS Code's Keyboard Shortcuts settings (`Cmd+K Cmd+S` / `Ctrl+K Ctrl+S`)
225223
@@ -323,13 +321,13 @@ codebuddy/
323321

324322
## 🔌 Supported AI Models
325323

326-
| Provider | Models | Best For |
327-
|----------|--------|----------|
328-
| **Gemini** | gemini-2.5-pro, gemini-1.5-flash | General purpose, embeddings |
324+
| Provider | Models | Best For |
325+
| ------------- | -------------------------------- | ------------------------------ |
326+
| **Gemini** | gemini-2.5-pro, gemini-1.5-flash | General purpose, embeddings |
329327
| **Anthropic** | claude-sonnet-4-5, claude-3-opus | Complex reasoning, code review |
330-
| **Groq** | llama-3.1-70b-versatile | Fast responses |
331-
| **Deepseek** | deepseek-chat | Cost-effective coding |
332-
| **XGrok** | grok-beta | Latest capabilities |
328+
| **Groq** | llama-3.1-70b-versatile | Fast responses |
329+
| **Deepseek** | deepseek-chat | Cost-effective coding |
330+
| **XGrok** | grok-beta | Latest capabilities |
333331

334332
---
335333

@@ -364,21 +362,25 @@ codebuddy/
364362
### Common Issues
365363

366364
**❓ Agent not responding**
365+
367366
- Verify API key is correct in settings
368367
- Check API quota/billing status
369368
- Try a different AI model
370369

371370
**❓ Mermaid diagrams not rendering**
371+
372372
- Diagrams auto-fix common syntax errors
373373
- Check console for specific parse errors
374374
- Try "Show Source Code" to see raw diagram
375375

376376
**❓ PR Review not working**
377+
377378
- Ensure you're in a Git repository
378379
- Check that you have multiple branches
379380
- Verify Git CLI is accessible
380381

381382
**❓ Slow responses**
383+
382384
- Try Groq for faster responses
383385
- Check internet connection
384386
- Clear cache with `CodeBuddy: Clear Cache`

0 commit comments

Comments
 (0)