Skip to main content
The OdooLS PyCharm plugin integrates the language server into JetBrains PyCharm. The plugin is available on the JetBrains Plugin Marketplace and its source is hosted at github.com/odoo/odoo-pycharm.

​
Installation

1

Open the Plugins dialog

In PyCharm, go to Settings > Plugins (or Preferences > Plugins on macOS).
2

Search for OdooLS

Select the Marketplace tab and search for OdooLS or Odoo Language Server.
3

Install the plugin

Click Install and restart PyCharm when prompted.
4

Create a configuration file

Create an odools.toml file at the root of your project. The plugin detects this file to start the server. See Configuration for all available options.

​
Server lifecycle

The plugin manages the OdooLS server process automatically:
  • Always running — the server process starts with PyCharm and stays running in the background.
  • Idle without configuration — if no odools.toml is found in the open project, the server remains idle and does not consume resources.
  • Activates on config detection — as soon as an odools.toml is detected, the server loads your Odoo project and begins providing IDE features.
Earlier versions of the plugin required you to start the server manually using a Start Server button. This button was removed in 1.2.0 — the server now manages its own lifecycle automatically.

​
Configuration

The plugin adds a OdooLS settings page under Settings > Languages & Frameworks > OdooLS (exact path may vary by PyCharm version). From this page you can configure the Odoo path, addon directories, and other options. A link to the configuration wiki is included on the settings page for full documentation of all available configuration options. For file-based configuration, use an odools.toml file in your project root. See Configuration.

​
Features

Automatic server lifecycle

The server is always running but idle — it activates automatically when a configuration file is detected.

Loading status display

PyCharm 2025.3 and later can display the OdooLS loading status while the server indexes your project.

Settings page

Dedicated OdooLS settings page inside PyCharm’s preferences, with a link to the configuration wiki.

lxml stubs

The plugin bundles additional type stubs for lxml, improving type checking for code that uses the library.

​
Loading status

Loading status display requires PyCharm 2025.3 or later. On earlier versions, the server runs and provides IDE features, but the progress indicator is not shown.
When OdooLS is indexing your project, PyCharm 2025.3+ will show the loading progress using the LSP workDoneProgress protocol. This gives you visibility into when the server is ready to provide completions and diagnostics.

Build docs developers (and LLMs) love

Get started for freeTalk to us