simono41/compose-viz
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

chore: update doc of --root-service

Browse source
This commit is contained in:
Xyphuz 2023-01-10 22:31:59 +08:00
parent 3cfe312982
commit f2d0ce0d22
1 changed files with 10 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -76,7 +76,9 @@ You need to install [Graphviz](https://graphviz.org/download/) to generate graph
#### Using `pip` #### Using `pip`
`pip install compose-viz` ```
pip install compose-viz
```
#### Using `.whl` #### Using `.whl`
@ -116,10 +118,10 @@ Check out the result [here](https://github.com/compose-viz/compose-viz/blob/main
### Options ### Options
| Option | Description | | Option | Description |
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `-o, --output-filename` | Output filename for the generated visualization file. [default: compose-viz] | | `-o, --output-filename FILENAME` | Output filename for the generated visualization file. [default: compose-viz] |
| `-m, --format` | Output format for the generated visualization file. See [supported formats](https://github.com/compose-viz/compose-viz/blob/main/compose_viz/models/viz_formats.py). [default: png] | | `-m, --format FORMAT` | Output format for the generated visualization file. See [supported formats](https://github.com/compose-viz/compose-viz/blob/main/compose_viz/models/viz_formats.py). [default: png] |
| `-r, --root-service` | Root of the service tree (convenient for large compose yamls) | | `-r, --root-service SERVICE_NAME` | Root of the service tree (convenient for large compose yamls) |
| `-v, --version` | Show the version of compose-viz. | | `-v, --version` | Show the version of compose-viz. |
| `--help` | Show help and exit. | | `--help` | Show help and exit. |