Skip to content

1. Build the project

Jump to bottom
Florian Daloze edited this page Sep 19, 2025 · 2 revisions

Build the project

Download resources

  1. clone the repository
  2. Init submodules with git submodule init and git submodule update
  3. Install Rust (https://www.rust-lang.org/tools/install)

Build the project for your machine

Run cargo build to build the project in debug, and cargo build -r to build in release mode.

Output

Output will be available in target/debug or target/release. You'll find odoo_ls_server or odoo_ls_server.exe and odoo_ls_server.pdb on windows. If you are not packaging OdooLS in a plugin (with related github repository), and want to use the executable directly, do not forget to provide typeshed alongside your server. typeshed folder is already downloaded in server/typeshed, or you can clone it from https://github.com/python/typeshed. You have to provide this folder either next to the odoo_ls_server executable or in your working directory. Typeshed is mandatory to get OdooLS working as it contains stdlib stubs that OdooLS is using to lint Python stuff itself

Build the project for any platform with docker

You can build for any platform from your current machine using docker.

Warning: When building from windows, executables for linux and iOS will lose their 'executable' bit, making the extension not working. If you plan to build for multiple platform, it is better to do it from linux or iOS.

Steps

  1. Install docker
  2. run cd server and ./build.sh init
  3. Depending on your target, you can run ./build.sh all or choose specific platform with ./build.sh help
  4. Get your output results in target/YourPlatform/release
Clone this wiki locally