Skip to content
Back to search

shpilot

MarketplaceWorks with Claude CodeGitHub

shpilot: Odoo.sh for Claude Code.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 17 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/Mahmoudd777/shpilot with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/Mahmoudd777/shpilot'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/mahmoudd777--shpilot/badge.svg)](/listings/mahmoudd777--shpilot)

HTML

<a href="/listings/mahmoudd777--shpilot"><img src="/api/listings/mahmoudd777--shpilot/badge.svg" alt="findsafeskills safety rating" /></a>

Install

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Claude Code plugin

/plugin marketplace add Mahmoudd777/shpilot
/plugin install shpilot@shpilot

Then ask Claude to set up shpilot. The skill runs `skills/shpilot/scripts/setup.sh`, which installs the `shpilot` command with [uv](https://docs.astral.sh/uv/) from that checkout, with exact-pinned dependencies, and checks the machine: browsers, keyring, the guard's dialog, your SSH key.

Clone into Claude Code's skills

git clone https://github.com/Mahmoudd777/shpilot ~/.claude/skills/shpilot
~/.claude/skills/shpilot/skills/shpilot/scripts/setup.sh

The command alone, without Claude Code

uv tool install git+https://github.com/Mahmoudd777/shpilot
shpilot --version

Python 3.12 or newer. uv fetches one if needed.

Claude Code permissions (optional)

skills/shpilot/scripts/setup.sh --claude-permissions

This adds rules to `~/.claude/settings.json`, after saving a backup next to it:

- **allow**: the read-only commands (`auth status`, `auth browsers`, `projects list`, `builds list`, `builds watch`, `logs`, `backups list`, `guard show`, and similar) - **ask**: `shpilot ssh`, `web-session`, `auth login`, `auth logout`, every command that changes something (including `guard allow` and `guard ask`), and plain `ssh`, `scp`, `rsync` and `sftp` to an `odoo.com` host - **deny**: Claude Code's edit tools on the guard's file (a shell command is covered by the ask rules only as far as Claude Code's prompts go)

They sit in front of the guard and do not replace it.

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

.claude-plugin/marketplace.json · Manifest · 12 lines
  1. {
  2. "name": "shpilot",
  3. "owner": { "name": "Mahmoud Shrief, Global Solutions" },
  4. "description": "shpilot: Odoo.sh for Claude Code.",
  5. "plugins": [
  6. {
  7. "name": "shpilot",
  8. "source": "./",
  9. "description": "Odoo.sh builds, live logs, backups and SSH from Claude Code, with a production guard."
  10. }
  11. ]
  12. }
README.md · README · 299 lines
  1. # shpilot
  2. [![CI](https://github.com/Mahmoudd777/shpilot/actions/workflows/ci.yml/badge.svg)](https://github.com/Mahmoudd777/shpilot/actions/workflows/ci.yml)
  3. [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
  4. Odoo.sh from the terminal, and from AI coding agents such as Claude Code. Wait for a build after a
  5. push, read its install and server logs, follow a log live, list backups, open SSH on a staging
  6. build, and click-test a staging build in a headless browser as any of its users. Every change to
  7. production, and every change to a whole project, waits for a person to allow it in a dialog on the
  8. desktop; a command an agent runs cannot answer it, so the change stops with nothing sent.
  9. shpilot is built on [odouche](https://github.com/avanserv/odouche) by Avanserv, which did the hard
  10. part. See [Credits](#credits).
  11. ```bash
  12. uv tool install git+https://github.com/Mahmoudd777/shpilot
  13. shpilot auth login
  14. git push && shpilot builds watch || shpilot logs
  15. ```
  16. ![setup.sh checking the machine](screenshots/01-setup.png)
  17. > shpilot is unofficial and not affiliated with Odoo S.A. "Odoo" and "Odoo.sh" are trademarks of
  18. > Odoo S.A. Odoo.sh has no public API: shpilot uses what the Odoo.sh web page uses. When Odoo.sh
  19. > changes, a command can stop working. It then fails with exit 6 and says so. It does not return
  20. > wrong data.
  21. ## What it does
  22. Inside a git checkout that Odoo.sh builds, the project and branch come from git. Anywhere else, pass
  23. `--project <name> --branch <branch>`.
  24. ```bash
  25. shpilot projects list # your Odoo.sh projects
  26. shpilot branches list # each branch and its stage
  27. shpilot builds list # newest first
  28. shpilot builds watch # waits for the latest build; exit code is its result
  29. shpilot logs # end of the latest build's log
  30. shpilot logs --kind odoo --all | grep -nE "ERROR|CRITICAL|Traceback"
  31. shpilot logs --kind odoo -f --timeout 120 # follow the server log while you reproduce a bug
  32. shpilot builds mails # mails a staging or development build caught
  33. shpilot backups list
  34. shpilot ssh --branch staging # a shell on the staging build
  35. ```
  36. Add `--format json` before the group (`shpilot --format json builds list`) for output a script can
  37. parse. `shpilot builds watch` exits 0 on success, 20 on a failed build, 21 on warnings, so this works
  38. as one line:
  39. ```bash
  40. git push && shpilot builds watch || shpilot logs --all | grep -n -B5 -A30 Traceback
  41. ```
  42. ![A day's use: watch a build, read the log](screenshots/05-daily-use.png)
  43. Changes are there too: `builds rebuild`, `backups create|download|pull`, `branches move`,
  44. `branches settings set`, `projects settings set` (including the IP allow list), `projects members
  45. add|role`. The full reference, with every exit code, is [docs/cli.md](docs/cli.md), or
  46. `shpilot <group> <command> --help`.
  47. ## The production guard
  48. These wait for a person before anything is sent:
  49. - every change to a production branch: rebuild, backup, branch settings, moving a branch
  50. - every change to a whole project: its settings, its IP allow list, its members
  51. - downloading or copying a production backup to this machine
  52. - `shpilot ssh` on a production build
  53. Listing and reading (builds, logs, mails, the backup list) is never guarded. Nothing on a staging or
  54. development branch is guarded; a branch whose stage shpilot does not recognise counts as production.
  55. The guard asks in this order:
  56. 1. A desktop dialog (zenity or kdialog on Linux, osascript on macOS) with **Once**, **Always for
  57. \<project\>** and **No**.
  58. 2. The terminal the command was started from (`/dev/tty`, never stdin), when there is no desktop.
  59. 3. Nowhere: the command exits **16** and nothing is sent. An AI agent's shell has no terminal, so
  60. when you are not at the desktop, this is what the agent gets.
  61. ![An agent's production change refused with exit 16](screenshots/04-guard-refused.png)
  62. "Always" is stored per project in `~/.config/shpilot/guard.json` (macOS: `~/Library/Application
  63. Support/shpilot/`; Windows: `shpilot\guard.json` in the AppData folder Windows reports). The path
  64. never comes from the environment (`$HOME`, `$XDG_CONFIG_HOME`, `%APPDATA%`), which the caller can set. The dialog programs are
  65. run by their system paths only (Windows PowerShell from System32), never found on `PATH`.
  66. ```bash
  67. shpilot guard show # projects that no longer ask
  68. shpilot guard allow acme # stop asking for acme; the guard asks you to confirm once
  69. shpilot guard allow '*' # stop asking for every project, the same way
  70. shpilot guard ask acme # ask again for acme (or '*' for every project); needs no yes
  71. ```
  72. **Always allow, so an agent does not ask you every time.** Click **Always for \<project\>** in the
  73. dialog the first time, or run `shpilot guard allow <project>` (or `'*'`) once and confirm. From then
  74. on production changes on that project go ahead without the dialog, until `shpilot guard ask`. An
  75. agent can start `shpilot guard allow` for you, but only your click confirms it. If you also added the
  76. Claude Code rules below, Claude Code asks before such commands too; answer its prompt with "don't
  77. ask again" for the ones you want to run freely.
  78. What the guard stops: an accidental change, and an injected one run as written, the command an
  79. agent runs because a build log, a mail or a web page told it to. What it does not stop: anything set
  80. on getting around it. An agent whose shell runs without asking you can be led to edit `guard.json`,
  81. fake a terminal, or use the stored session directly, and once Odoo.sh allowed this machine's IP
  82. (staging SSH does), plain `ssh` reaches production without shpilot. Keep the agent's shell on
  83. prompts: the `--claude-permissions` rules below ask before raw `ssh`/`rsync` to Odoo.sh.
  84. [docs/security.md](docs/security.md) has the details.
  85. ## Logging in
  86. You choose how. shpilot never picks a way for you.
  87. ```bash
  88. shpilot auth browsers # browsers here, and which hold an Odoo.sh login
  89. shpilot auth login --from firefox # reuse that browser's Odoo.sh login
  90. shpilot auth login --window # sign in with GitHub in a fresh window
  91. shpilot auth login --paste # paste the session_id cookie, without echo
  92. ```
  93. - **`--from <browser>`** (firefox, chrome, chromium, brave, edge, vivaldi, opera) reads one cookie,
  94. `session_id` of `www.odoo.sh`, from that browser, and nothing else. `auth browsers` lists them
  95. without decrypting anything. Chromium-family browsers encrypt the cookie; shpilot decrypts it in
  96. its own process, and the keyring may ask you to unlock it first.
  97. - **`--window`** opens a browser window with a fresh profile, in which you sign in to Odoo.sh with
  98. GitHub. The profile is deleted afterwards. It finds Chrome, Chromium, Edge, Brave, Vivaldi and
  99. Opera, including Brave and Chromium installed as Ubuntu snaps. Set `SHPILOT_BROWSER` to a name or
  100. path to choose one.
  101. - **`--paste`** asks for the cookie in a prompt that does not echo. Use it over SSH or in a
  102. container.
  103. With no option, at a terminal, `shpilot auth login` shows a numbered menu. Without a terminal (an
  104. agent's shell) it exits 2 and lists the choices, so the agent has to ask you.
  105. ![Choosing how to log in](screenshots/02-login-choice.png)
  106. Each way, the session is checked with Odoo.sh before it is stored. What shpilot keeps is that
  107. session alone, in your operating system's keyring, for 30 days at most. Your GitHub password and
  108. token never pass through shpilot. `shpilot auth status` shows the session; `shpilot auth logout`
  109. ends it on Odoo.sh and removes it.
  110. ## SSH
  111. ```bash
  112. shpilot ssh --branch staging
  113. shpilot ssh --branch staging --yes -- 'odoo-bin --version'
  114. ```
  115. When the build keeps your machine out, shpilot offers to press Odoo.sh's "Allow my IP" for one hour
  116. (`--yes` presses it without asking). The rule takes a few minutes to apply; shpilot retries
  117. meanwhile, then hands over to your own `ssh`.
  118. ![A shell on a staging build](screenshots/06-ssh.png)
  119. `Permission denied (publickey)` means your public key is not on your Odoo.sh profile. Odoo.sh does
  120. not use your GitHub keys on its own: on www.odoo.sh, open your name (top right) > Profile > SSH Keys
  121. and add it.
  122. ![Odoo.sh profile, SSH Keys](screenshots/07-ssh-keys.png)
  123. ## Browser tests on staging
  124. `shpilot web-session` makes a web session on a staging or development build as any user, with no
  125. password, so a headless browser can test a screen as that user.
  126. ```bash
  127. shpilot web-session login --branch staging --out ./sessions admin 7 # logins or user ids
  128. shpilot web-session logout --branch staging --out ./sessions
  129. shpilot web-session logout --branch staging --out ./sessions --all # every session shpilot made there
  130. ```
  131. - The session is created over SSH by `odoo-bin shell` on the build. It skips the login page, so
  132. there is no password, no second factor and no login record.
  133. - Production, and any stage shpilot does not recognise, is refused in code (exit 9). The guard
  134. cannot allow it.
  135. - The session id is never printed. Each file (`<dir>/<uid>.session`) is mode 600, in a directory of
  136. mode 700. Log out when done; `--all` also removes sessions Odoo renamed since, and leftovers.
  137. The Claude Code skill wraps this in `browse.sh`, which logs in, drives headless Chromium with
  138. [Playwright](https://playwright.dev) through a small steps file, writes screenshots and a
  139. `report.json` (JS errors, failed requests), and always logs out:
  140. ```bash
  141. skills/shpilot/scripts/browse.sh <project> <branch> <uid|login> steps.js [outdir]
  142. ```
  143. It needs Node.js and Playwright (`npm install -g playwright && npx playwright install chromium`).
  144. A staging build holds a copy of production's data. Screenshots from these tests show customer data:
  145. keep them out of anything you share.
  146. ## Install
  147. ### Claude Code plugin
  148. ```text
  149. /plugin marketplace add Mahmoudd777/shpilot
  150. /plugin install shpilot@shpilot
  151. ```
  152. Then ask Claude to set up shpilot. The skill runs `skills/shpilot/scripts/setup.sh`, which installs
  153. the `shpilot` command with [uv](https://docs.astral.sh/uv/) from that checkout, with exact-pinned
  154. dependencies, and checks the machine: browsers, keyring, the guard's dialog, your SSH key.
  155. ### Clone into Claude Code's skills
  156. ```bash
  157. git clone https://github.com/Mahmoudd777/shpilot ~/.claude/skills/shpilot
  158. ~/.claude/skills/shpilot/skills/shpilot/scripts/setup.sh
  159. ```
  160. ### The command alone, without Claude Code
  161. ```bash
  162. uv tool install git+https://github.com/Mahmoudd777/shpilot
  163. shpilot --version
  164. ```
  165. Python 3.12 or newer. uv fetches one if needed.
  166. ### Claude Code permissions (optional)
  167. ```bash
  168. skills/shpilot/scripts/setup.sh --claude-permissions
  169. ```
  170. This adds rules to `~/.claude/settings.json`, after saving a backup next to it:
  171. - **allow**: the read-only commands (`auth status`, `auth browsers`, `projects list`, `builds list`,
  172. `builds watch`, `logs`, `backups list`, `guard show`, and similar)
  173. - **ask**: `shpilot ssh`, `web-session`, `auth login`, `auth logout`, every command that changes
  174. something (including `guard allow` and `guard ask`), and plain `ssh`, `scp`, `rsync` and `sftp` to
  175. an `odoo.com` host
  176. - **deny**: Claude Code's edit tools on the guard's file (a shell command is covered by the ask
  177. rules only as far as Claude Code's prompts go)
  178. They sit in front of the guard and do not replace it.
  179. ## Where it works
  180. | | Linux | macOS | Windows |
  181. | --- | --- | --- | --- |
  182. | The `shpilot` command, every read and change | yes | yes | yes |
  183. | Production guard | desktop dialog (zenity, kdialog), else terminal | desktop dialog (osascript), else terminal | Windows dialog (Windows PowerShell), else console |
  184. | Guard's "Always" kept in | `~/.config/shpilot/` | `~/Library/Application Support/shpilot/` | the AppData folder Windows reports |
  185. | Log in `--from` a browser | Firefox, Chrome, Chromium, Brave, Edge, Vivaldi, Opera (snaps too) | the same | Firefox only (Chromium binds its key to the browser on Windows) |
  186. | Log in `--window` | yes | yes | no: use `--from firefox` or `--paste` |
  187. | Session kept in | Secret Service (GNOME Keyring, KWallet) | Keychain | Credential Locker |
  188. | `shpilot ssh`, `backups pull` | hands over to `ssh` | hands over to `ssh` | prints the `ssh` command to run (exit 14) |
  189. | `web-session`, `browse.sh` (browser tests) | yes | yes | in WSL (they need the `ssh` handover) |
  190. | `setup.sh`, `browse.sh` | bash | bash | Git Bash (the shell Claude Code uses on Windows), or WSL |
  191. Every push runs the whole test suite, `setup.sh` and a smoke test of the installed command on Linux,
  192. macOS and Windows ([CI](.github/workflows/ci.yml)). The dialogs and browser logins have been used by
  193. hand on Linux; on macOS and Windows they are covered by tests that simulate the system, not yet by a
  194. person clicking. Reports from those systems are welcome.
  195. The skill works the same in every Claude Code: the desktop app's Code tab, the `claude` command in a
  196. terminal, and the VS Code and JetBrains extensions. They read the same `~/.claude/skills` folder and
  197. the same plugins, and run the same `shpilot` command.
  198. ## Troubleshooting
  199. | What you see | What it means, and what to do |
  200. | --- | --- |
  201. | Exit 16, "Stopped by the production guard" | A production or project-wide change, with no desktop dialog and no terminal to ask on. Run the same command in your own terminal, or be at the desktop to answer the dialog. Nothing was sent. |
  202. | `Permission denied (publickey)` on `shpilot ssh` | Your public key is not on Odoo.sh. www.odoo.sh > your name > Profile > SSH Keys. |
  203. | Exit 8 on `shpilot ssh` | The IP rule did not apply within ten minutes. Run it again. |
  204. | Exit 11, no usable keyring | Linux: install and unlock a Secret Service provider (`sudo apt install gnome-keyring`). Headless or CI: set `SHPILOT_SESSION`. shpilot never falls back to a file. |
  205. | Exit 3 | No session, or it expired. `shpilot auth login`. |
  206. | Exit 2 from `shpilot auth login` in an agent | Expected: the agent must ask you which way to log in, then pass `--from`, `--window` or `--paste`. |
  207. | "Odoo.sh no longer accepts the login \<browser\> holds" | Log in to www.odoo.sh in that browser again, or choose another way. |
  208. | Exit 6 | Odoo.sh answered in a shape shpilot does not read: Odoo.sh changed. Please [open an issue](https://github.com/Mahmoudd777/shpilot/issues) with the command, without any output that names a client. |
  209. | Exit 9 from `web-session` | That branch is production, or its stage is unknown. Web sessions are for staging and development only. |
  210. Every exit code is in [docs/cli.md](docs/cli.md#exit-codes). What shpilot reads, stores and sends is
  211. in [docs/security.md](docs/security.md); to report a vulnerability, see [SECURITY.md](SECURITY.md).
  212. ## Credits
  213. shpilot is [odouche](https://github.com/avanserv/odouche) 0.8.1 by
  214. [Avanserv](https://github.com/avanserv), bundled and renamed, with additions. odouche did the hard
  215. part: it worked out Odoo.sh's private API, call by call, and covers it with about 2,600 tests. All
  216. 2,639 of its tests pass on this bundle, and our additions bring the suite to over 2,700. Thank you to
  217. the odouche authors for building it with such care and publishing it under the MIT license.
  218. [NOTICE.md](NOTICE.md) lists what came from odouche.
  219. Thank you also to [Abdallah Abdelsabour](https://github.com/abdallah-abdelsabour), whose post
  220. introduced odouche to us, and whose fork,
  221. [odoo-sh-toolkit](https://github.com/abdallah-abdelsabour/odoo-sh-toolkit), explored the IP allow
  222. problem.
  223. Our additions are the production guard, the browser-login choice, `shpilot web-session`, the Claude
  224. Code skill and plugin, and `browse.sh`. [CHANGELOG.md](CHANGELOG.md) has the list.
  225. ## License
  226. MIT. See [LICENSE](LICENSE). The odouche code keeps its own MIT license, in
  227. [LICENSE.odouche](LICENSE.odouche).

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.