https://github.com/bibermann/doco-cli

A command line tool for docker compose projects and rsync backups
https://github.com/bibermann/doco-cli

Last synced: 2 months ago
JSON representation

A command line tool for docker compose projects and rsync backups

• Host: GitHub
• URL: https://github.com/bibermann/doco-cli
• Owner: bibermann
• License: gpl-3.0
• Created: 2022-10-30T08:37:06.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-12-08T18:43:40.000Z (over 3 years ago)
• Last Synced: 2024-09-18T16:19:47.063Z (almost 2 years ago)
• Language: Python
• Size: 265 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Doco CLI

**doco** (**do**cker **co**mpose tool) is a command line tool

for working with [Docker Compose](https://docs.docker.com/compose/compose-file/) projects

(pretty-printing status, creating backups using rsync, batch commands and more).

[![Python 3.9.2](https://img.shields.io/badge/python-3.9.2-blue.svg)](https://www.python.org/downloads/release/python-392/)

[![Code style](https://github.com/bibermann/doco-cli/actions/workflows/pre-commit.yml/badge.svg)](https://github.com/bibermann/doco-cli/actions/workflows/pre-commit.yml)

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

[![PyPI](https://img.shields.io/pypi/v/doco-cli)](https://pypi.org/project/doco-cli)

## Usage

Example calls:

- `doco s *`: Print pretty status of all _docker compose_ projects in the current directory.

- `doco s . -VV`: 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](docs/doco-help.md).

## Installation

```bash

pipx install doco-cli

doco --install-completion

```

Or install from source, see [docs/installation.md](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](docs/configuration.md).

## Development

To start developing, see [docs/development.md](docs/development.md).