| 1 | ## `explain` command |
| 2 | |
| 3 | ``` |
| 4 | zigmod explain |
| 5 | ``` |
| 6 | |
| 7 | Use this command to create a visual description of your dependency graph. |
| 8 | |
| 9 | ## `--locked` |
| 10 | |
| 11 | Pass this to use the dependency versions from `zigmod.lock` instead of your current `.zigmod` folder. |
| 12 | |
| 13 | ## `--format` |
| 14 | |
| 15 | May be followed by one of the following values: |
| 16 | |
| 17 | - `tree` |
| 18 | - `mermaid` |
| 19 | - `dot` |
| 20 | |
| 21 | ## `--format tree` |
| 22 | |
| 23 | <img width="1077" height="866" alt="Image" src="https://github.com/user-attachments/assets/98d41e63-f5bd-4c7d-a5a3-272b9499d925" /> |
| 24 | |
| 25 | ## `--format mermaid` |
| 26 | |
| 27 | https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams |
| 28 | |
| 29 | <img width="1173" height="373" alt="Image" src="https://github.com/user-attachments/assets/0ad012b2-cfc9-4a7a-b3fa-9f5fefb969ab" /> |
| 30 | |
| 31 | ## `--format dot` |
| 32 | |
| 33 | This format prints output compatible with the `dot` program from https://graphviz.org/. |
| 34 | |
| 35 | Run `dot -Tpng <(zigmod explain --locked --format dot) -o explain.png` to generate the image. |
| 36 | |
| 37 | <img width="1781" height="443" alt="Image" src="https://github.com/user-attachments/assets/217c5855-537e-4a93-ba49-b5fe6f78cdd2" /> |