Installation

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
PyCharm
Neovim
Zed
Build from source

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

Open VS Code.
Go to the Extensions view (Ctrl+Shift+X).
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.

OdooLS can be configured through nvim-lspconfig. See the integration repository for setup instructions and the recommended lspconfig entry:github.com/odoo/odoo-neovimYou 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.

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).

Clone the repository

git clone https://github.com/odoo/odoo-ls

Build the server

cd server && cargo build --release

The first build downloads dependencies and may take several minutes.

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.

Get Started

IDE Integration

Configuration

Features

Build docs developers (and LLMs) love