AI-powered automatic documentation generator for VSCode.
Write code. Hover over any function. See documentation — automatically generated by AI.
Features
- Generates hover tooltips as you write code
- Supports Python, TypeScript and JavaScript
- Private dashboard to browse all your documented functions
- Redis caching for instant repeated lookups
- Documentation updates automatically on every save
Setup
1. Install the Extension
Search Auto-Doc Agent in the VSCode Extensions panel and click Install.
2. Get Your API Key
Go to auto-doc-agent.onrender.com, register or login, and copy your API key.
3. Add to VSCode Settings
Press Ctrl+Shift+P → Open User Settings (JSON) and add:
{
"autoDocAgent.apiUrl": "https://auto-doc-agent.onrender.com",
"autoDocAgent.apiKey": "autodoc_your_key_here"
}
4. Reload VSCode
Press Ctrl+Shift+P → Reload Window
5. Write Code
Open any .py, .ts or .js file, write a function, wait 3 seconds, hover over the function name.
Dashboard
Browse all your documented functions at:
auto-doc-agent.onrender.com/dashboard
Projects are organized by workspace folder. Each file and function is listed in the sidebar.
Settings
| Setting | Default | Description |
|---|---|---|
autoDocAgent.apiUrl |
https://auto-doc-agent.onrender.com |
Backend API URL |
autoDocAgent.apiKey |
"" |
Your API key |
autoDocAgent.enabled |
true |
Enable or disable |
autoDocAgent.debounceMs |
3000 |
Wait time after typing stops (ms) |