Odoo Kit
Odoo Kit puts the daily work of an Odoo developer in VS Code: browse your Odoo
repositories, start and stop the dev service, read the log, edit odoo.conf, and
install or update modules.
It works with source-based Odoo 17, 18 and 19 installations, including projects
opened over Remote - SSH. The interface is available in English and Spanish and
follows the VS Code display language.
Features
- Odoo Explorer. One tree for your Community, Enterprise, Themes, Industry and
custom addon repositories. Filter it, reveal the active file, search inside a
folder, and open a folder in the terminal. Custom files can be copied, cut,
pasted, renamed and moved to the Trash. Native Odoo source is read-only, and you
can copy it into your custom addons.
- Service view. The Odoo Service view shows whether Odoo is running. Hover the
status for the PID and the startup arguments. While Odoo runs, expand
Processes to see the main process and the HTTP, cron and gevent workers with
their PIDs. Start, debug, stop, restart and change startup arguments from the
row's buttons.
- Status bar. One item shows the Odoo state. Hover it for the HTTP or debugger
port; click it for Start, Start in Debug Mode, Stop, Restart and Configure
arguments.
- Debug mode. Starts Odoo with debugpy and attaches the VS Code debugger. If
debugpy is missing from your Python, Odoo Kit offers to install it.
- Odoo Logs. A panel that follows the log file. Filter by level (ERROR,
CRITICAL, WARNING, INFO, DEBUG, each with a count), or by text or regular
expression. Tracebacks are grouped and tinted, DEBUG lines are dimmed, and the
modules listed in a dependency error are highlighted. Pause the live view, wrap
lines, change the font size, copy the visible lines, or open the file. Clearing
the view never touches the file.
- odoo.conf editor. A form for
odoo.conf with search. A bar marks the options
that are set in the file, and another color marks unsaved changes. Booleans are
True/False selects, paths have a folder picker, and addons_path has its own
editor where you can add several folders, group them, reorder them and see which
folder wins. Numbers and ports are validated, comments and options the editor
does not know are kept when you save.
- Install and update modules. Run
--init or --update for a module from its
row in the Explorer.
- Git. Fetch, pull, push and switch branch on the repositories shown in the
Explorer.
- Server Setup Guide. For a Linux server that runs Odoo under systemd. See
Linux servers.
Requirements
- Visual Studio Code 1.125 or newer.
- A source-based Odoo 17, 18 or 19 installation.
- Python available where the extension runs (over Remote - SSH, the remote
machine).
- The Microsoft Python extension to debug Odoo.
- Read access to the Odoo repositories,
odoo.conf and the log file.
Getting started
- Open the Odoo Kit icon in the Activity Bar.
- Run Odoo Kit: Open Settings from the Command Palette.
- Set the Community source, the custom addons folder and the
odoo.conf path.
- If Odoo runs in a virtual environment, set
odooKit.pythonPath to its python,
for example /opt/odoo/venv/bin/python3.
- Click the Odoo item in the status bar and choose Start, or run
Odoo Kit: Start Service.
In a workspace with several folders, run Odoo Kit: Select Project to choose the
active one. The project name then shows in the status bar and next to the
Explorer title. With a single folder it is hidden.
Linux servers with systemd
Run Odoo Kit: Server Setup Guide. It writes the commands for your project so
you can copy them into a terminal on the server: ACL permissions, a launcher, a
systemd drop-in, and sudo rules for start, stop and restart. Odoo Kit never runs
commands as administrator. The Check setup button reads the current state and
reports what is still missing, without changing anything.
Set odooKit.pythonPath before you open the guide if Odoo uses a virtual
environment.
Settings
| Setting |
Description |
odooKit.communityPath |
Community source directory, the one that contains odoo-bin |
odooKit.customAddonsPath |
Root folder of your custom addon repositories |
odooKit.enterprisePath |
Enterprise source directory (optional) |
odooKit.themesPath |
Themes source directory (optional) |
odooKit.industryPath |
Industry source directory (optional) |
odooKit.configPath |
odoo.conf used by the service and the editor |
odooKit.pythonPath |
Python used to run Odoo |
odooKit.serviceArgs |
Extra arguments for odoo-bin, such as --dev=xml |
odooKit.logPath |
Log file to read when odoo.conf has no logfile |
Folder settings override workspace settings, which override user settings.
Relative paths resolve from the selected folder. Startup arguments can be saved to
the folder, the workspace or the user settings.
In a remote workspace, every path refers to the machine where the extension runs.
The project you select and the Odoo version shown in the editor are kept in VS Code
workspace state, not in odoo.conf.
Notes
- odoo.conf options. The editor reads the Odoo release from your checkout and
takes the options and their defaults from
odoo/tools/config.py, so a new
release works without updating the extension. If that file cannot be read, it
uses built-in lists for Odoo 17, 18 and 19. A chip in the header shows which
Odoo the options come from when that needs a look.
- Logs. The log file is opened read only. Odoo Kit's own messages and the
process output stay in memory. A missing file or a permission error shows in the
panel, and the panel reconnects by itself.
- Files. Copies and moves show progress and can be cancelled. If a replacement
fails, Odoo Kit keeps a recovery copy. Save or discard open edits before you
replace or delete their files.
Commands
Open the Command Palette with Ctrl+Shift+P and type Odoo Kit.
| Command |
What it does |
Odoo Kit: Start Service |
Start Odoo |
Odoo Kit: Stop Service |
Stop Odoo and its workers |
Odoo Kit: Restart Service |
Restart Odoo |
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 log panel |
Odoo Kit: Edit odoo.conf Visually |
Open the odoo.conf editor |
Odoo Kit: Open odoo.conf as Text |
Open the file in a text editor |
Odoo Kit: Server Setup Guide |
Commands to prepare a Linux server |
Changelog
The Changelog tab lists what changed in each version.
Feedback
Report bugs and ideas in the
GitHub issues.
License
Odoo Kit is proprietary software of Digital Planet S.R.L. de C.V. The terms of use are in the LICENSE file included with the extension.
| |