VS Code extension
Explain selected code inline, and insert generated comments above it.
A separate extension from the CLI, for the other half of the job: explaining code while you are reading it, rather than documenting a whole repository.
Select some code, ask for an explanation, and optionally have the comment inserted above the selection.
Install
The extension lives in vscode-extension/ in the repository and ships on its
own release track, independent of the Python package.
cd vscode-extension
npm install && npm run package
code --install-extension deepdoc-*.vsixUsing it
Select code, then either hover for the DeepDoc · Fast | Deep actions or use a
shortcut:
| Mode | macOS | Windows / Linux |
|---|---|---|
| Fast | Cmd+Alt+E | Ctrl+Alt+E |
| Deep | Cmd+Alt+D | Ctrl+Alt+D |
Fast is a quick single-pass explanation. Deep spends longer and reasons further for code that needs it.
Commands
From the command palette:
| Command | |
|---|---|
DeepDoc: Fast | Explain the selection quickly |
DeepDoc: Deep | Explain it thoroughly |
DeepDoc: Test Connection | Check your provider and key work |
DeepDoc: Set API Key | Store a key securely |
DeepDoc: Clear API Key | Remove it |
Run Test Connection first. It surfaces a bad key or endpoint immediately, instead of letting your first real explanation fail confusingly.
Settings
Separate from your .deepdoc.yaml
The extension has its own settings and its own key. It does not read the CLI's config, so configure it independently.