Detailed informationa about usage

This commit is contained in:
jpk 2023-01-10 11:11:04 +01:00
parent 4d075c1925
commit 9591395aa4
1 changed files with 23 additions and 1 deletions

View File

@ -3,11 +3,16 @@
## Installation
```shell
pipx install git+https://git.goatpr0n.de/public/doxy.git
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
@ -69,3 +74,20 @@ Commands:
To add parameters to an control argument use "--" to end the *Doxy* parameter evaluation and pass
them to *docker-compose*.
## Examples
### List available services
```shell
$ doxy list
Available Services
├── service-1
├── service-2
├── other-service
└── my-service-demo
```
### Start a service and detach
```shell
$ doxy control other-service up -- -d
```