VibeHunt
Back to browse

docker-pushrm

Push a readme to container registries.

Source

A Docker CLI plugin adds a `docker pushrm` command that reads a local README file and updates the description of the corresponding repository on supported container registries. It works with Docker Hub, Red Hat Quay (cloud or self‑hosted) and Harbor v2, using the Docker credentials store for authentication when possible, or an API key via environment variable or config file for other registries. The command can target a specific README path, set a short description, and prefers a dedicated `README‑containers.md` if present.

The tool is intended for developers who maintain container images and want the registry’s web interface to reflect the same documentation as their source repository. It can be installed as a native Docker CLI plugin or run from an OCI image, making it suitable for local use and CI pipelines. Integration examples are provided for GitHub Actions and GitLab CI/CD, where environment variables configure the target registry, credentials, and optional short description.

Reviews

Sign in to leave a review.

Loading reviews…

Similar apps