VNI-EX: TODO Checklist & AI Assistant in VS Code
VNI-EX is a Visual Studio Code extension designed to turn your editor into a smarter workspace. It helps you manage your TODO list directly within your source code and leverages the power of Google Gemini AI to automate code writing, allowing you to focus on more critical problems.
✨ Key Features
- ✅ Manage TODOs in Your Code: Automatically finds and displays TODO comments (e.g.,
// [ ]) in a dedicated sidebar view.
- 🤖 Gemini AI Integration: Send tasks marked with
[g] to the AI. The AI reads the file's context and automatically generates code to complete the task.
- ✍️ Apply Code Automatically: The AI-generated code is inserted directly into your file, ready for your review.
- 🔄 Clear Workflow: Easily track task progress through distinct states:
[ ] (Todo) → [g] (Send to AI) → [t] (To Review) → [x] (Completed).
- 👁️ Provide Context: Mark comments with
[v] to include the entire file as context for the AI without assigning a specific task.
- 🖱️ Quick Navigation: Click a task in the sidebar to jump directly to the corresponding line of code.
- ⌨️ Convenient Shortcuts: Quickly add new TODO or Context lines using commands and custom keybindings.
🚀 Workflow
Working with VNI-EX is simple and intuitive. Just follow these steps:
Step 1: Create a New Task [ ] or Add Context [v]
Whenever you need to note a task, add a comment in your code with the format // [ ] Task description.
Example:
// [ ]: Create a function to sum two numbers, a and b
To add an entire file for the AI to use as context, use the [v] (view-only) state. The AI will read this file but won't try to modify it.
Example:
// [v]: This file contains shared utility types for the project.
For convenience, use the VNI-EX: Add TODO Comment command (Ctrl+G Ctrl+G) to insert // [ ]: . You can create a custom keybinding for adding context comments.
Step 2: Send a Task to the AI [g]
When you're ready for the AI to handle a task, change its state from [ ] to [g] (for "go" or "generate").
// [g]: Create a function to sum two numbers, a and b
Then, open the VNI-EX sidebar and click the "Send X tasks to AI" button. The extension will send the request along with the context of the relevant file(s) to Gemini.
Step 3: Review the AI-Generated Code [t]
After a few seconds, the AI will complete the task. VNI-EX will automatically:
- Insert the generated code snippet right below your comment line.
- Update the task's status to
[t] (for "to review").
// [t]: Create a function to sum two numbers, a and b
function sum(a, b) {
return a + b;
}
At this point, you should review the AI-generated code to ensure it is correct and secure.
Step 4: Mark as Completed [x]
Once you are satisfied with the code, click on the task's status ([t]) in the sidebar. The status will update to [x] (completed), marking the task as finished. You can then delete the task from the view to clean up your list.
⚙️ Installation and Configuration
- Open VS Code.
- Go to the Extensions tab (Ctrl+Shift+X).
- Search for
VNI-EX and click Install.
To use the AI features, you must provide a Google Gemini API Key.
Get your API Key:
Add the API Key to VS Code:
- Open Settings (Ctrl+,).
- Search for
vni-ex.geminiApiKey.
- Paste your API Key into the input field.
Other Settings
You can customize the following settings in the VS Code Settings UI:
vni-ex.geminiModel: Choose the Gemini model you want to use. The default is gemini-2.5-flash, with gemini-2.5-pro being a recommended, more powerful option.vni-ex.includeFilePatterns: Glob patterns for files to be scanned (e.g., **/*.{js,ts,py}).vni-ex.excludeFilePattern: Glob patterns for files/directories to be ignored (e.g., **/node_modules/**).
📚 Commands and Shortcuts
VNI-EX: Refresh Checklist: Rescans the entire workspace and updates the TODO list.VNI-EX: Add TODO Comment: Inserts a // [ ]: comment line at the cursor's position.
- Recommended keybinding (add to
keybindings.json): Ctrl+G Ctrl+G.
🤝 Contributing
If you find a bug or have an idea to improve the extension, please create an Issue on the project's GitHub page. All contributions are welcome!
Happy coding with VNI-EX!
