public
/
doxy
1
0
Fork 0
Code Issues Pull Requests Releases 3 Activity

Updated README.md

This commit is contained in:
jpk 2023-01-12 08:54:42 +01:00
parent 3788324fbe
commit 1b30386865
1 changed files with 48 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

86
README.md
View File

@ -13,44 +13,6 @@ pipx install git+https://github.com/jaypikay/doxy.git
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:
```shell
_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:
```shell
_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`:
@ -59,6 +21,16 @@ 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**
```shell
#!/bin/bash
/usr/bin/docker compose $@
exit 0
```
## Usage
```
@ -97,3 +69,41 @@ $ doxy control other-service up -- -d
```shell
$ doxy edit service-2
```
### Bash
#### Alternative 1
Add this to ~/.bashrc:
```
eval "$(_DOXY_COMPLETE=bash_source doxy)"
```
#### Alternative 2
Save the script:
```shell
_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:
```shell
_DOXY_COMPLETE=zsh_source doxy > ~/.doxy-complete.zsh
```
Add this to ~/.zshrc:
```
. ~/.foo-bar-complete.zsh
```