Skip to main content

odoo-activity

A terminal UI for Odoo instances, on this machine or on a remote host over ssh. One screen: host cpu/mem/uptime, every Odoo instance (systemd --user or supervisor) with its databases nested underneath, and a detail pane for process/log/db inspection.

Installation

uv tool install odoo-activity

Usage

odoo-activity                    # or: oa — this machine
oa openerp@somehost              # a remote host over ssh
oa openerp@somehost -p 10113     # ...on a non-default ssh port

Discovers Odoo instances under systemd --user, supervisor, and odoo.sh (all three are merged), and needs the odoo-db CLI on PATH for the database category tabs. The Config tab additionally needs odoo-config and odoo-addons-path on PATH. See Managers for what each one supports.

Key Action
/ move through instances and their nested dbs
s / r start/stop toggle / restart (confirm popup)
[ / ] switch tab in the detail pane
f maximize/minimize the focused pane
p / l / c / t Top / Logs / Config / Toolbox
u / l / j / c Users / Locks / Jobs / Crons
K kill -9 the selected process (Top tab, confirm popup)
L kill -3 the selected process, then jump to Stacks (Top tab)
D dump stacks of all workers, then jump to Stacks
S copy the instance's odoo shell launch command to the clipboard
e cycle compact/explain/expand/clean (Config tab)
enter run the selected tool (Toolbox tab, confirm popup) / open a row's raw json (db tabs)
/ search (Logs and Config tabs)
R refresh the active tab now
q quit

Two tabs on each side have no letter shortcut — cycle to them with [/] or click: Processes and Stacks (instance mode), Queries and Modules (database mode).

Toolbox (t) offers four tools:

  • Spin a worker up (SIGTTIN) or down (SIGTTOU).
  • Open shell — which copies the launch command instead of signaling, so it needs no confirm.
  • Count sessions under the instance's data dir (walks the filesystem, may be slow).

Remote hosts

The target is any ssh destination — [user@]host or a ~/.ssh/config alias. Only the tools already required locally are needed, but on the remote host. Connections are multiplexed, so the first call opens the session and the rest reuse it.

Everything still refreshes on its own against a remote host, just on a slower tick — host stats and Top every 5s, the instance list every 15s. R refreshes the active tab immediately, plus the instance list and the highlighted instance's databases.

MCP server

oa-mcp [host] exposes the same read-only data as an MCP server, for an agent to work an investigation alongside a human on oa [host] — both looking at the same target. Every tool call is pinned to host (local if omitted); a host/ssh_port argument on a tool call must match the pin or is rejected.

oa-mcp-multi instead leaves the target per-call, capped by --host-filter (an odoo dbfilter-style regex; unset means unrestricted) and --host-file (which ~/.ssh/config-style file reads aliases from).

Both default to the stdio transport (spawned by the MCP client); add --transport streamable-http --bind-host ... --bind-port ... to run as a network server instead.

Managers

An instance's managersystemd, supervisor, or odoosh — is discovered per instance, not configured, and decides which controller process/log/start-stop-restart lookups route through:

  • systemd — a systemd --user unit, controlled via systemctl --user.
  • supervisor — a supervisorctl status program, controlled via supervisorctl.
  • odoosh — the odoo.sh build a host is running, when odoo-activity itself runs directly on that host (installed via requirements.txt at build time, same as odoo-config/odoo-db). One host is one build, so there's nothing to enumerate — the whole box is "the instance". Start/stop isn't supported (odoo.sh handles sleep/wake on its own); restart goes through odoosh-restart, needed on PATH — which ships pre-installed on odoo.sh hosts.

Config tab modes

e cycles the Config tab through odoo-config's compact/explain/ expand/clean views of the highlighted instance's config file — see odoo-config's CLI docs for what each one shows.

ODOO_ACTIVITY_DB_ROLE overrides the postgres role used to resolve an instance's databases (default: the instance's db_user, falling back to its name).

Architecture

