Installation
Install OdooLS via your IDE extension or build from source
Quickstart
Get autocompletion and diagnostics working in under 5 minutes
Configuration
Configure Odoo paths, addon directories, and diagnostic settings
Diagnostics Reference
Browse all 50+ diagnostic codes with descriptions and fixes
What OdooLS provides
Autocompletion
Complete model names, field names, XML IDs, method arguments, and import statements
Diagnostics
Real-time errors and warnings for Python syntax, imports, model inheritance, manifests, and XML
Go-to-definition
Jump to model classes, field declarations, XML records, and module dependencies
Hover information
Inspect symbol types, model definitions, field types, and module dependency trees
IDE support
OdooLS is available as a native extension or plugin for every major IDE:VSCode
Official extension available on the VS Code Marketplace
PyCharm
Official plugin for JetBrains PyCharm
Neovim
Integration via nvim-lspconfig
Zed
Light integration for the Zed editor
Get started
Create an odools.toml configuration file
Add an
odools.toml file at the root of your workspace pointing to your Odoo community path and addon directories. See Configuration.Open your Odoo project
Open your addon or workspace folder in your IDE. OdooLS will detect the configuration and begin indexing your codebase.
OdooLS is currently in active development. You may encounter crashes or inconsistent results. Report issues on GitHub.