search

mermaid-js / mermaid-cli

Command line tool for the Mermaid library
MIT License
2.23k stars 210 forks source link

Missing description in `-h, --help` #659

Open hoijui opened 4 months ago

hoijui commented 4 months ago

As of now, one is left to wonder what this executable is:

$ mmdc --help
Usage: mmdc [options]

Options:
  -V, --version                                   output the version number
  -t, --theme [theme]                             Theme of the chart (choices: "default", "forest", "dark", "neutral", default: "default")
...

My shell shows a short description of the possible commands when TAB-completing, and for mmdc, it is not useful:

$ mmd[TAB]
...
mmdbresolve                (Read IPv4 and IPv6 addresses and print their IP geolocation information.)
mmdc                                                                                   (command link)
...