Skip to main content
Yanked

This release has been yanked by its maintainers, and will be ignored by installers, except when explicitly specified.
Consider using release 0.2.3 instead.

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.

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
logout Forget the saved session
projects List your projects
builds <project> Recent builds for a project. --type development|staging|production, --limit
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.1.tar.gz (12.5 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.1-py3-none-any.whl (11.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: doploy_cli-0.2.1.tar.gz
  • Upload date:
  • Size: 12.5 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.1.tar.gz
Algorithm Hash digest
SHA256 bd5d00d672554ed561145d56937f0bfa1a7279834c975d7ab0a57d0c800a26e6
MD5 39f1ccabcd40f4d2c0cab05dd96a5ac6
BLAKE2b-256 d55dcc2dd915b6b7ed4802f3a18653c175da84a8e24cafe15cbbb8e86d8b834d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: doploy_cli-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 11.1 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4bebeb561ddd1e81464c291ae12e09de43987ea2128f06387670a81df2c9b2e0
MD5 5dce6cffe2b307fac7076fc1710d96aa
BLAKE2b-256 d2d1b6e7e883b1b7b3622062dc9128cd134d3fc83a5eb8377629d9798d7d5082

See more details on using hashes here.

Release history Release notifications | RSS feed

0.2.3

2 files

0.2.2

2 files

This release

0.2.1 This release

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