Installation

How to install OdooLS for your IDE, or build the server binary from source.

The easiest way to get OdooLS is through the extension for your IDE. Each extension bundles a prebuilt server binary and handles updates automatically. If you need a custom build or want to use OdooLS in a non-bundled editor setup, you can also compile the server from source.

VS Code

Install the extension from the VS Code Marketplace or from the repository:

1. Open VS Code.
2. Go to the Extensions view (Ctrl+Shift+X).
3. Search for Odoo and install the official Odoo extension.

Alternatively, find the extension and its source at github.com/odoo/odoo-vscode.

The extension bundles the OdooLS binary and starts it automatically when you open a workspace. A status indicator in the bottom bar shows the server state and loading progress.

PyCharm

Install the plugin from the JetBrains Marketplace or from the repository:

1. Open PyCharm and go to Settings → Plugins.
2. Switch to the Marketplace tab.
3. Search for Odoo and install the Odoo plugin.

The plugin source is at github.com/odoo/odoo-pycharm.

The server runs in the background and starts processing your workspace as soon as a valid configuration file is detected. No manual server start is required. PyCharm 2025.3 and later can display the loading status in the IDE.

Neovim

OdooLS can be configured through nvim-lspconfig. See the integration repository for setup instructions and the recommended lspconfig entry:

github.com/odoo/odoo-neovim

You will need to provide the path to the odoo_ls_server binary, which can be built from source (see the Build from source tab) or downloaded from a release.

Zed

A light integration for the Zed editor is available at:

github.com/odoo/odoo-zed

Follow the instructions in that repository to enable the extension in Zed.

Build from source

Build the odoo_ls_server binary yourself if you need a custom build, want to run the latest master, or are integrating OdooLS into an editor that is not yet bundled.

Requirements

• Rust 1.91 or later — check your version with rustc --version.
• cargo (included with Rust).
• A C linker (usually already present on Linux and macOS; on Windows, install the MSVC Build Tools).

1. Clone the repository

   git clone https://github.com/odoo/odoo-ls
   
2. Build the server

   cd server && cargo build --release
   

   The first build downloads dependencies and may take several minutes.

3. Locate the binary

   The compiled binary is at:

   server/target/release/odoo_ls_server
   

   Copy it to a directory on your PATH, or point your editor’s LSP configuration to the full path.

To build the latest pre-release version, check out the beta or alpha branch before running cargo build.