Install Odoo Helper for VS Code

Install the extension from the VS Code Marketplace, Open VSX or a .vsix file, then open a folder that contains Odoo modules.

Using Assista IDE?

Assista IDE bundles these features. You do not need to install the extension there.

Requirements

• VS Code 1.85 or newer.
• An Odoo 18, 19 or 20 codebase.

Install

VS Code Marketplace

1. Open the Extensions view (Ctrl+Shift+X).
2. Search for "Cybrosys Assista: Odoo Helper".
3. Select Install on the extension published by CybrosysTechnologiesOdooOfficialPartner.

Command line

code --install-extension CybrosysTechnologiesOdooOfficialPartner.cybrosys-assista-odoo-helper

Open VSX

1. Open the extension's page on Open VSX
   (publisher cybrosys-assista-ltd).
2. Install it from your editor's extension view,
   or download the .vsix file and follow the .vsix steps.

.vsix file

1. Open the Command Palette (Ctrl+Shift+P).
2. Run "Extensions: Install from VSIX...".
3. Select the .vsix file.

You can also install from the VS Code Marketplace page. On macOS, use Cmd in place of Ctrl.

Verify the installation

1. Open a folder that contains Odoo modules. The extension activates when the workspace has a __manifest__.py or an odoo/release.py.
2. Check the status bar for the Odoo version, for example Odoo v20 (Auto).
3. Right-click a folder in the Explorer and confirm Assista Odoo is in the menu.
4. Type odoo in a .py or .xml file and confirm snippets appear.

Set the Odoo version

With the default auto setting, the extension detects the version in this order:

1. odoo/release.py in the workspace.
2. odoo/release.py under the Odoo Source Path setting, then under $ODOO_HOME.
3. An odoo pin in requirements*.txt, .in or .ini files.
4. Otherwise Odoo 20.

Versions above 20 are treated as 20, and older ones as 18. To change the version, click the status bar item or run Assista: Set Odoo Version.

Settings

Setting	Default	Description
cybrosys-assista-odoo-helper.odooVersion	auto	auto, 18, 19 or 20.
cybrosys-assista-odoo-helper.odooSourcePath	empty	Folder with odoo/release.py. Used for version detection and Odoo's CSS classes.
cybrosys-assista-odoo-helper.enableCodeStandardWarnings	false	Turns on the code standards linter.
cybrosys-assista-odoo-helper.indexing.enableCoreIndexing	true	Indexes Python models, fields and methods. Needed for most completions and navigation.
cybrosys-assista-odoo-helper.indexing.enableRegistryIndexing	true	Indexes JavaScript registries (widgets, client actions, public components).
cybrosys-assista-odoo-helper.indexing.enableCSSIndexing	true	Indexes CSS and SCSS classes for class="..." completion.
cybrosys-assista-odoo-helper.indexing.enableAdvanceCSSIndexing	false	Enables Go to Definition for CSS classes.

Tips and limits

• VS Code updates the extension automatically. To rebuild the index after a problem, run Assista: Remove Index Data (Clear Cache), then reload the window.
• Open VSX publishes the extension as cybrosys-assista-ltd.cybrosys-assista-odoo-helper, a different ID from the Marketplace listing.

Next steps

• Create your first module
• Fix a problem