docker-assemble 0.6.2

CLI tool for extracting Docker image filesystems, inspecting large files, and rebuilding optimized Docker images.

docker-assemble

docker-assemble is a Python CLI tool for extracting Docker image filesystems, inspecting image contents, finding large files, and rebuilding optimized Docker images.

It helps developers, researchers, and DevOps engineers understand what is inside a Docker image by exporting the image filesystem into a local directory. You can use it to analyze container images, inspect files, identify oversized files, and optionally create a new Docker image after removing selected files.

Features

• Extract the filesystem of a Docker image into a local directory
• Pull an image automatically if it is not available locally
• Inspect Docker image contents for research, debugging, and optimization
• Detect files larger than a configurable size limit
• Optionally remove selected large files
• Rebuild a new Docker image from the filtered filesystem
• Simple command-line interface built with Python

What's new in 0.6.0

• Streaming fast-path rebuild. When --maximum-file-size is not set, image rebuilds now stream docker export → docker import instead of writing a temp tar and running docker build. Much faster on large images, and runtime metadata (CMD, ENTRYPOINT, ENV, WORKDIR, USER, EXPOSE, VOLUME, LABEL) is now carried into the rebuilt image. Previous versions rebuilt via FROM scratch + COPY . /, which dropped this metadata.
• New --no-extract flag to skip on-disk extraction when you only want the rebuilt image (requires --new-image-name; incompatible with --maximum-file-size).
• Bug fixes: extraction no longer fails with PermissionError on read-only directories (UBI/RHEL rootfs); errors during rebuild/extraction no longer leak the temporary sleep infinity container or get masked by an AttributeError in cleanup.

Why use docker-assemble?

Docker images can contain unnecessary files, large artifacts, cached dependencies, logs, build leftovers, or other filesystem content that increases image size. docker-assemble makes it easier to inspect the full filesystem of an image and understand what contributes to its size.

This can be useful for:

• Docker image analysis
• Container image optimization
• DevOps research
• Security and filesystem inspection
• Finding large files inside Docker images
• Rebuilding smaller Docker images
• Understanding image contents without manually creating containers

Installation

Install from PyPI:

pip install docker-assemble

System-wide installation (all users)

To make docker-assemble available to every user on a shared machine, install it outside any single user's home directory.

Option 1 — Dedicated venv in /opt + symlink

Works on any system with Python 3.8+ and avoids conflicts with OS-managed Python packages:

sudo python3 -m venv /opt/docker-assemble
sudo /opt/docker-assemble/bin/pip install docker-assemble
sudo ln -s /opt/docker-assemble/bin/docker-assemble /usr/local/bin/docker-assemble

Any user with /usr/local/bin on their PATH can now run docker-assemble. To upgrade later:

sudo /opt/docker-assemble/bin/pip install -U docker-assemble

Option 2 — pipx (global)

With pipx 1.5 or newer:

sudo pipx install docker-assemble

On Ubuntu 24.04 (which ships pipx 1.4.3, predating --global), use environment variables instead:

sudo apt install pipx
sudo PIPX_HOME=/opt/pipx PIPX_BIN_DIR=/usr/local/bin pipx install docker-assemble

Both forms place the entry point in /usr/local/bin/docker-assemble.

Requirements

• Python 3.8+
• Docker installed and running
• Access to the Docker daemon

Basic usage

Extract a Docker image filesystem into a local directory:

docker-assemble -d ubuntu:20.04 output_dir

This extracts the filesystem of ubuntu:20.04 into output_dir.

Analyze large files

You can scan the extracted filesystem for files larger than a given size:

docker-assemble -d ubuntu:20.04 output_dir --maximum-file-size 100M

Supported size suffixes include:

• K for kilobytes
• M for megabytes
• G for gigabytes

Examples:

docker-assemble -d ubuntu:20.04 output_dir --maximum-file-size 10M
docker-assemble -d python:3.11 output_dir --maximum-file-size 500M
docker-assemble -d node:20 output_dir --maximum-file-size 1G

Rebuild a Docker image

