odoo-toolkit 4.1.2__tar.gz → 4.2.0__tar.gz

odoo_toolkit-4.2.0/.devcontainer/Dockerfile

@@ -0,0 +1,5 @@
+FROM mcr.microsoft.com/devcontainers/python:3.12
+
+# Claude Code keeps its login in a volume mounted here. Docker gives a new volume the owner of this folder, so the user of
+# the dev container can write in it.
+RUN mkdir /home/vscode/.claude && chown vscode:vscode /home/vscode/.claude

odoo_toolkit-4.2.0/.devcontainer/devcontainer.json

@@ -0,0 +1,48 @@
+{
+    "name": "odoo-toolkit",
+    "build": {
+        "dockerfile": "Dockerfile"
+    },
+    "remoteUser": "vscode",
+    "updateRemoteUserUID": true,
+    "runArgs": ["--cap-drop=ALL", "--security-opt=no-new-privileges", "--init"],
+    "mounts": [
+        "source=odoo-toolkit-claude,target=/home/vscode/.claude,type=volume",
+        "source=${localWorkspaceFolder}/.devcontainer,target=${containerWorkspaceFolder}/.devcontainer,type=bind,readonly",
+        "source=${localWorkspaceFolder}/.vscode,target=${containerWorkspaceFolder}/.vscode,type=bind,readonly",
+        "source=${localWorkspaceFolder}/.git/hooks,target=${containerWorkspaceFolder}/.git/hooks,type=bind,readonly"
+    ],
+    "containerEnv": {
+        "CLAUDE_CONFIG_DIR": "/home/vscode/.claude",
+        "UV_PROJECT_ENVIRONMENT": "/home/vscode/.venv",
+        "UV_LINK_MODE": "copy"
+    },
+    "remoteEnv": {
+        "PATH": "/home/vscode/.venv/bin:/home/vscode/.local/bin:${containerEnv:PATH}",
+        "SSH_AUTH_SOCK": null
+    },
+    "onCreateCommand": "pip install --user --quiet uv && uv sync --quiet",
+    "postStartCommand": "git config --global --unset-all credential.helper || true",
+    "postAttachCommand": "rm -f /tmp/vscode-ssh-auth-*.sock",
+    "otherPortsAttributes": {
+        "onAutoForward": "ignore"
+    },
+    "customizations": {
+        "vscode": {
+            "extensions": [
+                "anthropic.claude-code",
+                "charliermarsh.ruff",
+                "ms-python.python",
+                "ms-python.debugpy",
+                "njpwerner.autodocstring"
+            ],
+            "settings": {
+                "python.defaultInterpreterPath": "/home/vscode/.venv/bin/python",
+                "remote.autoForwardPorts": false,
+                "git.terminalAuthentication": false,
+                "github.gitAuthentication": false,
+                "git.enableCommitSigning": false
+            }
+        }
+    }
+}

{odoo_toolkit-4.1.2 → odoo_toolkit-4.2.0}/.github/workflows/ci.yml

@@ -15,7 +15,8 @@ jobs:
     steps:
       - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
       - uses: astral-sh/setup-uv@1c37ad07a6a961277cf70c0d37d6f313000f5884 # v10.3.0
-      - run: uvx ruff@0.15.0 check odoo_toolkit scripts tests
+      - run: uv run ruff check odoo_toolkit scripts tests
+      - run: uv run pyright
 
   test:
     strategy:

odoo_toolkit-4.2.0/.github/workflows/sync-odoo-ruff.yml

@@ -0,0 +1,27 @@
+name: Sync Odoo's Ruff rules
+
+# Checks every week whether Odoo changed the ruff.toml of its master branch, and opens a pull request with the changes.
+# `otk mv setup` copies it into the multiverse, for the repositories that don't have a version of Odoo to extend.
+on:
+  schedule:
+    - cron: "0 5 * * 0"
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  sync:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - run: curl --fail --silent --show-error --location --output odoo_toolkit/multiverse_config/ruff-odoo.toml https://raw.githubusercontent.com/odoo/odoo/master/ruff.toml
+      - uses: peter-evans/create-pull-request@5f6978faf089d4d20b00c7766989d076bb2fc7f1 # v8.1.1
+        with:
+          branch: sync-odoo-ruff
+          commit-message: "[IMP] mv: sync Odoo's Ruff rules"
+          title: "[IMP] mv: sync Odoo's Ruff rules"
+          body: |
+            The ruff.toml of Odoo's master branch changed. Review the diff.
+          delete-branch: true

{odoo_toolkit-4.1.2 → odoo_toolkit-4.2.0}/.github/workflows/sync-runbot.yml

@@ -3,7 +3,7 @@ name: Sync with Runbot
 # Checks Runbot every week for new versions or changed Dockerfiles, and opens a pull request with the changes.
 on:
   schedule:
-    - cron: "0 5 * * 1"
+    - cron: "0 5 * * 6"
   workflow_dispatch:
 
 permissions:

