jpk 3097807b05 | ||
---|---|---|
doxy | ||
tests | ||
.gitignore | ||
README.md | ||
poetry.lock | ||
pyproject.toml |
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.
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
Configuration
Save the configuration file in ~/.config/doxy/config.yml
:
root_directory: "/path/to/docker/services"
compose_executable: "/usr/bin/docker-compose"
Usage
Usage: doxy [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
control
list
To add parameters to an control argument use "--" to end the Doxy parameter evaluation and pass them to docker-compose.
Examples
List available services
$ doxy list
Available Services
├── service-1
├── service-2
├── other-service
└── my-service-demo
Start a service and detach
$ doxy control other-service up -- -d