a668c6fced
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [rich](https://github.com/Textualize/rich) | dependencies | patch | `13.3.4` -> `13.3.5` | --- ### Release Notes <details> <summary>Textualize/rich</summary> ### [`v13.3.5`](https://github.com/Textualize/rich/blob/HEAD/CHANGELOG.md#​1335---2023-04-27) [Compare Source](https://github.com/Textualize/rich/compare/v13.3.4...v13.3.5) ##### Fixed - Fixed italic indent guides in SVG ouput </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS42MS4wIiwidXBkYXRlZEluVmVyIjoiMzUuNjEuMCJ9--> Co-authored-by: Renovate Bot <renovate@localhost.localdomain> Co-authored-by: JayPiKay <jpk@noreply.localhost> Reviewed-on: #7 Co-authored-by: renovate <renovate@noreply.localhost> Co-committed-by: renovate <renovate@noreply.localhost> |
||
---|---|---|
doxy | ||
tests | ||
.gitignore | ||
.pre-commit-config.yaml | ||
README.md | ||
config.example.yml | ||
poetry.lock | ||
pyproject.toml | ||
renovate.json |
README.md
Doxy
Installation
pipx install git+https://github.com/jaypikay/doxy.git
Shell completion
Service name completion
By enabling shell completion the service names are TAB-Completted when using the control
command.
Configuration
Save the configuration file in ~/.config/doxy/config.yml
:
root_directory: "/path/to/docker/services"
compose_executable: "/usr/bin/docker-compose"
If you use docker compose
instead of docker-compose
you can use a wrapper script for
docker-compose
#!/bin/bash
/usr/bin/docker compose $@
exit 0
Usage
Usage: doxy [OPTIONS] COMMAND [ARGS]...
Options:
-f, --format [fancy|simple] output formatting [default: fancy]
--help Show this message and exit.
Commands:
control run docker-compose commands
edit edit the compose file
list list available services
update pull the latest service images and restart
Examples
List available services
$ doxy list
Available Services
├── service-1
├── service-2
├── other-service
└── my-service-demo
When doxy -f simple
is used the output is easier to process by pipes.
Start a service and detach
$ doxy control other-service up -d
Edit a service
$ doxy edit service-2
Bash
Alternative 1
Add this to ~/.bashrc:
eval "$(_DOXY_COMPLETE=bash_source doxy)"
Alternative 2
Save the script:
_DOXY_COMPLETE=bash_source doxy > ~/.doxy-complete.bash
Add this to ~/.bashrc:
. ~/.foo-bar-complete.bash
Zsh
Alternative 1
Add this to ~/.zshrc:
eval "$(_DOXY_COMPLETE=zsh_source doxy)"
Alternative 2
Save the script:
_DOXY_COMPLETE=zsh_source doxy > ~/.doxy-complete.zsh
Add this to ~/.zshrc:
. ~/.foo-bar-complete.zsh