doco-cli

A command line tool for docker compose projects and rsync backups


Keywords
docker, rsync
License
GPL-3.0-only
Install
pip install doco-cli==2.2.1

Documentation

Doco CLI

doco (docker compose tool) is a command line tool for working with Docker Compose projects (pretty-printing status, creating backups using rsync, batch commands and more).

Code style License: GPL v3 PyPI

Usage

Example calls:

  • doco s *: Print pretty status of all docker compose projects in the current directory.
  • doco s . -aa: Print most detailled status of a docker compose project (including variables and volumes).
  • doco r .: Equivalent of docker compose down --remove-orphans && docker compose up --build -d.
  • doco backups create . --dry-run --verbose: See what would be done to create a backup of a docker compose project.

To explore all possibilities, run doco -h or see docs/doco-help.md.

Installation

pipx install doco-cli
doco --install-completion

Or install from source, see docs/installation.md.

Configuration

To create a backup, you need to either create a doco.config.toml file, a doco.config.json file or set environment variables.

See docs/configuration.md.

Development

To start developing, see docs/development.md.