{"id":13501551,"url":"https://github.com/chrismaille/cabrita","last_synced_at":"2025-03-29T09:30:48.832Z","repository":{"id":51677218,"uuid":"112797414","full_name":"chrismaille/cabrita","owner":"chrismaille","description":"TUI dashboard for easy visualization of docker services","archived":false,"fork":false,"pushed_at":"2021-05-10T19:03:19.000Z","size":388,"stargazers_count":11,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-08-01T22:55:31.635Z","etag":null,"topics":["dashboard","docker","docker-compose","terminal","tui"],"latest_commit_sha":null,"homepage":"http://cabrita.readthedocs.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chrismaille.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-12-01T23:41:22.000Z","updated_at":"2023-02-21T21:58:29.000Z","dependencies_parsed_at":"2022-08-22T04:40:29.434Z","dependency_job_id":null,"html_url":"https://github.com/chrismaille/cabrita","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrismaille%2Fcabrita","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrismaille%2Fcabrita/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrismaille%2Fcabrita/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrismaille%2Fcabrita/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chrismaille","download_url":"https://codeload.github.com/chrismaille/cabrita/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222481507,"owners_count":16991463,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dashboard","docker","docker-compose","terminal","tui"],"created_at":"2024-07-31T22:01:41.371Z","updated_at":"2024-10-31T20:31:41.824Z","avatar_url":"https://github.com/chrismaille.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"## Welcome to Cabrita's documentation!\n\n![PyPI](https://img.shields.io/pypi/v/cabrita.svg)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/cabrita.svg)\n[![Documentation Status](https://readthedocs.org/projects/cabrita/badge/?version=latest)](https://cabrita.readthedocs.io/en/latest/?badge=latest)\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/ea94adacb6664984916474a909c4c4e4)](https://www.codacy.com/app/chrismaille/cabrita?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=chrismaille/cabrita\u0026amp;utm_campaign=Badge_Grade)\n[![Maintainability](https://api.codeclimate.com/v1/badges/3475b300e01e18d8c9e8/maintainability)](https://codeclimate.com/github/chrismaille/cabrita/maintainability)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit\u0026logoColor=white)](https://github.com/pre-commit/pre-commit)\n\nCabrita is a Terminal Dashboard for docker services. You can easily\nfollow the status for your docker containers:\n\n* Which services are running\n* The ports used by each one\n* The number of instances\n* The git status for the source code inside them\n* The container healthcheck status, if available\n\n### Install\n\n```shell\n$ pip install cabrita\n```\n\n### Usage\n\nUsage is very simple: just change directory where's your\n`docker-compose.yml` is located and run:\n\n```bash\n$ cd /path/to/your/docker_compose\n$ cab # or cabrita\n```\n\n[![asciicast](https://asciinema.org/a/Z31bttxgBe4JhuyBPvLYomoqc.svg)](https://asciinema.org/a/Z31bttxgBe4JhuyBPvLYomoqc)\n\nYou can also pass the full path for the `docker-compose.yml` files on\ncommand line:\n\n```bash\n$ cab /path/to/docker-compose-file /path/to/docker-compose-override\n```\n\n### Customize Dashboard\n\nTo customize cabrita you can create a yaml file, to create and configure\n_boxes_. You can select which docker containers will show in each box\nand what info these boxes will show for each service inside them.\n\nFor example, copy and paste this yaml and save the `cabrita.yml` in the\nsame directory where your `docker-compose.yml` is located:\n\n```yaml\nversion: 2\ntitle: My Docker Project\nbackground_color: grey # options: black, blue, cyan, grey, yellow, white\ncompose_files:\n  - ./docker-compose.yml\nboxes:\n  main_box:\n    main: true\n    name: My Services\n    port_view: status # options: column, name, status\n    port_detail: internal # options: internal, external or both\n    show_revision: true # will show commit hash and git tag if available\n    watch_branch: origin/staging # check how ahead or behind you are regard this branch\n  django:\n    name: Django Apps\n    show_git: false\n    includes:  # this box will show only services named in includes and categories options\n      - django\n    categories: # for each included service, add column for each category below\n      - worker\n      - redis\nwatchers:\n  ping:  # ping watchers are using to ping informed address each n seconds.\n    google:\n      name: Check internet connectivity\n      address: https://www.google.com\n      message_on_success: UP\n      message_on_error: DOWN\n```\n\nLet's use our docker project located in `/sheep` folder. To start\ncabrita with the new setup you can type:\n\n```bash\n# Start docker project services first\n$ cd path/to/sheep\n$ TEST_PROJECT_PATH=$(pwd) docker-compose up -d\n\n# Then, you can call directy the app passing the yaml path:\n$ cab --path cabrita.yml\n\n# Or you can use the CABRITA_PATH environment variable:\n$ export CABRITA_PATH=/path/to/cabrita.yml\n$ cab\n```\n\nYour Dashboard will show like this:\n\n![Image](docs/assets/c1.png)\n\n### More Info\n\n- For more advanced customization, please check the *tutorial*\n- For the complete list of cabrita options, please check the *Cabrita\n  File Reference*\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrismaille%2Fcabrita","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchrismaille%2Fcabrita","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrismaille%2Fcabrita/lists"}