Skip to content

Commit be2c0ce

Browse files
committed
Update README with complete feature list, all AI providers, and comprehensive documentation
- Added AI Flexibility section with all 4 providers (Gemini, OpenRouter, Ollama Cloud, Local Ollama) - Expanded configuration table with all settings - Complete commands list with keyboard shortcuts - Added What Makes Vertex Unique section - Privacy & Security section highlighting local options - Supported languages list - Link to comprehensive DOCS.md
1 parent 8e111a1 commit be2c0ce

1 file changed

Lines changed: 92 additions & 5 deletions

File tree

README.md

Lines changed: 92 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,37 @@
1212
### 🧠 Visual Intelligence
1313
- **Dynamic Call Graph**: A side-by-side view that traces relationships in your code.
1414
- **Living Arrows**: Real-time SVG arrows connect variable usage to definitions and function calls to sources.
15-
- **Cross-Language Support**: Intelligent parsing for **JavaScript/TypeScript, Python, Java, C, and C++**.
15+
- **Cross-Language Support**: Intelligent parsing for **JavaScript, TypeScript, Python, Java, C, C++, and Go**.
16+
- **Real-time Updates**: Automatically refreshes as you type to show live code relationships.
17+
- **Cursor Sync**: Highlights code elements as you navigate through your file.
1618

1719
### 🧘 Sensei: Motivational AI
18-
- **Gemini Powered**: Uses Google Gemini to provide context-aware, motivational feedback.
20+
- **Multi-Provider Support**: Choose from **Gemini**, **OpenRouter**, **Ollama Cloud**, or **Local Ollama**.
21+
- **Flexible AI Models**: Select different models for different tasks (Sensei feedback vs code generation).
22+
- **Context-Aware Feedback**: Provides motivational insights based on your current code and progress.
1923
- **Non-Intrusive**: Feedback appears in the status bar to keep your workspace clean.
2024
- **Smart Debouncing**: Sensei watches your progress and speaks up when you need a boost.
25+
- **Secure API Keys**: All API keys are stored securely in VS Code's Secret Storage.
26+
27+
### 🎯 AI Flexibility
28+
- **Multiple AI Providers**: Seamlessly switch between Gemini, OpenRouter, Ollama Cloud, and Local Ollama.
29+
- **Provider-Specific Configuration**: Set different providers for Sensei feedback and code generation.
30+
- **Model Selection**: Choose from multiple Gemini models (gemini-2.0-flash, gemini-2.5-flash, gemini-2.5-pro, gemini-1.5-flash-latest).
31+
- **Local Development**: Full support for local Ollama models for offline development.
32+
- **Quick Switching**: Use keyboard shortcuts (`Ctrl+J` / `Cmd+J`) to quickly change models mid-session.
2133

2234
---
2335

2436
## 🚀 Quick Start
2537

2638
### 1. Prerequisites
27-
- **VS Code**: v1.9x+
28-
- **Gemini API Key**: If not set in your environment (`GEMINI_API_KEY`), Vertex will securely prompt you for it and store it in your VS Code Secret Storage.
39+
- **VS Code**: v1.107.0+
40+
- **AI Provider**: Choose one or more:
41+
- **Gemini API Key** (default)
42+
- **OpenRouter API Key**
43+
- **Ollama Cloud API Key**
44+
- **Local Ollama** (no API key needed)
45+
- Vertex will securely prompt you for API keys on first use and store them in VS Code's Secret Storage.
2946

3047
### 2. Loading a Lesson
3148
Run the command `Vertex: Load Sample Lesson` from the Command Palette (`Ctrl+Shift+P`).
@@ -37,9 +54,79 @@ Run the command `Vertex: Show Visual Intelligence` to open the side-by-side visu
3754

3855
## ⚙️ Configuration
3956