Pass --new-image-name to rebuild the extracted filesystem as a single-layer image (FROM scratch + COPY . /). --maximum-file-size is optional:

• Without --maximum-file-size — no files are filtered out. The new image contains the same content as the original, just consolidated into one layer. Useful for comparing a multi-layer original against a squashed single-layer version without conflating filtering effects.

  docker-assemble -d ubuntu:20.04 output_dir \
    --new-image-name ubuntu-squashed
  

  In this no-filter case docker-assemble uses a streaming fast-path: it pipes the container filesystem straight from docker export into docker import, never writing an intermediate tar to disk or extracting files one by one. This is substantially faster on large images and avoids filesystem-level surprises (e.g. read-only directories on UBI/RHEL rootfs). Runtime metadata from the source image (CMD, ENTRYPOINT, ENV, WORKDIR, USER, EXPOSE, VOLUME, LABEL) is carried over to the rebuilt image.

• With --maximum-file-size — docker-assemble lists files above the threshold, asks which should be removed, and rebuilds the image without them:

  docker-assemble -d ubuntu:20.04 output_dir \
    --maximum-file-size 100M \
    --new-image-name ubuntu-optimized
  

  When files are filtered out, the fast-path cannot be used (individual members must be inspected), so docker-assemble falls back to exporting, filtering, and rebuilding via docker build.

Skipping on-disk extraction (--no-extract)

By default docker-assemble extracts the filesystem to output_dir even when you only want a rebuilt image. If you only need the rebuilt image, add --no-extract to skip the disk extraction entirely and rebuild straight from the streaming fast-path. Since nothing is written to disk, the output_dir argument can be omitted:

docker-assemble -d ubuntu:20.04 \
  --new-image-name ubuntu-squashed \
  --no-extract

--no-extract requires --new-image-name and is incompatible with --maximum-file-size (file filtering needs the extracted filesystem).

Package

docker-assemble is available on PyPI:

pip install docker-assemble

PyPI: https://pypi.org/project/docker-assemble/

Debug mode

Enable debug logging with:

docker-assemble --debug -d ubuntu:20.04 output_dir

Example workflow

# Extract a Docker image filesystem
docker-assemble -d python:3.11 python-image-filesystem

# Find files larger than 100 MB
docker-assemble -d python:3.11 python-image-filesystem --maximum-file-size 100M

# Rebuild a new image after removing selected large files
docker-assemble -d python:3.11 python-image-filesystem \
  --maximum-file-size 100M \
  --new-image-name python-optimized

Use cases

docker-assemble is useful when you need to:

• inspect the contents of a Docker image
• analyze why a Docker image is large
• identify unnecessary files in a container image
• export an image filesystem for research
• compare Docker image contents
• create a smaller image after removing selected files
• debug container filesystem structure

How it works

docker-assemble uses the Docker SDK for Python to access Docker images. If the requested image is not available locally, it pulls the image. It then creates a temporary container, exports the container filesystem, extracts it into the selected output directory, and optionally rebuilds a new image.

There are two rebuild paths:

• Streaming fast-path (no --maximum-file-size): the container filesystem is piped from docker export directly into docker import. No on-disk tar, no per-file extraction, no tar.extract permission edge cases. Source-image runtime config (CMD, ENTRYPOINT, ENV, WORKDIR, USER, EXPOSE, VOLUME, LABEL) is reapplied to the rebuilt image via import changes.
• Filter-and-build path (with --maximum-file-size): the filesystem tar is filtered member-by-member to drop selected files, then rebuilt with docker build (FROM scratch + COPY . /).

Note on metadata preservation: the fast-path reapplies the common runtime config keys listed above. It does not reproduce non-config image attributes such as HEALTHCHECK, STOPSIGNAL, SHELL, or ONBUILD, and — like any docker import/FROM scratch rebuild — it produces a fresh single-layer image with new history. If you need a byte-for-byte faithful image config, rebuild from the original Dockerfile instead.

Project status

This project is in active development. Contributions, issues, and suggestions are welcome.

License

This project is licensed under the Apache License 2.0.

Docker is a trademark of Docker, Inc. This project is not affiliated with or endorsed by Docker, Inc.