NAME

dozo - Docker with Zero Overhead

SYNOPSIS

dozo -I IMAGE [ options ] [ command ... ]

-h, --help         show help
    --version      show version
-d, --debug        debug mode (show full command)
-x, --trace        trace mode (set -x)
-q, --quiet        quiet mode
-n, --dryrun       dry-run mode (do not run docker)

-I, --image=#      Docker image (required unless -D)
-D, --default      use default image (DOZO_DEFAULT_IMAGE or tecolicom/xlate)
-E, --env=#        environment variable to inherit (repeatable)
-W, --mount-cwd    mount current working directory
-H, --mount-home   mount home directory
-V, --volume=#     additional volume to mount (repeatable)
-U, --unmount      do not mount any directory
    --mount-mode=# mount mode (rw or ro, default: rw)
-R, --mount-ro     mount read-only (shortcut for --mount-mode=ro)
-B, --batch        batch mode (non-interactive)
-N, --name=#       live container name
-K, --kill         kill and remove existing container
-L, --live         use live (persistent) container
-P, --port=#       port mapping (repeatable)
-O, --other=#      additional docker options (repeatable)

VERSION

Version 0.9924

USAGE

When executed without arguments, dozo starts an interactive shell inside the container. When arguments are given, they are executed as a command.

dozo -I alpine                  # start shell
dozo -I alpine ls -la           # run command

By setting -D or your favorite image with -I in ~/.dozorc, you can simply run dozo without specifying an image. Since the git top directory is automatically mounted, git commands work as expected from anywhere in the tree.

$ dozo                          # start shell
$ dozo git log -p               # run git log -p

With -L option, you can use a persistent container. Tools installed in the container will remain available for subsequent use.

$ dozo -L                       # start shell and create container
# apt update && apt install -y cowsay
# exit
$ dozo -L /usr/games/cowsay Hello
 _______
< Hello >
 -------
        \   ^__^
         \  (oo)\_______
            (__)\       )\/\
                ||----w |
                ||     ||

DESCRIPTION

dozo is a generic Docker runner that simplifies running commands in Docker containers. The name "dozo" comes from the Japanese word meaning "please" or "go ahead", and also stands for "Docker with Zero Overhead".

It automatically configures the tedious Docker options such as volume mounts, environment variables, working directories, and interactive terminal settings, so you can focus on the command you want to run.

dozo is distributed as a standalone module and can be used as a general-purpose Docker runner. It was originally developed as part of App::Greple::xlate and is used by xlate for Docker operations.

dozo uses getoptlong.sh for option parsing.

Key Features

Git Friendly: If you are working in a git environment, the git top directory is automatically mounted. Otherwise the current directory is mounted.
Live Container: Use -L to create or attach to a persistent container that survives between invocations. Container names are automatically generated from the image name and mount directory.
Environment Inheritance: Common environment variables are automatically inherited: LANG, TZ, proxy settings, terminal settings, and API keys for AI/LLM services (DeepL, OpenAI, Anthropic, Perplexity).
Flexible Mounting: Various mount options: current directory (-W), home directory (-H), additional volumes (-V), read-only mode (-R), or no mount (-U).
X11 Support: When DISPLAY is set, the host IP is automatically detected and passed to the container, enabling GUI applications.
Configuration File: Use .dozorc to set default options. Searched in current directory, git top directory, and home directory.
Standalone Operation: dozo can operate independently of xlate. The distribution includes getoptlong.sh as a submodule in the share/getoptlong directory. If the module is installed via CPAN, it searches for getoptlong.sh via File::Share::dist_dir('App-dozo'). Otherwise, it searches for getoptlong.sh in the standard PATH.

OPTIONS

-h, --help

Show help message.

-d, --debug

Enable debug mode. Shows the full docker command line that will be executed.

-x, --trace

Enable trace mode (set -x).

-q, --quiet

Quiet mode.

-n, --dryrun

Dry-run mode. Show docker commands without executing them. Useful for testing and debugging.

-I image, --image=image

Specify Docker image. Required unless -D is given, but you can put it in .dozorc so you don't have to type it every time.

-D, --default

Use the default Docker image. If DOZO_DEFAULT_IMAGE environment variable is set, use that image. Otherwise, use tecolicom/xlate:VERSION where VERSION is the current dozo version. See "DEFAULT IMAGE" section for details about the default image.

-E name[=value], --env=name[=value]

Specify environment variable to inherit. Repeatable.

-W, --mount-cwd

Mount current working directory.

-H, --mount-home

Mount home directory.

-V path, -V from:to, --volume=from:to

Specify additional directory to mount. If only path is given (without :), it is mounted to the same path in the container. Repeatable.

-U, --unmount

Do not mount any directory.

--mount-mode=mode

Set mount mode. mode is either rw (read-write, default) or ro (read-only).

-R, --mount-ro

Mount directory as read-only. Shortcut for --mount-mode=ro.

-B, --batch

Run in batch mode (non-interactive).

-N name, --name=name

Specify container name explicitly.

-K, --kill

Kill and remove existing container.

-L, --live

Use live (persistent) container.

-P port, --port=port

Specify port mapping (e.g., 8080:80). Repeatable.

-O option, --other=option

Specify additional docker options. Repeatable.

Note: Spaces and commas in option values are treated as delimiters and will split the value into multiple elements.

LIVE CONTAINER

The -L option enables live (persistent) container mode. Unlike normal mode where containers are removed after execution (--rm), live containers persist between invocations, allowing you to maintain state and reduce startup overhead.

