Troubleshooting
Fix common problems with Odoo Helper for VS Code. If your problem is not listed, see Support.
Menus or commands are missing
Assista Odoo does not appear in the Explorer menu, or commands cannot be found.
- Open a folder that contains Odoo modules. The extension activates only when the workspace has a
__manifest__.pyor anodoo/release.py. - Check that the extension is installed and enabled in the Extensions view.
- Reload the window: run Developer: Reload Window from the Command Palette (
Ctrl+Shift+P). - Right-click a folder inside a module for file and component generators. Model and controller files cannot be created at a module's root.
The extension is not found or does not install
- Search for
Cybrosys Assista: Odoo Helperin the Extensions view, or runcode --install-extension CybrosysTechnologiesOdooOfficialPartner.cybrosys-assista-odoo-helper. - The extension needs VS Code 1.85 or newer. Update VS Code if the install is refused.
- If your editor uses Open VSX, search for
cybrosys-assista-ltd.cybrosys-assista-odoo-helper, or install a.vsixfile with Extensions: Install from VSIX.... - See Installation.
A create command shows an error
The file, module and component commands show a message when they cannot continue.
| Message | What to do |
|---|---|
Creation is not allowed in module root directory or outside of module directory | Right-click a subfolder of a module, such as models or views. Model, controller and view files cannot go at the module root. |
Security file creation is only allowed in the security directory inside a valid Odoo module | Right-click the module's security folder. |
File "<name>" already exists | Choose another name. The extension never overwrites a file. |
Only lowercase letters and underscores allowed or Only small letters and underscores allowed | Remove digits, dots, spaces and capitals from the name. Do not type the extension. |
Module "<name>" already exists | Choose another module name, or another parent folder. |
Folder <name> already exists | The OWL component or POS screen folder is already there. Rename or delete it, or choose another name. |
Owl component creation is only allowed in a valid Odoo module | Right-click a folder inside a module, one with a __manifest__.py above it. |
Add to Init only works for Python files and directories | Run Add to __init__.py on a .py file or a folder. |
Model tools do not appear or stop
- Odoo Model Tools appears only when the cursor is inside a model class in a Python file.
Create Views can only be used inside an Odoo ModuleorCreate Report can only be used inside an Odoo Modulemeans the file is not under a folder with a__manifest__.py.View creation for inherited models is not supported yetmeans the class extends an existing model. Create the views by hand, or with the File creator.Views file already existsandReport file '<name>' already existsmean a previous run created the file. Delete or rename it to run again.Access rights already exist for model <name>means the access file already has a row for the model.Create Access Right needs the model to be inside an Odoo modulemeans the module folder has no__manifest__.pyand__init__.py.- Fields come from the index. If a new field is missing from a picker, wait for indexing to finish.
Add File to Manifest fails
Could not find "data" list in __manifest__.py: add adatalist to the manifest first.File is not inside an Odoo module: run the command on a file inside a module.<file> is already in the manifest: the file is listed already.
Wrong or missing Odoo version
The generated code or snippets look like the wrong Odoo version.
- Check the status bar, for example
Odoo v20 (Auto), and click it to set the version. You can also run Assista: Set Odoo Version. - With
auto, the extension looks forodoo/release.pyin the workspace, then under the Odoo Source Path setting and$ODOO_HOME, then for anodoopin inrequirements*.txt. If none is found, it uses Odoo 20. - Set
cybrosys-assista-odoo-helper.odooSourcePathto the folder that containsodoo/release.py. - A version you pick from the status bar is saved for the workspace. Choose Auto to detect it again.
Snippets do not appear
- Open a
.pyor.xmlfile and typeodoo. - Snippets differ by version. Odoo 20 snippets such as
odoo crondo not appear on 18 or 19. See Snippets. - Reload the window.
Suggestions or Go to Definition do not work
- Wait a few seconds after opening the window. Completions that use the index appear once indexing finishes.
- Check that
indexing.enableCoreIndexingistrue. For widgets and client actions,indexing.enableRegistryIndexingmust betrue. For CSS classes, useindexing.enableCSSIndexing, andindexing.enableAdvanceCSSIndexingfor Go to Definition on CSS. - Add the Odoo source folder (the one with
odoo/andaddons/) to your workspace so core models and templates are indexed. - Run Assista: Remove Index Data (Clear Cache), then reload the window to rebuild the index.
- Go to Definition works from XML and Python files, not from JavaScript.
The editor is slow while the workspace opens
The first index of a large workspace runs in the background, at low priority, and stops when it is done. As a reference, indexing the whole Odoo 20 source takes about half a minute. You can keep working meanwhile.
To lighten the load on a very large workspace, turn off indexing.enableCSSIndexing or indexing.enableRegistryIndexing. See Settings.
Code inspection shows no warnings
The linter is off by default. Turn on Enable Code Standard Warnings in the settings. See Code inspection.
Install Module fails
| Message | What to do |
|---|---|
Odoo Server configuration is missing | Click Odoo Server in the status bar and enter the URL, database, user and password. |
Selected folder is not a valid Odoo module (missing __init__.py or __manifest__.py) | Right-click the module folder, not a file or a parent folder. |
Module "<name>" not found on server | The folder name must match the module's technical name, and the module must be in the server's addons path. |
Odoo Error: ... | The server returned an error. Check the URL, database, user and password, and that the server is running. |
- Check the server URL, database, user and password with Assista: Update Odoo Server Settings.
- Make sure the Odoo server is running and reachable from your computer.
- See Odoo connectivity.
Graphs do not load
The Model Inheritance Graph and Module Dependency Graph load their drawing library from the internet. Check your connection.
For the Module Dependency Graph, right-click a module folder (one with a __manifest__.py). For the Model Inheritance Graph, place the cursor inside a model class.
Contact support
When you report a problem, include your Odoo version, VS Code version and operating system.
- Email assista@cybrosys.com.
- Use the contact form.
- Report bugs and request features on GitHub issues.