Build the project

Getting started

1. Clone the repository
2. Initialize submodules:

   git submodule init && git submodule update
   

   This pulls in typeshed, which OdooLS needs for Python stdlib stubs.
3. Install Rust

Build for your machine

Run cargo build for a debug build, or cargo build -r for a release build.

Output

The binary lands in target/debug or target/release. On Windows you'll get odoo_ls_server.exe (+ .pdb), on other platforms just odoo_ls_server.

If you're running the executable directly (not through an Editor/IDE plugin), you need to place the typeshed folder either next to the binary or in your working directory. You already have it at server/typeshed if you initialized submodules. Typeshed is mandatory — OdooLS relies on it for Python stdlib type information.

Cross-compile with Docker

You can cross-compile for any supported platform using Docker.

Heads up: When building from Windows, executables for Linux and macOS will lose their executable permission bit, which will break the extension. If you need to build for multiple platforms, do it from Linux or macOS.

Steps

1. Install Docker
2. Initialize the build environment:

   cd server
   ./build.sh init
   

3. Build for your target:
   • ./build.sh all — build for every platform
   • ./build.sh help — see available targets
4. Find your output in target/<platform>/release