Container Lifecycle

When -L is specified, dozo behaves as follows:

1. Container does not exist: Create a new persistent container (without --rm flag).
2. Container exists and is running: If a command is given, execute it using docker exec. Otherwise, attach to the container using docker attach.
3. Container exists but is paused: Unpause the container with docker unpause, then proceed as above.
4. Container exists but is exited: Start the container with docker start, then proceed as above.

Container Naming

Container names are automatically generated in the format:

<image_name>.<mount_directory>

For example, if you run:

dozo -I tecolicom/xlate -L

from /home/user/project, the container name would be xlate.project.

You can override the auto-generated name using the -N option:

dozo -I tecolicom/xlate -L -N mycontainer

Managing Live Containers

Attach to existing container

dozo -I myimage -L

If no command is given, attaches to the container's main process.

Execute command in existing container

dozo -I myimage -L ls -la

Runs the command in the existing container using docker exec.

Kill and recreate container

dozo -I myimage -KL

The -K option removes the existing container before -L creates a new one. Useful when you need a fresh container state.

Kill container only

dozo -I myimage -K

Without -L, the container is removed and the command exits.

Interactive Mode

In live container mode, interactive mode (-i and -t flags for Docker) is automatically enabled when:

Standard input is a terminal (TTY)
The -B (batch) option is not specified

This allows seamless interactive use when attaching to containers or running interactive commands.

CONFIGURATION FILE

.dozorc files are loaded from the following locations in order:

1. Home directory .dozorc
2. Git top directory .dozorc (if different)
3. Current directory .dozorc
4. Command line arguments

For single-value options (like -I, -N), later values override earlier ones. For repeatable options (like -E, -V, -P, -O), all values are accumulated in order.

You can use any command line option in the configuration file:

# Example .dozorc
-I tecolicom/xlate:latest
-E CUSTOM_VAR=value
-V /data:/data

Lines starting with # are treated as comments.

DOCKER-IN-DOCKER

To use Docker commands inside the container, mount the host's Docker socket:

# .dozorc for Docker-in-Docker
-I docker
-V /var/run/docker.sock

This allows you to run Docker commands from within the container using the host's Docker daemon:

$ dozo docker run --rm alpine uname -a

Or run it as a one-liner without .dozorc:

$ dozo -I docker -V /var/run/docker.sock docker run --rm alpine uname -a

DEFAULT IMAGE

The tecolicom/xlate image is specifically designed for document translation and text processing tasks, providing a comprehensive environment with the following features:

Translation and AI Tools

DeepL CLI - Command-line interface for DeepL translation API
gpty - GPT command-line tool for AI-powered text processing
llm - Unified LLM interface with plugins for multiple providers: Gemini, Claude 3, Perplexity, and OpenRouter

Text Processing Tools

greple with xlate module - Pattern-based text extraction and translation
sdif - Side-by-side diff viewer with word-level highlighting
ansicolumn, ansifold, ansiexpand - ANSI-aware text formatting tools
optex textconv - Document format converter (PDF, Office, etc.)

Greple Extensions

Multiple App::Greple extension modules are pre-installed:

msdoc - Microsoft Office document support
xp - Extended pattern syntax
subst - Text substitution with dictionary
frame - Frame-style output formatting

Git Integration

The image includes a pre-configured git environment optimized for document comparison and review. Since dozo automatically mounts the git top directory by default, git commands work seamlessly with full repository context:

Side-by-side diff - git diff, git log, and git show use sdif for word-level side-by-side comparison
Colorful blame - git blame uses greple for enhanced label coloring
Office document diff - Compare Word (.docx), Excel (.xlsx), and PowerPoint (.pptx) files directly with git
PDF diff - View PDF metadata changes
JSON diff - Normalized JSON comparison using jq

Additional Utilities

MeCab - Japanese morphological analyzer with IPA dictionary
poppler-utils - PDF processing tools (pdftotext, etc.)
jq, yq - JSON and YAML processors

Environment

Based on Ubuntu with Japanese locale (ja_JP.UTF-8)
Perl and Python3 runtime environments
Common API keys are automatically inherited from host (DEEPL_AUTH_KEY, OPENAI_API_KEY, ANTHROPIC_API_KEY, etc.)

ENVIRONMENT

Configuration Variables

DOZO_DEFAULT_IMAGE: Specifies the default Docker image used when -D (--default) option is given. If not set, tecolicom/xlate:VERSION is used where VERSION is the current dozo version.

Inherited Variables

The following environment variables are inherited by default:

LANG TZ
HTTP_PROXY HTTPS_PROXY http_proxy https_proxy
TERM_PROGRAM TERM_BGCOLOR COLORTERM
DEEPL_AUTH_KEY OPENAI_API_KEY ANTHROPIC_API_KEY LLM_PERPLEXITY_KEY

Container Variables

The following environment variables are set inside the container:

DOZO_RUNNING_ON_DOCKER=1: Indicates the command is running inside a container started by dozo.
XLATE_RUNNING_ON_DOCKER=1: For compatibility with xlate. Used to prevent recursive Docker invocation when xlate is run inside the container.

AUTHOR

Kazumasa Utashiro

LICENSE

This software is released under the MIT License. https://opensource.org/licenses/MIT

To install App::dozo, copy and paste the appropriate command in to your terminal.

cpanm

cpanm App::dozo

CPAN shell

perl -MCPAN -e shell
install App::dozo

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)