Odoo Kit
Odoo Kit brings Odoo development workflows into Visual Studio Code. Browse
repositories, manage the development service, inspect logs, edit odoo.conf,
and run common Git and module operations from one workspace.
The extension supports source-based Odoo 17, 18, and 19 installations, including
VS Code Remote - SSH environments.
Features
- Odoo Explorer — Browse Community, Enterprise, Themes, Industry, and custom
addon repositories in a dedicated view.
- Service management — Start, stop, restart, and debug Odoo from the status
bar or the Odoo Service view.
- Odoo Logs — Follow the configured log file with level filters, search,
pause, line wrapping, and copy actions.
- Visual configuration — Edit supported
odoo.conf options with validation,
search, path pickers, and version-aware defaults.
- Module operations — Install or update an addon directly from the Explorer.
- Git integration — Fetch, pull, push, and change branches without leaving
the Odoo workspace.
- Localized interface — English and Spanish are selected automatically from
the VS Code display language.
Requirements
- Visual Studio Code 1.125 or newer.
- A source-based Odoo 17, 18, or 19 installation.
- Python available to the VS Code extension host.
- The Microsoft Python extension when using debug sessions.
- Access to the configured Odoo repositories, configuration, and log file.
Getting Started
- Install Odoo Kit and open its icon in the Activity Bar.
- Open Odoo Kit: Open Settings from the Command Palette.
- Configure the Community source, custom addons, and
odoo.conf paths.
- Configure the Python executable or service working directory when they differ
from the defaults.
- Start Odoo from the status bar or run Odoo Kit: Start Service.
For a shared Linux development server with an existing systemd unit, run
Odoo Kit: Prepare Server once before using the service controls. The command
can be run again safely when paths or service settings change.
Essential Settings
| Setting |
Description |
odooKit.communityPath |
Community source directory containing odoo-bin |
odooKit.customAddonsPath |
Root directory for custom addon repositories |
odooKit.enterprisePath |
Optional Enterprise source directory |
odooKit.themesPath |
Optional Themes source directory |
odooKit.industryPath |
Optional Industry source directory |
odooKit.configPath |
Configuration file used by the service and editor |
odooKit.pythonPath |
Python executable used to run Odoo |
odooKit.serviceArgs |
Additional arguments passed when Odoo starts |
odooKit.logPath |
Fallback log path when odoo.conf has no logfile |
Settings may be stored at User or Workspace scope. In remote workspaces, paths
refer to the machine where the VS Code extension host is running.
Main Commands
Open the Command Palette with Ctrl+Shift+P and search for Odoo Kit.
| Command |
Purpose |
Odoo Kit: Start Service |
Start the configured Odoo service |
Odoo Kit: Stop Service |
Stop Odoo and its worker processes |
Odoo Kit: Restart Service |
Restart the current service |
Odoo Kit: Start Odoo in Debug Mode |
Start Odoo and attach the debugger |
Odoo Kit: Configure Startup Arguments |
Set arguments such as --dev=all |
Odoo Kit: Open Odoo Logs |
Open the live log viewer |
Odoo Kit: Edit odoo.conf Visually |
Open the visual configuration editor |
Odoo Kit: Prepare Server |
Prepare a shared Linux development server |
Release Notes
0.3.0
A general quality update with refreshed views, improved Odoo service and server
integration, a more capable configuration editor and log viewer, localization,
and compatibility with the current VS Code API.
Feedback
Report bugs or request features in the
GitHub repository.
License
Proprietary — © Digital Planet S.R.L. de C.V.