57+
### AI Provider Settings
4058
| Setting | Description | Default |
4159
|---------|-------------|---------|
42-
| `vertex.geminiModel` | Select between `gemini-1.5-flash` or `gemini-1.5-pro` | `gemini-1.5-flash` |
60+
| `vertex.aiProvider` | Global fallback AI provider | `Gemini` |
61+
| `vertex.senseiProvider` | AI provider for Sensei feedback | `Gemini` |
62+
| `vertex.codeGenProvider` | AI provider for code generation | `Gemini` |
63+
| `vertex.senseiModel` | Model used by Sensei | `gemini-2.0-flash` |
64+
| `vertex.codeGenModel` | Model used for code generation | `gemini-2.0-flash` |
65+
### Learning Commands
66+
- `Vertex: Load Sample Lesson` – Start a guided coding lesson with ghost text.
67+
- `Vertex: Clear Lesson` – Clear all decorations and active lessons.
68+
- `Vertex: Run Current Code` – Execute the current file.
69+
70+
### Visualization Commands
71+
- `Vertex: Show Visual Intelligence` – Open the visual intelligence sidebar.
72+
- `Vertex: Toggle Visual Intelligence` – Toggle the visualizer on/off (`Ctrl+Shift+V` / `Cmd+Shift+V`).
73+
74+
### AI Configuration Commands
75+
- `Vertex: Select Gemini Model` – Choose which Gemini model to use (`Ctrl+J` / `Cmd+J`).
76+
- `Vertex: Ask Sensei for Code` – Get AI-powered code suggestions (`Ctrl+I` / `Cmd+I`).
77+
- `Vertex: Reset Gemini API Key` – Clear and re-enter your Gemini API key.
78+
- `Vertex: Reset OpenRouter API Key` – Clear and re-enter your OpenRouter API key.
79+
- `Vertex: Reset Ollama Cloud API Key` – Clear and re-enter your Ollama Cloud API key.
80+
- `Vertex: Reset ALL API Keys` – Clear all stored API keys at once.
81+
82+
### Keyboard Shortcuts
83+
- `Ctrl+I` / `Cmd+I` – Ask Sensei for code suggestions
84+
- `Ctrl+Shift+V` / `Cmd+Shift+V` – Toggle Visual Intelligence
85+
- `Ctrl+J` / `Cmd+J` – Select AI model
86+
- `Ctrl+H` / `Cmd+H` – Change AI provider
87+
88+
---
89+
90+
## 🎓 What Makes Vertex Unique?
91+
92+
Vertex combines three powerful learning paradigms:
93+
94+
1. **Interactive Learning** - Type along with ghost text guidance, getting instant feedback on every character you type.
95+
96+
2. **Visual Understanding** - See code relationships come alive with dynamic graphs showing how your variables, functions, and calls connect.
97+
98+
3. **AI Mentorship** - Get encouragement and code assistance from multiple AI providers, with the flexibility to choose what works best for you.
99+
100+
## 🔒 Privacy & Security
101+
102+
- **Secure Storage**: All API keys are encrypted and stored in VS Code's Secret Storage
103+
- **Local Option**: Use Local Ollama for complete privacy - your code never leaves your machine
104+
- **No Telemetry**: Vertex doesn't collect or send any usage data
105+
- **Open Source**: Review the code and contribute on GitHub
106+
107+
## 🌍 Supported Languages
108+
109+
- JavaScript & TypeScript
110+
- Python
111+
- Java
112+
- C & C++
113+
- Go
114+
- HTML & CSS
115+
- More coming soon!
116+
117+
## 📚 Documentation
118+
119+
For comprehensive API documentation and advanced usage, see [DOCS.md](DOCS.md).
120+
121+
---
122+
*Ollama Cloud** - Cloud-hosted Ollama models (requires API key)
123+
- **Local Model (Ollama)** - Run models locally on your machine (no API key needed)
124+
125+
### Supported Gemini Models
126+
- `gemini-2.0-flash` (default, fastest)
127+
- `gemini-2.5-flash` (faster, newer)
128+
- `gemini-2.5-pro` (most capable)
129+
- `gemini-1.5-flash-latest` (latest stable)
43130

44131
---
45132

0 commit comments

Comments
 (0)