👨🏫 Code Ustaad (Code उस्ताद)
Complex Code? Tension mat le, Ustaad hai na.
Code Ustaad is a VS Code and Cursor extension designed for developers who find English technical jargon overwhelming. It explains selected code snippets in Hinglish (Hindi + English), acting like a wise Senior Architect sitting right next to you.
It uses the "Bring Your Own Key" (BYOK) model—meaning you use your own API key (OpenAI or Gemini), keeping the extension free and open source forever.
✨ Features
- Hinglish Explanations: Get explanations that feel like a chat with a senior dev. ("Dekho bhai, scene kya hai...")
- Structured Responses: Every explanation starts with "🧐 Ek Line Mein" (TL;DR summary), followed by detailed breakdown.
- Ustaad ka Fix: When bugs are spotted, get copy-paste ready fixes in a dedicated code block.
- Syntax Highlighting: Beautiful code highlighting powered by highlight.js - looks like VS Code!
- Streaming Responses: See text appear in real-time, character by character - no more waiting!
- Multiple AI Providers: Choose between OpenAI (GPT) or Google Gemini - use whichever you have access to.
- Smart History Panel: Collapsible sidebar (🕒 button) with smart labels showing function/component names.
- Persona Modes: Choose Ustaad's teaching style - Strict, Balanced, or Funny (with tech slang!)
- Smart Context: Select even a single word - Ustaad grabs surrounding code for accurate explanations.
- Keyboard Shortcut:
Cmd+Shift+U (Mac) / Ctrl+Shift+U (Windows/Linux) for instant access.
- Secure Key Storage: API keys stored securely using VS Code's encrypted SecretStorage.
- Privacy First: Your code is sent directly to the AI provider using your key. No middleman servers.
- Zero Cost: Free to use (you only pay for your API usage).
- Works in Cursor: Fully compatible with Cursor AI code editor.
🚀 How to Use (Kaise Use Karein)
- Install the extension from the VS Code Marketplace (or load locally).
- Set API Key: Run command
Code Ustaad: Set API Key (Cmd+Shift+P → type "Set API Key").
- Select Code: Highlight any confusing function or logic block.
- Ask Ustaad:
- Keyboard:
Cmd+Shift+U (Mac) / Ctrl+Shift+U (Windows/Linux)
- Right-click: Select "Ask Ustaad" from context menu
- Learn: Read the streaming explanation in the side panel!
⚙️ Configuration
Commands
| Command |
Description |
Code Ustaad: Set API Key |
Securely store your API key (encrypted) |
Code Ustaad: Clear API Key |
Remove stored API key |
Ask Ustaad |
Explain selected code (also via right-click or keyboard shortcut) |
Settings
| Setting |
Description |
codeUstaad.provider |
Choose AI provider: openai or gemini (default: gemini) |
codeUstaad.geminiModel |
Gemini model to use (default: gemini-2.5-flash) |
codeUstaad.openaiModel |
OpenAI model to use (default: gpt-4o-mini) |
codeUstaad.personaIntensity |
Ustaad's teaching style: strict, balanced, or funny (default: balanced) |
codeUstaad.maxHistoryItems |
Number of explanations to keep in history (default: 10, max: 50) |
Keyboard Shortcuts
| Shortcut |
Platform |
Action |
Cmd+Shift+U |
Mac |
Ask Ustaad |
Ctrl+Shift+U |
Windows/Linux |
Ask Ustaad |
Persona Modes
| Mode |
Description |
| Strict |
Senior Tech Lead mode. No sugarcoating - "Production mein fat jayega!" |
| Balanced |
Helpful Senior Dev (Bhai) with daily life analogies. (Default) |
| Funny |
Mumbai/Bangalore tech slang with roasts! "Yeh code Jalebi jaisa uljha hai!" |
🛠️ Installation for Developers (Local Setup)
Want to contribute? Aaja maidan mein!
Clone the repo:
git clone https://github.com/sakshya73/code-ustaad.git
cd code-ustaad
Install dependencies:
npm install
Compile the extension:
npm run compile
Run the extension:
Press F5 to open a new VS Code/Cursor window with the extension loaded.
📜 Scripts
| Command |
Description |
npm run compile |
Compile TypeScript to JavaScript |
npm run watch |
Watch mode for development |
npm run lint |
Run Biome linter |
npm run lint:fix |
Auto-fix linting issues |
npm run format |
Format code with Biome |
❓ Troubleshooting (Kuch Gadbad Hai?)
- Error: "Quota exceeded" / 429:
- This means your free API limit is over for the day.
- Fix: Wait for a while or try a different API key.
- Error: "API Key Invalid":
- You might have pasted the key with extra spaces.
- Fix: Run
Code Ustaad: Clear API Key and set it again carefully.
- History sidebar disappeared?
- Click the "🕒 History" button in the top right of the Code Ustaad panel to toggle it back.
🤝 Contributing
We welcome contributions! Whether it's improving the "Ustaad" system prompt to be funnier, adding new features, or fixing bugs.
- Fork the repo.
- Create a feature branch (
git checkout -b feature/better-jokes).
- Commit your changes.
- Open a Pull Request.
🔒 Privacy
Your code is sent directly to OpenAI/Gemini using your own API key. We don't store, see, or process your code on any server. Read full Privacy Policy
📜 License
MIT License. Dil khol ke use karo.
Made with ❤️ and ☕
