Skip to main content

Goodbye docker login & a long repository URL for Amazon ECR :)

Project description

https://img.shields.io/pypi/pyversions/ecr-cli.svg https://travis-ci.org/laughingman7743/ecr-cli.svg?branch=master https://codecov.io/gh/laughingman7743/ecr-cli/branch/master/graph/badge.svg https://img.shields.io/pypi/l/ecr-cli.svg

ecr-cli

Goodbye docker login & a long registry URL for Amazon ECR :)

Requirements

  • Python
    • CPython 2,7, 3,4, 3.5, 3.6
  • Docker
    • API version >= 1.21

Installation

$ pip install ecr-cli

ECR Configuration file

If you place a file in YAML format with the filename .ecr.yml in the same directory as Dockerfile, profile name, region name, registry ID and tag can be set.

Key name Value Description
profile_name str Use a specific profile from your credential file.
region_name str The region to use. Overrides config/env settings.
registry_id str AWS account ID that correspond to a Amazon ECR registry that you want to log in to.
tags seq of str Name and optionally a tag in the ‘name:tag’ format.

.ecr.yml example:

profile_name: null
region_name: us-west-2
registry_id: null
tags:
  - java/amazonlinux-oracle-java:latest
  - java/amazonlinux-oracle-java:2017.12-8u162

NOTE: Command line options override settings in this file.

Usage

Usage: ecr [OPTIONS] COMMAND [ARGS]...

Options:
  --profile TEXT        Use a specific profile from your credential file.
  --region TEXT         The region to use. Overrides config/env settings.
  --registry-id TEXT    AWS account ID that correspond to a Amazon ECR registry that you want to log in to.
  --debug / --no-debug  Turn on debug logging.
  -h, --help            Show this message and exit.

Commands:
  build  Build an image from a Dockerfile.
  pull   Pull an image or a repository from a Amazon ECR registry
  push   Push an image or a repository to a Amazon ECR registry.

Build

Usage: ecr build [OPTIONS] PATH

  Build an image from a Dockerfile.

Options:
  -t, --tag TEXT              Name and optionally a tag in the `name:tag` format.
  --dockerfile PATH           Name of the Dockerfile (Default is `PATH/Dockerfile`).
  --configfile PATH           Name of the ECR configuration file (Default is `PATH/.ecr.yml`).
  --cache / --no-cache        Use cache when building the image.
  --rm / --no-rm              Remove intermediate containers after a successful build.
  --force-rm / --no-force-rm  Always remove intermediate containers.
  --pull / --no-pull          Always attempt to pull a newer version of the image.
  --squash / --no-squash      Squash newly built layers into a single new layer.
  --push / --no-push          Push an image or a repository to a Amazon ECR registry after a successful build.
  --quiet / --no-quiet        Suppress the standard output.
  --no-profile                Forcibly disable the ECR configuration file profile.
  -h, --help                  Show this message and exit.

Push

Usage: ecr push [OPTIONS] NAME...

  Push an image or a repository to a Amazon ECR registry.

Options:
  --quiet / --no-quiet        Suppress the standard output.
  -h, --help  Show this message and exit.

Pull

Usage: ecr pull [OPTIONS] NAME...

  Pull an image or a repository from a Amazon ECR registry

Options:
  --quiet / --no-quiet        Suppress the standard output.
  -h, --help  Show this message and exit.

Authentication

Support Boto3 credentials.

Testing

TODO

TODO

  1. Progress bar can not be reset :(
  2. Vacuum command
  3. Tests

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
ecr_cli-0.0.8-py2.py3-none-any.whl (8.5 kB) Copy SHA256 hash SHA256 Wheel py2.py3
ecr-cli-0.0.8.tar.gz (6.8 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page