Skip to main content

A terminal tool to audit, optimize, and visualize Docker-Compose stacks in real-time

Project description

Composure

A terminal tool to audit, optimize, and visualize Docker-Compose stacks in real-time.

Python 3.9+ License: MIT PyPI Docker

Quick Install

pip install composure

Or choose your preferred method below.

What is Composure?

Composure is a TUI (Terminal User Interface) dashboard that helps you:

  • Monitor all your Docker containers in real-time
  • Detect waste by comparing actual resource usage vs allocated limits
  • Visualize networks to see how containers connect to each other
  • Control containers directly from the terminal (start, stop, restart, view logs)
  • Pull images with a single overall progress bar across all images

Features

  • Resource Monitoring: See CPU and memory usage for all containers
  • Waste Detection: Identify over-provisioned containers with waste scores
  • Limit Awareness: Quickly spot containers without resource limits
  • Network Visualization: Tree view showing container network topology
  • Container Controls: Start, stop, restart containers with keyboard shortcuts
  • Live Logs: View recent logs for any container
  • Image Pull Progress: Pull all images from docker-compose.yml with a single overall progress percentage
  • Parallel Loading: Fast startup even with many containers

Installation

pip (recommended)

pip install composure

pipx (isolated environment)

pipx install composure

uv

uv tool install composure

Docker

docker run -it -v /var/run/docker.sock:/var/run/docker.sock jamesdimonaco/composure

Debian/Ubuntu

# One-line install script
curl -fsSL https://jamesdimonaco.github.io/composure/install.sh | sudo bash
Or install manually
# Add the GPG key
curl -fsSL https://jamesdimonaco.github.io/composure/gpg.key | sudo gpg --dearmor -o /usr/share/keyrings/composure.gpg

# Add the repository
echo "deb [signed-by=/usr/share/keyrings/composure.gpg] https://jamesdimonaco.github.io/composure stable main" | sudo tee /etc/apt/sources.list.d/composure.list

# Install
sudo apt update
sudo apt install composure

From source

git clone https://github.com/JamesDimonaco/composure.git
cd composure
pip install -e .

Usage

composure

Pull Images

Pull all images from your docker-compose.yml with a single overall progress percentage:

composure pull

This shows real-time progress across all images downloading in parallel:

Pulling 3 images from docker-compose.yml

⠙ Overall              ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━  36%  847MB / 2.3GB
    nginx:alpine       ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100%  done
    redis:alpine       ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━  45%  pulling
    postgres:15-alpine ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━  20%  pulling

You can also press p in the TUI to pull images.

JSON Output

For scripting and CI/CD pipelines, use --json to get machine-readable output:

composure pull --json

Outputs one JSON object per line with progress updates:

{"percent": 36.5, "downloaded_bytes": 847000, "total_bytes": 2300000, "images_complete": 1, "images_total": 3, ...}

Python API

Use composure programmatically in your Python scripts:

from composure import pull

# With progress updates
for progress in pull("/path/to/project"):
    print(f"{progress.percent:.0f}% complete")
    print(f"Images: {progress.images_complete}/{progress.images_total}")

# Or just get final result
result = pull("/path/to/project", progress=False)
print(f"Pulled {result.images_complete} images")

The PullProgress object contains:

  • percent - Overall percentage (0-100)
  • downloaded_bytes / total_bytes - Byte counts
  • images_complete / images_total - Image counts
  • completed_layers / total_layers - Layer counts
  • images - Dict with per-image details

Keyboard Shortcuts

Key Action
q Quit
r Refresh / Return from logs
n Toggle network view
s Stop selected container
a Start selected container
x Restart selected container
l Show logs for selected container
p Pull all images from docker-compose.yml
? Show help
↑/↓ Navigate containers

Understanding the Dashboard

Main View

Container     Status   CPU %  CPU Limit  RAM Used  RAM Limit  Efficiency  Waste
nginx         running  0.5%   2 cores    45 MB     512 MB     LOW         90
api           running  2.1%   No limit   128 MB    256 MB     MEDIUM      40
postgres      running  1.2%   1 core     256 MB    512 MB     GOOD        20

Columns Explained

Column Description
Status running, exited, paused, etc.
CPU % Current CPU usage
CPU Limit Configured limit (or "No limit")
RAM Used Current memory usage
RAM Limit Configured limit (or "No limit")
Efficiency LOW/MEDIUM/GOOD/HIGH utilization
Waste 0-100 score (higher = more over-provisioned)

Waste Score

The waste score helps identify containers that have been allocated far more resources than they're using:

Score Color Meaning
0-30 Green Good utilization
30-60 Yellow Could be optimized
60-100 Red Significantly over-provisioned

Network View

Press n to see a tree view of your Docker networks:

Docker Networks
├── Compose Networks
│   └── myapp_default (3 containers)
│       ├── nginx
│       ├── api
│       └── postgres
└── System Networks
    └── bridge (empty)

Requirements

  • Python 3.9+
  • Docker Engine running locally
  • Access to Docker socket

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT License - see LICENSE for details.

Links

Project details


Download files

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

Source Distribution

composure-0.1.8.tar.gz (21.2 kB view details)

Uploaded Source

Built Distribution

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

composure-0.1.8-py3-none-any.whl (20.8 kB view details)

Uploaded Python 3

File details

Details for the file composure-0.1.8.tar.gz.

File metadata

  • Download URL: composure-0.1.8.tar.gz
  • Upload date:
  • Size: 21.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for composure-0.1.8.tar.gz
Algorithm Hash digest
SHA256 3e0fc51d113c25b94ccf625667c22a2d4f0e5ed3304f275f2d4181d7e4a7ffab
MD5 786096038dc29dedca4fd3ffe58c700f
BLAKE2b-256 0f84e132b50e5e1e9501b57e6aee71c32856fa388554796c1ff19609a60876b0

See more details on using hashes here.

File details

Details for the file composure-0.1.8-py3-none-any.whl.

File metadata

  • Download URL: composure-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 20.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for composure-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 49f6f098ed0bc5697f49f7bb78d4c7cf1423779577d9fc21258a17cd4469217d
MD5 8695f0a7062fc1ea9e05839947759617
BLAKE2b-256 bee9cfffe71886ef1c779cb33c549873fbcb5f4a21928b78159af6e23a856acf

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page