# 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).
[](https://github.com/bibermann/doco-cli/actions/workflows/pre-commit.yml)
[](https://www.gnu.org/licenses/gpl-3.0)
[](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 . -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](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).
Raw data
{
"_id": null,
"home_page": "https://github.com/bibermann/doco-cli",
"name": "doco-cli",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0.0,>=3.9.2",
"maintainer_email": null,
"keywords": "docker, rsync",
"author": "Fabian Sandoval Saldias",
"author_email": "fabianvss@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/37/96/e2fade8e06d9d6bea92a20f884f3c0789ec6842c31f42eb1050c4a98c7fe/doco_cli-2.2.2.tar.gz",
"platform": null,
"description": "# Doco CLI\n\n**doco** (**do**cker **co**mpose tool) is a command line tool\nfor working with [Docker Compose](https://docs.docker.com/compose/compose-file/) projects\n(pretty-printing status, creating backups using rsync, batch commands and more).\n\n[](https://github.com/bibermann/doco-cli/actions/workflows/pre-commit.yml)\n[](https://www.gnu.org/licenses/gpl-3.0)\n[](https://pypi.org/project/doco-cli)\n\n## Usage\n\nExample calls:\n\n- `doco s *`: Print pretty status of all _docker compose_ projects in the current directory.\n- `doco s . -aa`: Print most detailled status of a _docker compose_ project (including variables and volumes).\n- `doco r .`: Equivalent of `docker compose down --remove-orphans && docker compose up --build -d`.\n- `doco backups create . --dry-run --verbose`: See what would be done to create a backup of a _docker compose_ project.\n\nTo explore all possibilities, run `doco -h` or see [docs/doco-help.md](docs/doco-help.md).\n\n## Installation\n\n```bash\npipx install doco-cli\ndoco --install-completion\n```\n\nOr install from source, see [docs/installation.md](docs/installation.md).\n\n## Configuration\n\nTo create a backup, you need to either create a `doco.config.toml` file,\na `doco.config.json` file\nor set environment variables.\n\nSee [docs/configuration.md](docs/configuration.md).\n\n## Development\n\nTo start developing, see [docs/development.md](docs/development.md).\n",
"bugtrack_url": null,
"license": "GPL-3.0-only",
"summary": null,
"version": "2.2.2",
"project_urls": {
"Homepage": "https://github.com/bibermann/doco-cli",
"Repository": "https://github.com/bibermann/doco-cli"
},
"split_keywords": [
"docker",
" rsync"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ea39cb3a29cccc3c71f28c8b92b0c4f99f75dddc86628a0ccd0012d347516684",
"md5": "26471f0514018357841c622335c307ea",
"sha256": "f3a3b7eec1ed03192b43d6243767e0c6fa93fc2d1ff69a8e61f4d465741e0099"
},
"downloads": -1,
"filename": "doco_cli-2.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "26471f0514018357841c622335c307ea",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.9.2",
"size": 53895,
"upload_time": "2024-10-20T14:13:02",
"upload_time_iso_8601": "2024-10-20T14:13:02.968541Z",
"url": "https://files.pythonhosted.org/packages/ea/39/cb3a29cccc3c71f28c8b92b0c4f99f75dddc86628a0ccd0012d347516684/doco_cli-2.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3796e2fade8e06d9d6bea92a20f884f3c0789ec6842c31f42eb1050c4a98c7fe",
"md5": "40b5a7c5699e2a6e405fd715b9202214",
"sha256": "8e6cde1bc73278072948a24985f8766da39cd609e1f23926917aa29e98e0586e"
},
"downloads": -1,
"filename": "doco_cli-2.2.2.tar.gz",
"has_sig": false,
"md5_digest": "40b5a7c5699e2a6e405fd715b9202214",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0.0,>=3.9.2",
"size": 37372,
"upload_time": "2024-10-20T14:13:04",
"upload_time_iso_8601": "2024-10-20T14:13:04.306064Z",
"url": "https://files.pythonhosted.org/packages/37/96/e2fade8e06d9d6bea92a20f884f3c0789ec6842c31f42eb1050c4a98c7fe/doco_cli-2.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-20 14:13:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bibermann",
"github_project": "doco-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "doco-cli"
}
JSON
