Interactive terminal UI for streaming and filtering Docker Compose container logs across multiple services
Project description
docker-orb
Watching logs across a multi-container Compose stack usually means juggling
multiple docker compose logs windows and grepping after the fact, or
writing complex regex just to add a couple of filters. docker-orb streams
logs from every container in your selected services into one merged,
colorized view — and lets you filter, highlight, and search while it's
streaming.
Built with Textual, docker-orb is a full terminal UI: an interactive setup wizard walks you through picking a project, services, and filter patterns — no flags required — or skip straight to the viewer with CLI arguments if you prefer. Save named session configs to reload your exact setup later; passively collect rare events in a monitor panel without losing your scroll position; get alerted when containers restart or go unhealthy; and add or remove services from the live stream without restarting.
Features
- Multi-container live tail — stream logs from any number of containers/services at once, each with a distinct color.
- Filters — hide lines matching a pattern, live-editable mid-session.
- Highlights — emphasize lines matching a pattern without hiding anything else.
- Monitors — passively collect matching lines into a separate panel so you
can watch for rare events (e.g.
job failed) without losing your scroll position in the main stream. - Live search — search the whole buffered session, jump to a result, and keep streaming.
- Container health panel — flags containers that aren't
Runningor have crossed a restart threshold; restart a container or recreate a service from inside the app. - Dump mode — fetch existing logs once (with
--tail/--since) and exit, for scripting or one-off inspection, instead of a live stream. - Saved configs — save a named combination of project, services, and patterns, and reload it later by name.
- JSON log formatting — auto-detects structured JSON log lines and shows
time LEVEL message key=value ...instead of a raw JSON blob, with a toggle back to raw and a detail view (Enter on a clicked line) for the full pretty-printed object. - Collapse repeated lines — journalctl-style: consecutive identical lines from the same container fold into a single "last line repeated N times" marker, toggleable, so a crash-looping container doesn't flood the stream.
Installation
Requires Python 3.10+, and docker with the Compose v2 plugin on your
PATH (i.e. docker compose works). docker-orb shells out to your existing
docker CLI and inherits its context/auth — no separate credentials or
Docker SDK involved.
# Recommended — pipx keeps CLI tools in isolated environments. Not on PyPI
# yet, so install straight from GitHub:
pipx install git+https://github.com/adlidev/docker-orb
# Or with plain pip, inside your own venv:
git clone https://github.com/adlidev/docker-orb.git
cd docker-orb
pip install -e .
This installs two commands: docker-orb and docker-orb-inject (a small
test utility for injecting fake log lines into a running container — see
the User Guide).
For development / contributing:
git clone https://github.com/adlidev/docker-orb.git
cd docker-orb
pip install -e . --group dev
Quick start
# No arguments — launches the interactive setup wizard
docker-orb
# Skip the wizard: watch two services live
docker-orb -n myapp -p api -p worker
# Watch every service in a project
docker-orb -n myapp --all-containers
# One-shot dump instead of a live stream
docker-orb -n myapp --dump --tail 500
# Pre-filter/highlight from the command line
docker-orb -n myapp -p worker -f DEBUG -H ERROR --health
-n/--project takes the Compose project name (what docker compose -p
expects — usually the directory name your docker-compose.yml lives in,
unless overridden by a top-level name: key or COMPOSE_PROJECT_NAME). If
omitted, docker-orb resolves it the same way docker compose does for the
current directory.
Once you're in the viewer, press F / H / M to edit filters, highlights,
or monitors live, / to search, P to add/remove streamed services, and
Space to pause. See the User Guide for the full
keybinding reference and pattern syntax.
Development
pip install -e . --group dev
pytest # run the test suite
textual run --dev src/docker_orb/__main__.py # live-reload dev mode
A local Compose stack with 8 fake log-generating services is included for manual testing:
cd infra
make up
docker-orb -n logviewer-demo --all-containers --health
See infra/README.md for the service list and good
filter/monitor test patterns, and CLAUDE.md for architecture
notes.
Relationship to kube-orb
docker-orb is a sibling project to kube-orb,
Adli's Kubernetes-flavored log viewer. They share a UI architecture (Textual
viewer, wizard, filters/highlights/monitors, JSON formatting) but each talks
to its own backend directly — docker-orb shells out to docker/docker compose, kube-orb shells out to kubectl — and they're maintained as
independent tools rather than one project trying to do both.
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file docker_orb-1.0.0.tar.gz.
File metadata
- Download URL: docker_orb-1.0.0.tar.gz
- Upload date:
- Size: 270.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3439a6760952f0c780c5500dcca3d0dbc608aade58fed8e1e92ef61d261201b5
|
|
| MD5 |
113dc4579ce6977e4a263ad08f4d760a
|
|
| BLAKE2b-256 |
c04c995c4f133d662aeec9c698a1dea6e24120cc87d64a66618242701a1035fc
|
File details
Details for the file docker_orb-1.0.0-py3-none-any.whl.
File metadata
- Download URL: docker_orb-1.0.0-py3-none-any.whl
- Upload date:
- Size: 63.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0d512eba4e392b056e4f1cd10c7c78752e75304f79409d9af258f93f79382dad
|
|
| MD5 |
bda8b3b650ce6e715d79023ba382e458
|
|
| BLAKE2b-256 |
069ecba3b522f87db797ce6095ea92dc3c64e2f0a14e2414efa3c1c77fd19e43
|