An intuitive CLI to help ease your Docker setup

What are these helpers?

These include helpers for you to understand your docker images quickly and efficiently.

inspect_container[source]

inspect_container(container_name:"The name of a downloaded DockerHub container")

Reports all possible configuration values for a container

Parameters:

  • container_name : str <The name of a downloaded DockerHub container>

With this function, we can quickly see what all possible parameters we can setup for a docker container. This also has the shortcut of di (shorthand for Docker Investigate, how I envision this in my head).

We can see an example output below:

NOTE:These do not include inherit arguments for general docker, such as -v to mount volumes, and so forth. For an exhaustive list of those, see the documentation here

Image: nbdev

Command for Running Container: docker run 

Possible Arguments:
┏━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃   Argument(s)     Value                                                                  ┃
┡━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│     --expose     │ 8888/tcp                                                               │
├──────────────────┼────────────────────────────────────────────────────────────────────────┤
│        -l        │ repo2docker.ref='None'                                                 │
├──────────────────┼────────────────────────────────────────────────────────────────────────┤
│        -l        │ repo2docker.repo='local'                                               │
├──────────────────┼────────────────────────────────────────────────────────────────────────┤
│        -l        │ repo2docker.version='2021.08.0'                                        │
├──────────────────┼────────────────────────────────────────────────────────────────────────┤
│        -e        │ 'PATH=/home/runner/.local/bin:/home/runner/.local/bin:/srv/conda/envs… │
├──────────────────┼────────────────────────────────────────────────────────────────────────┤
│        -e        │ 'DEBIAN_FRONTEND=noninteractive'                                       │
├──────────────────┼────────────────────────────────────────────────────────────────────────┤
│        -e        │ 'LC_ALL=en_US.UTF-8'                                                   │
├──────────────────┼────────────────────────────────────────────────────────────────────────┤
│        -e        │ 'LANG=en_US.UTF-8'                                                     │
├──────────────────┼────────────────────────────────────────────────────────────────────────┤
│        -e        │ 'LANGUAGE=en_US.UTF-8'                                                 │
├──────────────────┼────────────────────────────────────────────────────────────────────────┤
│        -e        │ 'SHELL=/bin/bash'                                                      │
├──────────────────┼────────────────────────────────────────────────────────────────────────┤
│        -e        │ 'USER=runner'                                                          │
├──────────────────┼────────────────────────────────────────────────────────────────────────┤
│        -e        │ 'HOME=/home/runner'                                                    │
├──────────────────┼────────────────────────────────────────────────────────────────────────┤
│        -e        │ 'APP_BASE=/srv'                                                        │
├──────────────────┼────────────────────────────────────────────────────────────────────────┤
│        -e        │ 'NPM_DIR=/srv/npm'                                                     │
├──────────────────┼────────────────────────────────────────────────────────────────────────┤
│        -e        │ 'NPM_CONFIG_GLOBALCONFIG=/srv/npm/npmrc'                               │
├──────────────────┼────────────────────────────────────────────────────────────────────────┤
│        -e        │ 'CONDA_DIR=/srv/conda'                                                 │
├──────────────────┼────────────────────────────────────────────────────────────────────────┤
│        -e        │ 'NB_PYTHON_PREFIX=/srv/conda/envs/notebook'                            │
├──────────────────┼────────────────────────────────────────────────────────────────────────┤
│        -e        │ 'NB_ENVIRONMENT_FILE=/tmp/env/environment.lock'                        │
├──────────────────┼────────────────────────────────────────────────────────────────────────┤
│        -e        │ 'KERNEL_PYTHON_PREFIX=/srv/conda/envs/notebook'                        │
├──────────────────┼────────────────────────────────────────────────────────────────────────┤
│        -e        │ 'REPO_DIR=/home/runner'                                                │
├──────────────────┼────────────────────────────────────────────────────────────────────────┤
│        -e        │ 'CONDA_DEFAULT_ENV=/srv/conda/envs/notebook'                           │
├──────────────────┼────────────────────────────────────────────────────────────────────────┤
│        -e        │ 'PYTHONUNBUFFERED=1'                                                   │
├──────────────────┼────────────────────────────────────────────────────────────────────────┤
│ -d, --entrypoint │ "/usr/local/bin/repo2docker-entrypoint"                                │
└──────────────────┴────────────────────────────────────────────────────────────────────────┘