Skip to main content

doploy CLI

PyPI Python License: MIT

The command line for doploy, the Odoo hosting and CI platform. Watch builds, read test results and logs, and drive deployments from your terminal.

$ doploy builds acme --type development
ID    TYPE         STATUS        FQDN                        COMMIT_SHA  CREATED
418   development  Active Error  doploy-k3j9x2.doploy.site   9f1c2ab     2026-09-11T14:02:11

$ doploy tests 418
build 418 [Active Error] — 1 errors, 0 failures, 2 warnings

[ERROR] sale_custom.test_discounts

Install

pipx install doploy-cli

or with pip, uv, or pip install --user:

pip install doploy-cli
uv tool install doploy-cli

Requires Python 3.10 or newer.

Using it from a coding agent

doploy skill install

Installs a skill file so Claude Code knows when to use doploy, how to find ids, and the push → build → read failures → fix loop. doploy skill print >> AGENTS.md does the same for Codex and other agents.

Sign in

doploy login

Your browser opens, you sign in with your doploy account, and the CLI is connected. Sessions renew themselves. Sign out with doploy logout.

What the CLI may do is decided per app in Settings → Connected apps on the doploy dashboard: read only, or read and deploy, on all projects or only some. Change it there at any time; the change applies on the CLI's next command.

Quick start

doploy projects                              # your projects and their ids
doploy builds <project-id> --type staging    # recent builds
doploy build <build-id>                      # one build in full
doploy tests <build-id> --details            # test failures with tracebacks
doploy logs <build-id> --source test -f      # follow the test log until the build settles

Commands

Command Description
login Sign in with your browser
skill install Teach Claude Code to use doploy (skill print for AGENTS.md)
logout Forget the saved session
projects List your projects
builds <project> Live builds for a project. --type development|staging|production, --limit, --all
branches <project> Live branches with their ids
build <id> One build: status, commit, versions, error summary
tests <build> Test failures for a build. --details prints tracebacks, --warnings includes warnings
logs <build> Tail logs. --source build|test|odoo, --lines, --filter TEXT, -f to follow
branch create <project> <name> Fork a development branch on GitHub and queue its build. --from <branch-id>
rebuild <build> Queue a rebuild of a deployment
restart <build> Restart the Odoo service
update-modules <build> [modules] Run odoo-bin -u on the modules doploy detected as changed, or the ones you list. --theme, --no-theme, --wait
operation <id> Check a queued module update. --wait
backup <build> Take a database and filestore backup. --comment, --wait

Commands that print tables accept --json for machine-readable output.

Anything aimed at a production deployment requires --confirm. Nothing destructive is available: no deletes, no restores, no domain changes.

Examples

Why did my build fail?

doploy builds acme --type development --limit 1
doploy tests 418 --details
doploy logs 418 --source test --filter ERROR

Follow a build as it runs

doploy logs 419 --source test -f

Exits on its own when the build settles. --source odoo follows the running container's log instead and runs until Ctrl-C.

Ship a change to staging

doploy update-modules 302 --wait

Updates exactly the modules doploy saw change in the last code update, waits for Odoo to finish, and exits non-zero if the update failed. Add --theme to rebuild website theme assets, or leave it out and doploy decides from the module list.

Take a backup first

doploy backup 301 --confirm --wait --comment "before v2.4"

Log sources

--source What you get
build doploy's own build log and error summary. Fast, default.
test The Odoo test run output of a development build. What actually failed.
odoo The running Odoo container's log. Runtime tracebacks on staging and production.

Links

License

MIT

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

doploy_cli-0.2.3.tar.gz (14.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

doploy_cli-0.2.3-py3-none-any.whl (13.7 kB view details)

Uploaded Python 3

File details

Details for the file doploy_cli-0.2.3.tar.gz.

File metadata

  • Download URL: doploy_cli-0.2.3.tar.gz
  • Upload date:
  • Size: 14.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for doploy_cli-0.2.3.tar.gz
Algorithm Hash digest
SHA256 9e17f47c88e76b773f1ef2227e09b6d21d1c75458852223cb69ceb5f5a7ab4c0
MD5 2fd879b6fd106f1f20041a1fd2e4ef60
BLAKE2b-256 0c7c4b6ec42c7fb3417374eafa2b97660801086000a508757669347c167f41e4

See more details on using hashes here.

File details

Details for the file doploy_cli-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: doploy_cli-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 13.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for doploy_cli-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 42ca0e692f68c06c37f42618c811126c8ba6f564844ff13074d1577bb93feeed
MD5 d46423a807c04f8db6ca6747ab937700
BLAKE2b-256 9be54247ed8a0ad43930f08fe2d7f01efa1c62efcc9a417c23333b219b404564

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.2.3 This release

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page