{odoo_toolkit-4.1.2 → odoo_toolkit-4.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: odoo-toolkit
-Version: 4.1.2
+Version: 4.2.0
 Summary: This toolkit contains a few useful tools for Odoo development.
 Author-email: Dylan Kiss <dyki@odoo.com>
 License-File: LICENSE
@@ -35,6 +35,9 @@ $ uv tool install --force git+https://github.com/dylankiss/odoo-toolkit.git
 > [!TIP]
 > You can run any command with the `--help` option to find out all options you can use.
 
+> [!NOTE]
+> At most once a day, in the background, the toolkit checks [PyPI](https://pypi.org/project/odoo-toolkit/) for a new version and tells you after the command has run. It doesn't check in scripts, in CI, or when the toolkit isn't installed from PyPI, like a linked development version. Set `OTK_NO_UPDATE_CHECK` to any value to turn it off.
+
 > [!TIP]
 > Anywhere you can provide modules as arguments or options, you can also use [glob patterns](https://docs.python.org/3/library/fnmatch.html) to match multiple similar ones.
 
@@ -257,6 +260,15 @@ What stays between runs:
 
 Your SSH agent (the one in `SSH_AUTH_SOCK`, like Bitwarden's or 1Password's) is available in the container, for Odoo modules that run Git commands. Your keys never leave your machine.
 
+With [OrbStack](https://orbstack.dev), which provides its own agent forwarding, an agent like Bitwarden's needs an `IdentityAgent` line in your `~/.ssh/config`. Add it below any `Include` lines, then restart OrbStack:
+
+```
+Host *
+    IdentityAgent "~/Library/Containers/com.bitwarden.desktop/Data/.bitwarden-ssh-agent.sock"
+```
+
+Use the socket in your `SSH_AUTH_SOCK` for the path, which is different for other agents, like 1Password's.
+
 On Linux, the container runs as your user, so the files Odoo writes are yours. The images on Docker Hub run as user ID 1000, the first user on most Linux machines. With another user ID, build the image on your machine once with `--build`.
 
 > [!TIP]
@@ -271,7 +283,7 @@ It starts PostgreSQL and Mailpit if needed, and runs Odoo with:
 - the database and mail server set up,
 - no time limits, so requests don't stop while you're paused in the debugger.
 
-Use `--community` to only load Odoo Community, or `--exclude` to leave out repositories, like `-x enterprise`. Pass any other Odoo options after `--`. Stop Odoo with `Ctrl+C`.
+Use `--community` to only load Odoo Community, or `--exclude` to leave out repositories, like `-x enterprise`. Use `--volume` and `--env` to give the container files and settings of your machine, like the configuration of a linked repository. Pass any other Odoo options after `--`. Stop Odoo with `Ctrl+C`.
 
 ### Usage
 
@@ -283,6 +295,7 @@ e.g.
 $ otk dev run -- -d mydb -i sale
 $ otk dev run --port 8070 --debug -- -d mydb
 $ otk dev run --community -- -d community-db
+$ otk dev run -v ~/etc-odoo:/etc/odoo:ro -e KEY=value -- -d mydb
 ```
 
 ### Options
@@ -293,6 +306,8 @@ $ otk dev run --community -- -d community-db
 * `--upgrade`: Add the upgrade scripts of `upgrade` and `upgrade-util` to the upgrade path.
 * `--community`: Only load the modules of Odoo Community (`odoo/addons`).
 * `-x, --exclude TEXT`: Leave these repositories out of the addons path, like `enterprise` or `odoofin,design-themes`.
+* `-v, --volume TEXT`: Mount a file or folder of your machine in the container, like `~/etc-odoo:/etc/odoo:ro`. Can be used several times. A path starting with `~` or `.` is made absolute, and the path must exist.
+* `-e, --env TEXT`: Set an environment variable in the container, like `REQUESTS_CA_BUNDLE=/etc/ca.pem`. Can be used several times.
 * `--build`: Build the image on your machine instead of pulling it.
 * `--pull`: Pull the latest image, even if you have one already.
 * `--db-port INTEGER`: The port to reach PostgreSQL on, on your machine. Defaults to the one it runs on, or `5432`. Changing it restarts PostgreSQL.
@@ -626,7 +641,7 @@ The easiest way to set this up is by creating a directory for your multiverse se
 > [!IMPORTANT]
 > Make sure you have set up your GitHub SSH key beforehand in order to clone the repositories, and installed [`uv`](https://docs.astral.sh/uv/getting-started/installation/) and `npm`.
 
-You can run the command as many times as you want. It only adds what's missing, and never touches your own files. Pass `--reset-config` to recreate the Python environments and overwrite the configuration files. Without `-b` or `-r`, it updates the versions and repositories that are already set up.
+You can run the command as many times as you want. It only adds what's missing, and never touches your own files. Pass `--update-config` to overwrite the configuration files with the latest ones, or `--reset-config` to recreate the Python environments as well. Without `-b` or `-r`, it updates the versions and repositories that are already set up.
 
 ### Repositories
 
@@ -697,6 +712,7 @@ After all that is done, your directory structure should look like this with the
 ├── 19.0
 │   ├── .venv (Python virtual environment)
 │   ├── .vscode (Visual Studio Code configuration)
+│   ├── ruff.toml (extends the one of odoo, for the other repositories)
 │   ├── odoo (19.0)
 │   ├── enterprise (19.0)
 │   ├── design-themes (19.0)
@@ -709,11 +725,33 @@ After all that is done, your directory structure should look like this with the
 ├── upgrade (master)
 ├── upgrade-util (master)
 ├── requirements.txt
-└── ruff.toml
+├── ruff-odoo.toml (Odoo's Ruff rules of master)
+└── ruff.toml (extends ruff-odoo.toml)
 ```
 
 Open a version directory (like `code <multiverse-folder>/19.0`) in your editor to work on that version.
 
+### Dev Container
+
+With `--devcontainer`, every version directory gets a [dev container](https://containers.dev) configuration. Open the version in Visual Studio Code and run **Dev Containers: Reopen in Container**. The window, its extensions and any AI agent in it then only see your multiverse directory (mounted at the same path as on your machine): not your home folder, SSH keys or Git credentials.
+
+- Opening the container starts the shared services (`otk dev db`), since it joins their network. Odoo starts from the **Odoo (container): run and debug** launch configuration, because `otk dev run` needs Docker.
+- Git commands that need GitHub (fetch, pull, push) don't work in the container. Run them from a terminal on your machine.
+- The `.devcontainer`, `.vscode` and `.venv` folders are read-only in the container, because they hold what runs on your machine later (like tasks and the dev container's own configuration). Change them from your machine, for example with `otk mv setup --update-config`.
+- Everything else in the multiverse can be read and changed in the container, and it has network access, including to the databases of `otk dev`. Don't keep secrets or data you can't share in your multiverse or those databases if you use AI agents.
+- Only windows opened in the container are isolated, not agents you start from a terminal on your machine.
+- Visual Studio Code shares your Git config and credential helper with every dev container, which a project can't turn off. Add `"dev.containers.copyGitConfig": false` and `"dev.containers.gitCredentialHelperConfigLocation": "none"` to your user settings.
+- Extensions and settings you want in the dev containers of this multiverse, like a spell checker, go in a `[devcontainer]` table in `multiverse.toml`, which `--update-config` applies. Extensions you want in every dev container go in the `dev.containers.defaultExtensions` user setting.
+
+  ```toml
+  [devcontainer]
+  extensions = ["streetsidesoftware.code-spell-checker"]
+
+  [devcontainer.settings]
+  "cSpell.allowCompoundWords" = true
+  ```
+- Claude Code is installed, but your login on your machine stays out. Log in once in the container: it's kept in the `otk-claude` volume, which all your dev containers share, so it survives rebuilds.
+
 ### Usage
 
 ```console
@@ -729,8 +767,10 @@ $ otk mv setup -b 18.0 -b 19.0 -b master -r odoo -r enterprise -r upgrade -r upg
 * `-b, --branches TEXT`: The Odoo versions to set up, like `19.0` or `saas-19.2`. Defaults to the ones already set up, or every supported version for a new multiverse.
 * `-r, --repositories TEXT`: The repositories to set up, like `odoo`, or `odoo-ps/psbe-internal` for another GitHub owner. Defaults to the ones already set up, or `odoo`, `enterprise`, `design-themes`, `upgrade` and `upgrade-util` for a new multiverse, plus the ones in `multiverse.toml`.
 * `-d, --multiverse-dir PATH`: The directory to set up the multiverse in. Defaults to this directory.
-* `--reset-config`: Recreate the Python virtual environments and overwrite the configuration files of every version.
+* `--update-config`: Overwrite the configuration files of every version, like the Visual Studio Code and dev container ones, to get the latest from the toolkit. The Python virtual environments are kept.
+* `--reset-config`: Recreate the Python virtual environments as well as overwriting the configuration files of every version.
 * `--vscode / --no-vscode`: Write the Visual Studio Code configuration in each version directory.  [default: `--vscode`]
+* `--devcontainer / --no-devcontainer`: Write a dev container configuration in each version directory, to open it in Visual Studio Code in a container that only sees your multiverse, for example to keep AI agents away from the rest of your machine. Versions that already have one keep it up to date, unless you pass `--no-devcontainer`.
 * `--branch-suffix TEXT`: The suffix of your own branches on the `dev` remote, like `abcd` for `master-fix-xyz-abcd`. It's remembered for later commands. Defaults to the remembered one, or else the part of your Git email before the `@`.
 * `--help`: Show this message and exit.
 
@@ -837,3 +877,32 @@ $ otk mv cleanup [OPTIONS]
 * `--branch-suffix TEXT`: The suffix of your own branches on the `dev` remote, like `abcd` for `master-fix-xyz-abcd`. Defaults to the one given to `otk mv setup`, or else the part of your Git email before the `@`.
 * `-y, --yes`: Don't ask for confirmation.
 * `--help`: Show this message and exit.
+
+## `otk code`
+
+Open a version directory of your multiverse in Visual Studio Code, like `otk code 19.0`.
+
+Run it anywhere inside your multiverse. Without a version, it opens the version directory you are in. If the version has a [dev container](#otk-mv-setup) (from `otk mv setup --devcontainer`), it opens in it. With a [profile](https://code.visualstudio.com/docs/configure/profiles), the window always has your extensions and settings for Odoo, so you don't have to associate every version directory with it in Visual Studio Code. Set it once in `multiverse.toml` to use it every time:
+
+```toml
+[code]
+profile = "Odoo"
+```
+
+It needs the `code` command: run **Shell Command: Install 'code' command in PATH** in Visual Studio Code.
+
+### Usage
+
+```console
+$ otk code [OPTIONS] [VERSION]
+```
+
+### Arguments
+
+* `[VERSION]`: The version to open, like `19.0`. Defaults to the version directory you are in.
+
+### Options
+
+* `-p, --profile TEXT`: The Visual Studio Code profile to open it with, like `Odoo`. Defaults to `profile` in the `[code]` table of `multiverse.toml`. A profile that doesn't exist yet is created empty.
+* `--local`: Open it on your machine, even if it has a dev container.
+* `--help`: Show this message and exit.

{odoo_toolkit-4.1.2 → odoo_toolkit-4.2.0}/README.md

@@ -22,6 +22,9 @@ $ uv tool install --force git+https://github.com/dylankiss/odoo-toolkit.git
 > [!TIP]
 > You can run any command with the `--help` option to find out all options you can use.
 
+> [!NOTE]
+> At most once a day, in the background, the toolkit checks [PyPI](https://pypi.org/project/odoo-toolkit/) for a new version and tells you after the command has run. It doesn't check in scripts, in CI, or when the toolkit isn't installed from PyPI, like a linked development version. Set `OTK_NO_UPDATE_CHECK` to any value to turn it off.
+
 > [!TIP]
 > Anywhere you can provide modules as arguments or options, you can also use [glob patterns](https://docs.python.org/3/library/fnmatch.html) to match multiple similar ones.
 
@@ -244,6 +247,15 @@ What stays between runs:
 
 Your SSH agent (the one in `SSH_AUTH_SOCK`, like Bitwarden's or 1Password's) is available in the container, for Odoo modules that run Git commands. Your keys never leave your machine.
 
+With [OrbStack](https://orbstack.dev), which provides its own agent forwarding, an agent like Bitwarden's needs an `IdentityAgent` line in your `~/.ssh/config`. Add it below any `Include` lines, then restart OrbStack:
+
+```
+Host *
+    IdentityAgent "~/Library/Containers/com.bitwarden.desktop/Data/.bitwarden-ssh-agent.sock"
+```
+
+Use the socket in your `SSH_AUTH_SOCK` for the path, which is different for other agents, like 1Password's.
+
 On Linux, the container runs as your user, so the files Odoo writes are yours. The images on Docker Hub run as user ID 1000, the first user on most Linux machines. With another user ID, build the image on your machine once with `--build`.
 
 > [!TIP]
@@ -258,7 +270,7 @@ It starts PostgreSQL and Mailpit if needed, and runs Odoo with:
 - the database and mail server set up,
 - no time limits, so requests don't stop while you're paused in the debugger.
 
-Use `--community` to only load Odoo Community, or `--exclude` to leave out repositories, like `-x enterprise`. Pass any other Odoo options after `--`. Stop Odoo with `Ctrl+C`.
+Use `--community` to only load Odoo Community, or `--exclude` to leave out repositories, like `-x enterprise`. Use `--volume` and `--env` to give the container files and settings of your machine, like the configuration of a linked repository. Pass any other Odoo options after `--`. Stop Odoo with `Ctrl+C`.
 
 ### Usage
 
@@ -270,6 +282,7 @@ e.g.
 $ otk dev run -- -d mydb -i sale
 $ otk dev run --port 8070 --debug -- -d mydb
 $ otk dev run --community -- -d community-db
+$ otk dev run -v ~/etc-odoo:/etc/odoo:ro -e KEY=value -- -d mydb
 ```
 
 ### Options
@@ -280,6 +293,8 @@ $ otk dev run --community -- -d community-db
 * `--upgrade`: Add the upgrade scripts of `upgrade` and `upgrade-util` to the upgrade path.
 * `--community`: Only load the modules of Odoo Community (`odoo/addons`).
 * `-x, --exclude TEXT`: Leave these repositories out of the addons path, like `enterprise` or `odoofin,design-themes`.
+* `-v, --volume TEXT`: Mount a file or folder of your machine in the container, like `~/etc-odoo:/etc/odoo:ro`. Can be used several times. A path starting with `~` or `.` is made absolute, and the path must exist.
+* `-e, --env TEXT`: Set an environment variable in the container, like `REQUESTS_CA_BUNDLE=/etc/ca.pem`. Can be used several times.
 * `--build`: Build the image on your machine instead of pulling it.
 * `--pull`: Pull the latest image, even if you have one already.
 * `--db-port INTEGER`: The port to reach PostgreSQL on, on your machine. Defaults to the one it runs on, or `5432`. Changing it restarts PostgreSQL.
@@ -613,7 +628,7 @@ The easiest way to set this up is by creating a directory for your multiverse se
 > [!IMPORTANT]
 > Make sure you have set up your GitHub SSH key beforehand in order to clone the repositories, and installed [`uv`](https://docs.astral.sh/uv/getting-started/installation/) and `npm`.
 
-You can run the command as many times as you want. It only adds what's missing, and never touches your own files. Pass `--reset-config` to recreate the Python environments and overwrite the configuration files. Without `-b` or `-r`, it updates the versions and repositories that are already set up.
+You can run the command as many times as you want. It only adds what's missing, and never touches your own files. Pass `--update-config` to overwrite the configuration files with the latest ones, or `--reset-config` to recreate the Python environments as well. Without `-b` or `-r`, it updates the versions and repositories that are already set up.
 
 ### Repositories
 
@@ -684,6 +699,7 @@ After all that is done, your directory structure should look like this with the
 ├── 19.0
 │   ├── .venv (Python virtual environment)
 │   ├── .vscode (Visual Studio Code configuration)
+│   ├── ruff.toml (extends the one of odoo, for the other repositories)
 │   ├── odoo (19.0)
 │   ├── enterprise (19.0)
 │   ├── design-themes (19.0)
@@ -696,11 +712,33 @@ After all that is done, your directory structure should look like this with the
 ├── upgrade (master)
 ├── upgrade-util (master)
 ├── requirements.txt
-└── ruff.toml
+├── ruff-odoo.toml (Odoo's Ruff rules of master)
+└── ruff.toml (extends ruff-odoo.toml)
 ```
 
 Open a version directory (like `code <multiverse-folder>/19.0`) in your editor to work on that version.
 
+### Dev Container
+
+With `--devcontainer`, every version directory gets a [dev container](https://containers.dev) configuration. Open the version in Visual Studio Code and run **Dev Containers: Reopen in Container**. The window, its extensions and any AI agent in it then only see your multiverse directory (mounted at the same path as on your machine): not your home folder, SSH keys or Git credentials.
+
+- Opening the container starts the shared services (`otk dev db`), since it joins their network. Odoo starts from the **Odoo (container): run and debug** launch configuration, because `otk dev run` needs Docker.
+- Git commands that need GitHub (fetch, pull, push) don't work in the container. Run them from a terminal on your machine.
+- The `.devcontainer`, `.vscode` and `.venv` folders are read-only in the container, because they hold what runs on your machine later (like tasks and the dev container's own configuration). Change them from your machine, for example with `otk mv setup --update-config`.
+- Everything else in the multiverse can be read and changed in the container, and it has network access, including to the databases of `otk dev`. Don't keep secrets or data you can't share in your multiverse or those databases if you use AI agents.
+- Only windows opened in the container are isolated, not agents you start from a terminal on your machine.
+- Visual Studio Code shares your Git config and credential helper with every dev container, which a project can't turn off. Add `"dev.containers.copyGitConfig": false` and `"dev.containers.gitCredentialHelperConfigLocation": "none"` to your user settings.
+- Extensions and settings you want in the dev containers of this multiverse, like a spell checker, go in a `[devcontainer]` table in `multiverse.toml`, which `--update-config` applies. Extensions you want in every dev container go in the `dev.containers.defaultExtensions` user setting.
+
+  ```toml
+  [devcontainer]
+  extensions = ["streetsidesoftware.code-spell-checker"]
+
+  [devcontainer.settings]
+  "cSpell.allowCompoundWords" = true
+  ```
+- Claude Code is installed, but your login on your machine stays out. Log in once in the container: it's kept in the `otk-claude` volume, which all your dev containers share, so it survives rebuilds.
+
 ### Usage
 
 ```console
@@ -716,8 +754,10 @@ $ otk mv setup -b 18.0 -b 19.0 -b master -r odoo -r enterprise -r upgrade -r upg
 * `-b, --branches TEXT`: The Odoo versions to set up, like `19.0` or `saas-19.2`. Defaults to the ones already set up, or every supported version for a new multiverse.
 * `-r, --repositories TEXT`: The repositories to set up, like `odoo`, or `odoo-ps/psbe-internal` for another GitHub owner. Defaults to the ones already set up, or `odoo`, `enterprise`, `design-themes`, `upgrade` and `upgrade-util` for a new multiverse, plus the ones in `multiverse.toml`.
 * `-d, --multiverse-dir PATH`: The directory to set up the multiverse in. Defaults to this directory.
-* `--reset-config`: Recreate the Python virtual environments and overwrite the configuration files of every version.
+* `--update-config`: Overwrite the configuration files of every version, like the Visual Studio Code and dev container ones, to get the latest from the toolkit. The Python virtual environments are kept.
+* `--reset-config`: Recreate the Python virtual environments as well as overwriting the configuration files of every version.
 * `--vscode / --no-vscode`: Write the Visual Studio Code configuration in each version directory.  [default: `--vscode`]
+* `--devcontainer / --no-devcontainer`: Write a dev container configuration in each version directory, to open it in Visual Studio Code in a container that only sees your multiverse, for example to keep AI agents away from the rest of your machine. Versions that already have one keep it up to date, unless you pass `--no-devcontainer`.
 * `--branch-suffix TEXT`: The suffix of your own branches on the `dev` remote, like `abcd` for `master-fix-xyz-abcd`. It's remembered for later commands. Defaults to the remembered one, or else the part of your Git email before the `@`.
 * `--help`: Show this message and exit.
 
@@ -824,3 +864,32 @@ $ otk mv cleanup [OPTIONS]
 * `--branch-suffix TEXT`: The suffix of your own branches on the `dev` remote, like `abcd` for `master-fix-xyz-abcd`. Defaults to the one given to `otk mv setup`, or else the part of your Git email before the `@`.
 * `-y, --yes`: Don't ask for confirmation.
 * `--help`: Show this message and exit.
+
+## `otk code`
+
+Open a version directory of your multiverse in Visual Studio Code, like `otk code 19.0`.
+
+Run it anywhere inside your multiverse. Without a version, it opens the version directory you are in. If the version has a [dev container](#otk-mv-setup) (from `otk mv setup --devcontainer`), it opens in it. With a [profile](https://code.visualstudio.com/docs/configure/profiles), the window always has your extensions and settings for Odoo, so you don't have to associate every version directory with it in Visual Studio Code. Set it once in `multiverse.toml` to use it every time:
+
+```toml
+[code]
+profile = "Odoo"
+```
+
+It needs the `code` command: run **Shell Command: Install 'code' command in PATH** in Visual Studio Code.
+
+### Usage
+
+```console
+$ otk code [OPTIONS] [VERSION]
+```
+
+### Arguments
+
+* `[VERSION]`: The version to open, like `19.0`. Defaults to the version directory you are in.
+
+### Options
+
+* `-p, --profile TEXT`: The Visual Studio Code profile to open it with, like `Odoo`. Defaults to `profile` in the `[code]` table of `multiverse.toml`. A profile that doesn't exist yet is created empty.
+* `--local`: Open it on your machine, even if it has a dev container.
+* `--help`: Show this message and exit.

odoo_toolkit-4.2.0/odoo_toolkit/code.py

@@ -0,0 +1,62 @@
+import shutil
+import subprocess
+from typing import Annotated
+from urllib.parse import quote
+
+from typer import Argument, Exit, Option
+
+from .common import print_error
+from .mv.config import NOT_IN_VERSION_DIR, find_multiverse_dir, find_version_dir, get_code_profile, get_current_dir
+
+
+def code(
+    version: Annotated[
+        str | None,
+        Argument(help="The version to open, like `19.0`. Defaults to the version directory you are in."),
+    ] = None,
+    profile: Annotated[
+        str | None,
+        Option(
+            "--profile",
+            "-p",
+            help="The Visual Studio Code profile to open it with, like `Odoo`. Defaults to `profile` in the `[code]` "
+            "table of `multiverse.toml`. A profile that doesn't exist yet is created empty.",
+        ),
+    ] = None,
+    local: Annotated[
+        bool,
+        Option("--local", help="Open it on your machine, even if it has a dev container."),
+    ] = False,
+) -> None:
+    """Open :keyboard: an Odoo Multiverse version directory in Visual Studio Code.
+
+    Run this command anywhere inside your multiverse, and it opens the version directory you are in, or the one you
+    name. If it has a dev container (see `otk mv setup --devcontainer`), it opens in it, so the window and any AI agent
+    in it only see your multiverse. With a profile, the window always has your extensions and settings for Odoo,
+    without having to associate every version directory with it in Visual Studio Code.\n
+    \n
+    It needs the `code` command: run *Shell Command: Install 'code' command in PATH* in Visual Studio Code.
+    """
+    if not (code_command := shutil.which("code")):
+        print_error("The [b]code[/b] command isn't available. Run *Shell Command: Install 'code' command in PATH*.\n")
+        raise Exit(1)
+
+    if version:
+        if not (multiverse_dir := find_multiverse_dir(get_current_dir())):
+            print_error(NOT_IN_VERSION_DIR)
+            raise Exit(1)
+        version_dir = multiverse_dir / version
+        if not version_dir.is_dir() or find_version_dir(version_dir) != version_dir:
+            print_error(f"There is no version directory [b]{version}[/b] in [u]{multiverse_dir}[/u].\n")
+            raise Exit(1)
+    elif not (version_dir := find_version_dir()):
+        print_error(NOT_IN_VERSION_DIR)
+        raise Exit(1)
+
+    profile = profile or get_code_profile(version_dir.parent)
+    target = [str(version_dir)]
+    if not local and (version_dir / ".devcontainer" / "devcontainer.json").is_file():
+        # A dev container is addressed by the hex of its folder on your machine, and the folder it opens inside it.
+        host_path = str(version_dir).encode().hex()
+        target = ["--folder-uri", f"vscode-remote://dev-container+{host_path}{quote(str(version_dir))}"]
+    subprocess.run([code_command, *(["--profile", profile] if profile else []), *target], check=False)

{odoo_toolkit-4.1.2 → odoo_toolkit-4.2.0}/odoo_toolkit/dev/run.py

@@ -21,6 +21,7 @@ from .runtime import (
     get_git_identity,
     get_ssh_agent,
     is_port_free,
+    normalize_volume,
 )
 
 app = Typer()
@@ -55,6 +56,24 @@ def run(
             help="Leave these repositories out of the addons path, like `enterprise` or `odoofin,design-themes`.",
         ),
     ] = EMPTY_LIST,
+    volume: Annotated[
+        list[str],
+        Option(
+            "--volume",
+            "-v",
+            help="Mount a file or folder of your machine in the container, like `~/etc-odoo:/etc/odoo:ro`. Can be "
+            "used several times.",
+        ),
+    ] = EMPTY_LIST,
+    env: Annotated[
+        list[str],
+        Option(
+            "--env",
+            "-e",
+            help="Set an environment variable in the container, like `REQUESTS_CA_BUNDLE=/etc/ca.pem`. Can be used "
+            "several times.",
+        ),
+    ] = EMPTY_LIST,
     build: Annotated[bool, Option("--build", help="Build the image on your machine instead of pulling it.")] = False,
     pull: Annotated[bool, Option("--pull", help="Pull the latest image, even if you have one already.")] = False,
     db_port: Annotated[
@@ -82,10 +101,19 @@ def run(
     \n
     The addons path contains every repository of the version directory with modules in it, like `enterprise`,
     `odoo/addons`, and linked repositories like `odoofin`. Use `--community` to only load Odoo Community, or
-    `--exclude` to leave out repositories. Pass any other Odoo options after `--`, like `otk dev run -- -d mydb -i sale`.
+    `--exclude` to leave out repositories. Use `--volume` and `--env` to give the container files and settings of your
+    machine, like the configuration of a linked repository. Pass any other Odoo options after `--`, like
+    `otk dev run -- -d mydb -i sale`.
     """
     version_dir, version = get_version_dir()
     exclude = normalize_list_option(exclude)
+    volumes = [normalize_volume(spec) for spec in volume]
+    for spec in volumes:
+        source = spec.partition(":")[0]
+        # Docker would create a missing folder as `root`, instead of telling you the path is wrong.
+        if source.startswith("/") and not Path(source).exists():
+            print_error(f"Can't mount [u]{source}[/u], since it doesn't exist.\n")
+            raise Exit(1)
     if unknown := sorted(set(exclude) - {path.name for path in get_repo_dirs(version_dir, include_linked=True)}):
         print_warning(f"There is no [b]{'[/b], [b]'.join(unknown)}[/b] in [u]{version_dir}[/u] to leave out.\n")
 
@@ -109,6 +137,8 @@ def run(
         arch=arch,
         exclude=exclude,
         community=community,
+        volumes=volumes,
+        env=env,
     )
     command = build_run_command(
         options,

{odoo_toolkit-4.1.2 → odoo_toolkit-4.2.0}/odoo_toolkit/dev/runtime.py

@@ -42,8 +42,13 @@ VOLUMES = {
     "otk-filestore": f"{HOME}/.local/share/Odoo",
     "otk-pycache": f"{HOME}/.cache/pycache",
 }
+# Where Claude Code keeps its login in a dev container: a volume of its own, so your login on your machine stays out.
+# The Odoo containers don't get it.
+CLAUDE_DIR = f"{HOME}/.claude"
+DEVCONTAINER_VOLUMES = {**VOLUMES, "otk-claude": CLAUDE_DIR}
 # Where your SSH agent is available in the container, for Odoo modules that run Git commands.
 SSH_AGENT_SOCKET = "/run/otk-ssh-agent.sock"
+ORBSTACK_SSH_AGENT = "/run/host-services/ssh-auth.sock"
 # Mounting the multiverse at one of these paths, or at one containing them, would hide files the image needs.
 SYSTEM_PATHS = ("/bin", "/etc", HOME, "/lib", "/opt", "/root", "/sbin", "/tmp", "/usr", "/var", "/venv")  # noqa: S108
 
@@ -64,6 +69,9 @@ class RunOptions:
     exclude: list[str] = field(default_factory=list[str])
     # Whether to only load Odoo Community's modules.
     community: bool = False
+    # More `--volume` and `--env` arguments for the container, like `/etc/odoo:/etc/odoo:ro` and `KEY=value`.
+    volumes: list[str] = field(default_factory=list[str])
+    env: list[str] = field(default_factory=list[str])
     # Run this command instead of Odoo, like `bash`.
     command: list[str] | None = None
     # The architecture to run. Another than the machine's runs emulated, which is slower.
@@ -121,12 +129,19 @@ def get_upgrade_paths(version_dir: Path) -> list[Path]:
     return [path for path in candidates if path.is_dir()]
 
 
-def build_odoo_command(options: RunOptions) -> list[str]:
-    """Build the command that starts Odoo in the container."""
-    version_dir = options.version_dir
-    addons_paths = get_addons_paths(version_dir, exclude=options.exclude, community=options.community)
-    command = [
-        str(version_dir / "odoo" / "odoo-bin"),
+def get_odoo_args(
+    version_dir: Path, *, exclude: Collection[str] = (), community: bool = False, upgrade: bool = False,
+) -> list[str]:
+    """Get the Odoo options that load the modules of a version and connect Odoo to the shared services.
+
+    :param version_dir: The version directory.
+    :param exclude: The repositories to leave out of the addons path, like `enterprise`.
+    :param community: Whether to only load Odoo Community's modules.
+    :param upgrade: Whether to add the upgrade scripts, if their repositories are linked into the version.
+    :return: The options, without the path of `odoo-bin`.
+    """
+    addons_paths = get_addons_paths(version_dir, exclude=exclude, community=community)
+    args = [
         f"--addons-path={','.join(str(path) for path in addons_paths)}",
         f"--db_host={DB_HOST}",
         "--db_user=odoo",
@@ -141,9 +156,19 @@ def build_odoo_command(options: RunOptions) -> list[str]:
         "--limit-time-cpu=99999",
         "--limit-time-real=99999",
     ]
-    if options.upgrade and (upgrade_paths := get_upgrade_paths(version_dir)):
-        command.append(f"--upgrade-path={','.join(str(path) for path in upgrade_paths)}")
-    command += options.odoo_args
+    if upgrade and (upgrade_paths := get_upgrade_paths(version_dir)):
+        args.append(f"--upgrade-path={','.join(str(path) for path in upgrade_paths)}")
+    return args
+
+
+def build_odoo_command(options: RunOptions) -> list[str]:
+    """Build the command that starts Odoo in the container."""
+    version_dir = options.version_dir
+    command = [
+        str(version_dir / "odoo" / "odoo-bin"),
+        *get_odoo_args(version_dir, exclude=options.exclude, community=options.community, upgrade=options.upgrade),
+        *options.odoo_args,
+    ]
     if options.debug_port:
         # Only say the debugger is ready once it listens, since Visual Studio Code attaches right away.
         launcher = (
@@ -200,12 +225,39 @@ def build_run_command(
     run += ["--env", f"PYTHONPYCACHEPREFIX={VOLUMES['otk-pycache']}"]
     for key, value in git_identity.items():
         run += ["--env", f"{key}={value}"]
+    for volume in options.volumes:
+        run += ["--volume", volume]
+    for variable in options.env:
+        run += ["--env", variable]
     run += get_ssh_agent_args(ssh_agent)
     return [*run, get_image_tag(options.version), *command]
 
 
+def normalize_volume(volume: str) -> str:
+    """Make the path on your machine in a `--volume` absolute, since Docker takes a relative one for a volume's name.
+
+    `~` stands for your home folder, and `.` or `..` for the current folder. Names of volumes stay as they are.
+    """
+    source, separator, rest = volume.partition(":")
+    if separator and source.startswith(("~", ".")):
+        source = str(Path(source).expanduser().resolve())
+    return f"{source}{separator}{rest}"
+
+
+def is_orbstack() -> bool:
+    """Check whether Docker runs on OrbStack, which can't mount the socket of your SSH agent from your machine."""
+    result = subprocess.run(["docker", "info", "--format", "{{.Name}}"], capture_output=True, text=True, check=False)
+    return result.stdout.strip() == "orbstack"
+
+
 def get_ssh_agent() -> Path | None:
-    """Get the socket of your SSH agent (like the one of Bitwarden or 1Password), if one is running."""
+    """Get the socket of your SSH agent (like the one of Bitwarden or 1Password), if one is running.
+
+    OrbStack provides your agent at a fixed path in its virtual machine instead. It uses the `IdentityAgent` of your
+    `~/.ssh/config`, if you have one.
+    """
+    if sys.platform == "darwin" and is_orbstack():
+        return Path(ORBSTACK_SSH_AGENT)
     socket_path = os.environ.get("SSH_AUTH_SOCK")
     if not socket_path:
         return None