odoo_activity/
├── host.py            # local vs ssh command dispatch
├── probes.py          # all system data: no Textual import, shared by the TUI and MCP server
├── mcp_server.py      # oa-mcp / oa-mcp-multi: probes.py as a read-only MCP tool API
├── panes/detail.py    # ActivityPane: the one stateful rendering widget
├── panes/processes.py   # Processes tab: workers grouped by role
├── panes/stacks.py    # Stacks tab: parsed dumpstacks, busy-first
└── tui.py             # app shell: layout, list, timers, actions
  • host.py — a Host is this machine or an ssh destination. Every probe takes one and runs the same way against either, so nothing above this layer knows whether it is local or remote.
  • probes.py — pure functions, no UI. Every systemctl/supervisorctl/ ps/psql call and /proc read lives here, returning plain dicts/lists so it's testable without spinning up a screen. An instance's databases, logfile and top all resolve from one config: its <workdir>/config/{odoo.conf,server.conf}.
  • mcp_server.py — thin @mcp.tool() wrappers over probes.py, no logic of its own; the same data the TUI shows, for an agent instead of a human (see MCP server).
  • panes/detail.pyActivityPane, the one stateful render widget: a tab strip over a Log/DataTable/Tree, mode-switched by whatever's highlighted (see Modes below) — not a separate popup screen. Delegates the Processes and Stacks tab bodies to panes/processes.py/panes/stacks.py.
  • tui.py — the shell only: compose() layout, the nested instances+dbs ListView, focus/highlight wiring, refresh timers, start/stop/restart. Delegates rendering to ActivityPane, data to probes.py, confirm popups to panes/confirm.py's ConfirmScreen (shared with ActivityPane, which also confirms mutating actions like Toolbox).

Modes

ActivityPane mode-switches on whatever's highlighted in the instances list:

  • Instance mode — an instance row is highlighted. Tabs: Top, Processes, Stacks, Logs, Config, Toolbox.
  • Database mode — one of its nested database rows is highlighted. Tabs: Queries, Users, Locks, Jobs, Crons, Modules.

Both modes share the same tab strip and Log/DataTable widgets (just a _mode flag), and several letter-key shortcuts are reused across them for whichever tab they map to in each (e.g. l is Logs in instance mode, Locks in database mode).

Data sources

  • Instancessystemctl --user list-units and supervisorctl status, merged by name.
  • Databases — each instance's <workdir>/config/{odoo.conf,server.conf} gives a db role (or ODOO_ACTIVITY_DB_ROLE); psql lists the databases owned by that role.
  • Top — the manager gives the instance's master pid (systemctl ... -p MainPID / supervisorctl pid); ps -eo pid,ppid,user,%mem,args is then walked down the ppid tree from there to find every worker.
  • Logs — the same config gives logfile, tailed by reading backward in fixed-size chunks from the end so a multi-GB file costs a few reads, not a full scan.
  • Config — read-only: odoo-config {compact,explain,expand,clean} is run against the instance's config file and its plain-text stdout is shown as-is; the version passed to it comes from odoo-addons-path <workdir> --verbose --format json's version key.

Download files

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

Source Distribution

odoo_activity-0.12.0.tar.gz (71.8 kB view details)

Uploaded Source

Built Distribution

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

odoo_activity-0.12.0-py3-none-any.whl (74.3 kB view details)

Uploaded Python 3

File details

Details for the file odoo_activity-0.12.0.tar.gz.

File metadata

  • Download URL: odoo_activity-0.12.0.tar.gz
  • Upload date:
  • Size: 71.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for odoo_activity-0.12.0.tar.gz
Algorithm Hash digest
SHA256 1b9133b7c49a82ef76c779d88871191f7a052b2930b71e5102b2118f84dfbd35
MD5 7a785b3e3bfb5a02f36c904d18ac2107
BLAKE2b-256 4dafe8291e4a1b911fb489a50f404ba112c4fc8e48ed31432d3f579d783a614a

See more details on using hashes here.

Provenance

The following attestation bundles were made for odoo_activity-0.12.0.tar.gz:

Publisher: release.yaml on trobz/odoo-activity

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file odoo_activity-0.12.0-py3-none-any.whl.

File metadata

  • Download URL: odoo_activity-0.12.0-py3-none-any.whl
  • Upload date:
  • Size: 74.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for odoo_activity-0.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5559291c60a3f89e12b8629834c7094b7ffe7618ea817e482013e2298c4a4566
MD5 37b7ebe68c122e4eafdc8d4de77c80b2
BLAKE2b-256 f8e1f61a7f14d310abe4078a4952c90e22fc198555bd85052019f8c16db9894f

See more details on using hashes here.

Provenance

The following attestation bundles were made for odoo_activity-0.12.0-py3-none-any.whl:

Publisher: release.yaml on trobz/odoo-activity

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.23.0

2 files

0.22.0

2 files

0.21.0

2 files

0.20.0

2 files

0.19.1

2 files

0.19.0

2 files

0.18.0

2 files

0.17.0

2 files

0.16.0

2 files

0.15.1

2 files

0.15.0

2 files

0.14.0

2 files

0.13.0

2 files

0.12.2

2 files

0.12.1

2 files

This release

0.12.0 This release

2 files

0.11.0

2 files

0.10.0

2 files

0.9.0

2 files

0.8.0

2 files

0.7.0

2 files

0.6.0

2 files

0.5.0

2 files

0.4.0

2 files

0.3.0

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